Re: [PATCH] Documentation/make/headers_install.txt

[Rob Landley <rob@landley.net>]

On Saturday 04 August 2007 3:05:25 pm Sam Ravnborg wrote:
> On Sat, Aug 04, 2007 at 02:07:18PM -0400, Rob Landley wrote:
> > From: Rob Landley <rob@landley.net>
> >
> > Signed-off-by: Rob Landley <rob@landley.net>
> >
> > Some documentation for "make headers_install".
> >
> > ---
> >
> > Earlier discussion was at http://lkml.org/lkml/2007/6/22/7 and I
> > believe I've responded to all of David's comments.
> >
> > --- /dev/null	2007-04-23 10:59:00.000000000 -0500
> > +++ linux-2.6/Documentation/make/headers_install.txt	2007-08-04
> > 13:04:51.000000000 -0500
>
> Any specific reason not to include this in Documentation/kbuild?
> I would prefer to have all kernel build stuff in one directory and
> we have Documentation/kbuild now.

That directory contains internal implementation details of the kernel 
makefiles, and is not about how to use them if you don't plan to modify them.  
This document is about how people can use one of the commands listed in "make 
help", and is not about modifying the make files.  It's a different category 
of documentation.  (Ideally, kbuild would go under make.)

That said, I don't really care where it goes, so if you prefer kbuild I can 
drop it there.  The organization of Documentation/ is fairly irrelevant to me 
at this point.

Like most documentation, this file needs to be linked to from more than one 
place: it needs to be brought to the attention of people building their own 
linux-from-scratch style systems (the "what's in a linux root filesystem" 
section of the index I'm building), it should be linked from a "building the 
kernel" page (what kinds of output can the build produce), there should be 
a "make help" page with hotlinks to the individual commands (like this and 
menuconfig) that have more extensive documentation, etc.

Trying to do that in Documentation would be a pain.  (Lots of symlinks with no 
explanatory text?  Lots of files called "index.txt" in each directory 
reinventing Gopher, pointing you at a directory other than the one you're in 
and hoping nothing ever moves?)

> 	Sam

Rob
-- 
"One of my most productive days was throwing away 1000 lines of code."
  - Ken Thompson.