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

PrevNext  Index
DateMon, 04 Jun 2012 17:14:41 +0100
From Harry van Haaren <[hidden] at gmail dot com>
ToPaul Davis <[hidden] at linuxaudiosystems dot com>
CcJACK <[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
Hi all,

I'm willing to contribute some time to this. I've pulled code a la Robin's
suggestion, and have "Meld" doing the dirty work: it compares similar files
and graphically shows the changes.

I've a little situation: what if the documentation is different for a
function?

Eg Jack1:
/* <b>THIS FUNCTION IS DEPRECATED AND SHOULD NOT BE USED IN
 *  NEW JACK CLIENTS</b>
*/

Jack2:
/* \bold THIS FUNCTION IS DEPRECATED AND SHOULD NOT BE USED IN
*  NEW JACK CLIENTS
*
* @deprecated Please use jack_client_open().
*/

I'm not very familiar with doxygen tags etc, but it seems nice to tag the
function as deprecated and point to _open?

Do we edit the JACK1 file, or how do we want to merge these?

Cheers, -Harry

On Mon, Jun 4, 2012 at 3:25 PM, Paul Davis <[hidden]>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 :)
>
> --p
>
>
> 
> Jack-Devel mailing list
> [hidden]
> http://lists.jackaudio.org/listinfo.cgi/jack-devel-jackaudio.org
>
>
PrevNext  Index

1338826490.23623_0.ltw:2,a <CAKudYbOHr5Y8BMTLN7247ry3ikEaq2Zzi69no4qWkRDM-hjY_g at mail dot gmail dot com>