lkml.org 
[lkml]   [2016]   [Jun]   [21]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v3 7/8] coccicheck: refer to coccicheck bottest wiki for documentation
On Tue, Jun 21, 2016 at 11:18:41PM +0200, Julia Lawall wrote:
>
>
> On Tue, 21 Jun 2016, Nicolas Palix (LIG) wrote:
>
> > Hi,
> >
> > Le 21/06/16 à 21:21, Luis R. Rodriguez a écrit :
> > > Sprinkling *tons* of documentation on the script is not a good
> > > idea, instead refer to a wiki for further coccicheck documentation:
> > >
> > > https://bottest.wiki.kernel.org/coccicheck
> > >
> > > This page shall always refer to the linux-next iteration of
> > > scripts/coccicheck.
> >
> > Can you say a word about Documentation/coccinelle.txt too ?
> > And update it according to the script changes.
>
> I think this would be a good idea.

I'd much prefer to just keep docs in a wiki, and we nuke this outdated doc or
refer in the Documentation/coccinelle.txt to the wiki. This lets us document
things much faster and lets us add more information in a much nicer format. But
that's just me...

The existing file Documentation/coccinelle.txt even provides documentation on
how to build coccinelle --we're way passed that point. Note, I havne't
updated the docs on the wiki to refer to any of this, and would not unless
these changes get merged at least to linux-next.

Luis

\
 
 \ /
  Last update: 2016-06-22 02:21    [W:0.097 / U:0.992 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site