Re: Documentation of kernel messages (Summary)

On Friday 03 August 2007 1:11:55 pm Randy Dunlap wrote:
On Mon, 16 Jul 2007 15:53:06 -0400 Rob Landley wrote:
On Sunday 15 July 2007 12:28:06 pm Randy Dunlap wrote:
On Sat, 14 Jul 2007 21:56:15 -0400 Rob Landley wrote:
On Friday 13 July 2007 11:54:41 pm Randy Dunlap wrote:
If there's interest, I can push some patches to clean up
Documentation by moving files into subdirectories, but
Documentation's not well-suited to link out to the web. (You
need html for that, and it's text.)

I think that you should start moving Documentation/ files around
and adding subdirectories -- if you are pretty sure of where they
should go (i.e., they won't likely be moved again later on).

You mean like these?
http://www.uwsg.iu.edu/hypermail/linux/kernel/0705.3/2925.html
http://www.uwsg.iu.edu/hypermail/linux/kernel/0705.3/2924.html

Yes. Have any of these been merged?

Not that I know of. They seemed to meet with resounding indifference, so
I went on to other things...

You need to be persistent. Please re-submit this.

Greg KH thinks it's a good idea to add language directories to the top level
of Documentation, and there are slightly more than two of those:
http://www.translatorscafe.com/cafe/Help.asp?HelpID=59

Since you think it's worth doing, I'll resubmit the work I've already done
here, but I no longer think trying to shovel Documentation into some
semblance of order against the will of people like Greg is a good use of
time.

These days I'm trying to create an html index that links into Documentation in
a coherent order (with categories and everything), and using automated tools
to detect files that aren't linked to, or links that point to a file that
isn't there anymore. This is obviously still a work in progress, but I think
it's a better approach.

and since it's just file & dir moves and done via git, it should go to
Linus. However, he may not want it right now since the primary
merge window for 2.6.23 has closed (although he has been merging
some other doc updates recently).

If moving text files from one location to another in the Documentation
directory breaks the build or causes bugs in the kernel, we have bigger
problems. :)

Rob
--
"One of my most productive days was throwing away 1000 lines of code."
- Ken Thompson.
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

Relevant Pages

  • Re: Replay codec sources
    ... is outright better than Moving Lines. ... I figured as much -- pretty much all the Acorn documentation says that. ... Moving Blocks is sooooo much better!" ... implement a decoder for it but it seems ...
    (comp.sys.acorn.programmer)
  • Re: w/good help or doc
    ... Soon I will be moving to a new comptuer, ... besides the general help about the functionality of the newsreaders ...
    (news.software.readers)
  • Re: [patch] block: Minor comment fix
    ... On Wed, Sep 03 2008, Geoff Levand wrote: ... Moving the documentation to blk_cleanup_queuewould be the ... Please read the FAQ at http://www.tux.org/lkml/ ...
    (Linux-Kernel)
  • Importing Entourage 2004 from one computer to another
    ... MS seems brain dead about this in their documentation. ... Moving from one computer to another. ... Both on LAN. ...
    (microsoft.public.mac.office.entourage)
  • Re: Documentation of kernel messages (Summary)
    ... Documentation by moving files into subdirectories, ... and adding subdirectories -- if you are pretty sure of where they ... Greg KH thinks it's a good idea to add language directories to the top level ... of Documentation, and there are slightly more than two of those: ...
    (Linux-Kernel)