Re: [PATCH] Minor fix to Documentation/powerpc/00-INDEX

["Jesper Juhl" <jesper.juhl@gmail.com>]

On 12/08/07, Rob Landley <rob@landley.net> wrote:
> On Saturday 11 August 2007 4:33:34 pm Randy Dunlap wrote:
> > On Thu, 9 Aug 2007 23:42:35 -0500 Rob Landley wrote:
> > > Signed-off-by: Rob Landley <rob@landley.net>
> > >
> > > I have a python script to convert 00-INDEX files into index.html files,
> > > and a second script to show 404 errors in the result as well as
> > > files/directories nothing links to.   (It's not very useful yet, but in
> > > case you're wondering http://kernel.org/doc/docdiridx.py and
> > > http://kernel.org/doc/doclinkcheck.py .)
> > >
> > > Anyway, my simple index.html generator breaks on the
> > > Documentation/powerpc directory because one of the description lines is
> > > two lines long.  This patch joins those two lines together into one line.
> > >  This is the only instance (so far) of this problem.
> >
> > If Paul wants to merge this, then OK, but I'm not aware of any rule
> > that the file descriptions inside INDEX files must be only one line
> > long... is that documented somewhere?  (if so, where?)
>
> Documentation/00-INDEX line 5:
>
> > Please try and keep the descriptions small enough to fit on one line.
>
> There was only one instance of it not being the case.  I can use indentation
> level instead (which is what Kconfig uses to identify help text, so I'm not
> leaking pythonisms into the kernel that aren't already there), but the one
> line thing seemed to be an existing standard.
>
The two times that I've done some big updates to
Documentation/00-INDEX I've also stuck to one line for each
description since that was the only form I'd ever seen - I didn't know
if it was a rule or not, but it seemed pretty sensible for an index.
It's also the form I've stuck to for the new files I send patches for recently.

So for whatever my oppinion is worth; I think we may as well make it a
rule for the 00-INDEX files.


-- 
Jesper Juhl <jesper.juhl@gmail.com>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html