[KJ] another potential KJ project -- cleaning out Documentation/

[KJ] another potential KJ project -- cleaning out Documentation/

[Robert P. J. Day]

  not sure if this is a viable project, but it strikes me that there's
a *heap* of stuff in the current 2.6 Documentation/ directory that
could be either reorganized, updated or outright deleted.  and, in
this case, deletion of outdated content *would* have its value since
out-of-date documentation can be annoyingly misleading and a real time
waster.

  in terms of reorganization, i think it would be nice to see more of
a hierarchical structure.  for example, i can imagine a single
"debugging" directory with all debugging-related text files.

  perhaps another one called "developers" which would contain
everything related to submitting patches and drivers, and the
submission checklist, etc, etc.  you get the idea.

  and in terms of outright deletion, not to pick on any one
architecture but just grabbing something at random, there's a "cris"
directory with a single README file for its contents, that begins:

Linux 2.4 on the CRIS architecture
=================
$Id: README,v 1.7 2001/04/19 12:38:32 bjornw Exp $
...

if this really is 2.4-specific content, its value in the 2.6.20 kernel
tree is fairly low, if not non-existent.

  anyway, thoughts?  there's a lot of valuable info in the
Documentation/ directory, but it seems to be getting increasingly
buried under aging and obsolete content.

rday

-- 
====================================
Robert P. J. Day
Linux Consulting, Training and Annoying Kernel Pedantry
Waterloo, Ontario, CANADA

http://www.fsdev.dreamhosters.com/wiki/index.php?title=Main_Page
====================================
_______________________________________________
Kernel-janitors mailing list
Kernel-janitors@lists.osdl.org
https://lists.osdl.org/mailman/listinfo/kernel-janitors

Re: [KJ] another potential KJ project -- cleaning out Documentation/

[walter harms]

Robert P. J. Day wrote:
>   not sure if this is a viable project, but it strikes me that there's
> a *heap* of stuff in the current 2.6 Documentation/ directory that
> could be either reorganized, updated or outright deleted.  and, in
> this case, deletion of outdated content *would* have its value since
> out-of-date documentation can be annoyingly misleading and a real time
> waster.
> 
>   in terms of reorganization, i think it would be nice to see more of
> a hierarchical structure.  for example, i can imagine a single
> "debugging" directory with all debugging-related text files.
> 
>   perhaps another one called "developers" which would contain
> everything related to submitting patches and drivers, and the
> submission checklist, etc, etc.  you get the idea.
> 
>   and in terms of outright deletion, not to pick on any one
> architecture but just grabbing something at random, there's a "cris"
> directory with a single README file for its contents, that begins:
> 
> Linux 2.4 on the CRIS architecture
> =================
> $Id: README,v 1.7 2001/04/19 12:38:32 bjornw Exp $
> ...
> 
> if this really is 2.4-specific content, its value in the 2.6.20 kernel
> tree is fairly low, if not non-existent.
> 
>   anyway, thoughts?  there's a lot of valuable info in the
> Documentation/ directory, but it seems to be getting increasingly
> buried under aging and obsolete content.
> 
> rday
> 

This CRIS processor is supported also with the 2.6 architecture.

re,
 wh


_______________________________________________
Kernel-janitors mailing list
Kernel-janitors@lists.osdl.org
https://lists.osdl.org/mailman/listinfo/kernel-janitors

Re: [KJ] another potential KJ project -- cleaning out Documentation/

[Robert P. J. Day]

On Sun, 4 Feb 2007, walter harms wrote:

> Robert P. J. Day wrote:
> >   not sure if this is a viable project, but it strikes me that there's
... snip ...
> > Linux 2.4 on the CRIS architecture
> > =================
> > $Id: README,v 1.7 2001/04/19 12:38:32 bjornw Exp $
> > ...
> >
> > if this really is 2.4-specific content, its value in the 2.6.20 kernel
> > tree is fairly low, if not non-existent.
> >
> >   anyway, thoughts?  there's a lot of valuable info in the
> > Documentation/ directory, but it seems to be getting increasingly
> > buried under aging and obsolete content.
> >
> > rday
> >
>
> This CRIS processor is supported also with the 2.6 architecture.

oh, i realize that.  but note that that content is titled "Linux 2.4
                                                                 ^^^
on the CRIS architecture".  so either that content is still valid for
2.6 and its title should be updated, or the content is not relevant to
2.6 and it should be dropped from the tree.

no matter what the situation is, any documentation that is *solely*
for the 2.4 kernel really has no place in the 2.6 documentation
directory.

rday

p.s.  one non-intrusive possibility is to create a directory named
"OLD" in the Doc directory, and move apparently outdated content
there.  that gets it out of the way, but it's easily fetchable by
anyone who still wants it.

-- 

====================================
Robert P. J. Day
Linux Consulting, Training and Annoying Kernel Pedantry
Waterloo, Ontario, CANADA

http://www.fsdev.dreamhosters.com/wiki/index.php?title=Main_Page
====================================
_______________________________________________
Kernel-janitors mailing list
Kernel-janitors@lists.osdl.org
https://lists.osdl.org/mailman/listinfo/kernel-janitors