Re: [Jack-Devel] how you can love JACK back

PrevNext  Index
DateMon, 04 Jun 2012 16:49:33 +0200
From Robin Gareus <[hidden] at gareus dot org>
ToPaul Davis <[hidden] at linuxaudiosystems dot com>
CcJACK Mailing List <[hidden] at lists dot jackaudio dot org>
In-Reply-ToPaul Davis [Jack-Devel] how you can love JACK back
Follow-UpPaul Davis Re: [Jack-Devel] how you can love JACK back
Follow-UpNedko Arnaudov Re: [Jack-Devel] how you can love JACK back
On 06/04/2012 04:25 PM, Paul Davis wrote:
> its fairly clear that neither myself nor stephane are going to find the
> time on any foreseeable timeline to do the complete review+merge of the
> JACK headers that has been proposed to ease *some* of the issues
> surrounding future JACK development.
> 
> however, that doesn't mean that it can't happen. i know that i can review
> material far faster if its in the "right" format. my guess that the same is
> true for stephane as well.
> 
> so here is a proposal/request for help from the JACK community to ensure
> that this gets done. you don't need to be a coder (though you do need to be
> able to read code).
> 
> what we need is a breakout of all the functions defined in the header files
> that get installed by jack1 and jack2. the result should be, preferably, a
> side-by-side (literally) juxtaposition of the comments/docs for each
> function, and the declaration of the function. This is mostly a text
> editing task, in fact, with a need for good presentation. The result should
> be something that is easy to go through and review the differences. In a
> few cases, there will be a function that exists in only one version.
> 
> remember: you don't need to be any kind of uber-coder, or even a coder at
> all, to help with this incredibly valuable task. you just need to be able
> read header files, find stuff in two parallel (and different) trees of
> header files, and collate what you find into some format that we can easily
> review.
> 
> please step up :)

just to be clear:

You're asking for an annotated side-by-side diff between:

https://github.com/jackaudio/headers
https://github.com/jackaudio/jack2/tree/master/common/jack

is that correct?

I suppose you can use github to create that. github will also allow to
comment on the diff.

Here's a proposal that should be fairly quick to implement:

 1) clone/import
    https://github.com/jackaudio/jack2/tree/master/common/jack
   as a branch to https://github.com/jackaudio/headers

 2) NOOP-edit that branch: re-order fn, add/remove whitespace to make
   jack2 headers as similar as possible to unmodified jackaudio/headers

 3) use github create the side-by-side diff

 4) comment on the github diff.

thoughts?
robin
PrevNext  Index

1338821393.20149_0.ltw:2,a <4FCCCAFD.8040806 at gareus dot org>