Update to http://kernel.org/doc

Update to http://kernel.org/doc

[Rob Landley]

Now that I'm actually doing kernel development as my day job (containers
stuff for Parallels), I've taken some time to brush up the old kernel
documentation directory on kernel.org that I theoretically maintain.

It now includes:

1) Web versions of all the documentation I could find in the kernel
source tarball, put on the web where Google can find it.  (You can now
link to the help text for menuconfig symbol, or refer to the output of
"make htmldocs" via URL instead of telling people to build it themselves.)

2) Links to a bunch of standards documents applicable to the kernel.

3) Links to a bunch of other web pages containing kernel documentation
(including broken-up copies of all the OLS papers dating back to 2001).

4) Other stuff.

I'm not saying it's complete.  I'm just saying I exhumed it, gave it a
good scrub, applied the interocitor to the bolts on its' neck, and sent
it lurching towards the village...

Opinions?

Rob

P.S.  Yes I know I still need to index the 2010 Ottawa Linux Symposium
papers.  I got 2009 properly indexed, though.

Re: Update to http://kernel.org/doc

[Randy Dunlap]

On Sat, 19 Feb 2011 22:17:39 -0600 Rob Landley wrote:

> Now that I'm actually doing kernel development as my day job (containers
> stuff for Parallels), I've taken some time to brush up the old kernel
> documentation directory on kernel.org that I theoretically maintain.
> 
> It now includes:
> 
> 1) Web versions of all the documentation I could find in the kernel
> source tarball, put on the web where Google can find it.  (You can now
> link to the help text for menuconfig symbol, or refer to the output of
> "make htmldocs" via URL instead of telling people to build it themselves.)
> 
> 2) Links to a bunch of standards documents applicable to the kernel.
> 
> 3) Links to a bunch of other web pages containing kernel documentation
> (including broken-up copies of all the OLS papers dating back to 2001).
> 
> 4) Other stuff.
> 
> I'm not saying it's complete.  I'm just saying I exhumed it, gave it a
> good scrub, applied the interocitor to the bolts on its' neck, and sent
> it lurching towards the village...
> 
> Opinions?

Yes, this is useful.
Thanks.


> Rob
> 
> P.S.  Yes I know I still need to index the 2010 Ottawa Linux Symposium
> papers.  I got 2009 properly indexed, though.


---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

Re: Update to http://kernel.org/doc

[Mariusz Kozlowski]

On Sat, Feb 19, 2011 at 10:17:39PM -0600, Rob Landley wrote:
> Now that I'm actually doing kernel development as my day job (containers
> stuff for Parallels), I've taken some time to brush up the old kernel
> documentation directory on kernel.org that I theoretically maintain.
> 
> It now includes:
> 
> 1) Web versions of all the documentation I could find in the kernel
> source tarball, put on the web where Google can find it.  (You can now
> link to the help text for menuconfig symbol, or refer to the output of
> "make htmldocs" via URL instead of telling people to build it themselves.)
> 
> 2) Links to a bunch of standards documents applicable to the kernel.
> 
> 3) Links to a bunch of other web pages containing kernel documentation
> (including broken-up copies of all the OLS papers dating back to 2001).
> 
> 4) Other stuff.
> 
> I'm not saying it's complete.  I'm just saying I exhumed it, gave it a
> good scrub, applied the interocitor to the bolts on its' neck, and sent
> it lurching towards the village...
> 
> Opinions?

Very useful if updated. I can now remove some portion of my kernel related
bookmarks.

Thanks,

-- 
Mariusz Kozlowski

Re: Update to http://kernel.org/doc

[Rob Landley]

On 02/21/2011 12:52 PM, Mariusz Kozlowski wrote:
>> I'm not saying it's complete.  I'm just saying I exhumed it, gave it a
>> good scrub, applied the interocitor to the bolts on its' neck, and sent
>> it lurching towards the village...
>>
>> Opinions?
> 
> Very useful if updated. I can now remove some portion of my kernel related
> bookmarks.

Thanks.  I can set up a cron job, but in reality it looks prettier than
it actually is.

Part of the problem is that "make htmldocs" doesn't reliably build
between about -rc1 and -rc4 or so.  It's usually not part of anybody's
regression testing, and when it DOES fail the output is usually crazy
stuff like:

xmlto: /home/landley/linux/linux/Documentation/DocBook/80211.xml does
not validate (status 3)
xmlto: Fix document syntax or use --skip-validation option
/home/landley/linux/linux/Documentation/DocBook/80211.xml:13074: element
chapter: validity error : Element chapter content does not follow the
DTD, expecting (chapterinfo? , (title , subtitle? , titleabbrev?) , (toc
| lot | index | glossary | bibliography)* , tocchap? , (((calloutlist |
glosslist | itemizedlist | orderedlist | segmentedlist | simplelist |
variablelist | caution | important | note | tip | warning |
literallayout | programlisting | programlistingco | screen | screenco |
screenshot | synopsis | cmdsynopsis | funcsynopsis | classsynopsis |
fieldsynopsis | constructorsynopsis | destructorsynopsis |
methodsynopsis | formalpara | para | simpara | address | blockquote |
graphic | graphicco | mediaobject | mediaobjectco | informalequation |
informalexample | informalfigure | informaltable | equation | example |
figure | table | msgset | procedure | sidebar | qandaset | anchor |
bridgehead | remark | highlights | abstract | authorblurb | epigraph |
indexterm | beginpage)+ , (sect1* | refentry* | simplesect* | section*))
| sect1+ | refentry+ | simplesect+ | section+) , (toc | lot | index |
glossary | bibliography)*), got (title sect1 sect1 refentry )
Document /home/landley/linux/linux/Documentation/DocBook/80211.xml does
not validate

Which means what, exactly?  (That particular example was from last week,
it's been fixed since upstream.  I added --skip-validation to my xmlto
invocation because more stuff built.  There are still two blank entries
in http://kernel.org/doc/htmldocs/ are because their builds broke.  I
should pull and run it again and see if those build now...)

Oh, another fun thing is that my Documentation index is created from the
00-INDEX files when those exist, and there's usually version skew
between that file and the directory contents.

I have a http://kernel.org/doc/make/doclinkcheck.py which finds the
files it lists which don't exist and the files which exist but aren't
listed.  The current list of files 00-INDEX says exist, but aren't at
that location, is:

404 errors:
Documentation/time_interpolators.txt
Documentation/voyager.txt
Documentation/powerpc/booting-without-of.txt
Documentation/powerpc/mpc52xx-device-tree-bindings.txt
Documentation/arm/msm
Documentation/arm/Samsung-S3C24XX
Documentation/arm/Sharp-LH
Documentation/arm/SPEAr
Documentation/arm/empeg/
Documentation/PCI/PCI-DMA-mapping.txt
Documentation/networking/dgrs.txt
Documentation/networking/ethertap.txt
Documentation/networking/wavelan.txt
Documentation/w1/masters/mxc_w1
Documentation/vm/slabinfo.c
Documentation/serial/hayes-esp.txt
Documentation/filesystems/dentry-locking.txt
Documentation/filesystems/reiser4.txt
Documentation/s390/zfcpdump

The list of files which exist but aren't in a 00-INDEX is crazy long so
I won't post it here.  (I can if you're interested...)

I'll probably get around to chipping away at some of that, but first I
need to do a proper 2010 OLS paper index.  (And that's just a
chronological index.  A _topic_ index is a huge undertaking.  I did a
quick search for the NFS guys last night and came up with 7 papers, and
I haven't even checked 2010 yet.  I'm only even considering an OLS paper
topic index because I'd only have to _update_ it once a year, so the
work involved is at least finite...)

Rob

Re: Update to http://kernel.org/doc

[Randy Dunlap]

On Mon, 21 Feb 2011 13:59:59 -0600 Rob Landley wrote:

> On 02/21/2011 12:52 PM, Mariusz Kozlowski wrote:
> >> I'm not saying it's complete.  I'm just saying I exhumed it, gave it a
> >> good scrub, applied the interocitor to the bolts on its' neck, and sent
> >> it lurching towards the village...
> >>
> >> Opinions?
> > 
> > Very useful if updated. I can now remove some portion of my kernel related
> > bookmarks.
> 
> Thanks.  I can set up a cron job, but in reality it looks prettier than
> it actually is.
> 
> Part of the problem is that "make htmldocs" doesn't reliably build
> between about -rc1 and -rc4 or so.  It's usually not part of anybody's
> regression testing, and when it DOES fail the output is usually crazy
> stuff like:
> 
> xmlto: /home/landley/linux/linux/Documentation/DocBook/80211.xml does
> not validate (status 3)
> xmlto: Fix document syntax or use --skip-validation option
> /home/landley/linux/linux/Documentation/DocBook/80211.xml:13074: element
> chapter: validity error : Element chapter content does not follow the
> DTD, expecting (chapterinfo? , (title , subtitle? , titleabbrev?) , (toc
> | lot | index | glossary | bibliography)* , tocchap? , (((calloutlist |
> glosslist | itemizedlist | orderedlist | segmentedlist | simplelist |
> variablelist | caution | important | note | tip | warning |
> literallayout | programlisting | programlistingco | screen | screenco |
> screenshot | synopsis | cmdsynopsis | funcsynopsis | classsynopsis |
> fieldsynopsis | constructorsynopsis | destructorsynopsis |
> methodsynopsis | formalpara | para | simpara | address | blockquote |
> graphic | graphicco | mediaobject | mediaobjectco | informalequation |
> informalexample | informalfigure | informaltable | equation | example |
> figure | table | msgset | procedure | sidebar | qandaset | anchor |
> bridgehead | remark | highlights | abstract | authorblurb | epigraph |
> indexterm | beginpage)+ , (sect1* | refentry* | simplesect* | section*))
> | sect1+ | refentry+ | simplesect+ | section+) , (toc | lot | index |
> glossary | bibliography)*), got (title sect1 sect1 refentry )
> Document /home/landley/linux/linux/Documentation/DocBook/80211.xml does
> not validate
> 
> Which means what, exactly?  (That particular example was from last week,
> it's been fixed since upstream.  I added --skip-validation to my xmlto
> invocation because more stuff built.  There are still two blank entries
> in http://kernel.org/doc/htmldocs/ are because their builds broke.  I
> should pull and run it again and see if those build now...)
> 
> Oh, another fun thing is that my Documentation index is created from the
> 00-INDEX files when those exist, and there's usually version skew
> between that file and the directory contents.
> 
> I have a http://kernel.org/doc/make/doclinkcheck.py which finds the
> files it lists which don't exist and the files which exist but aren't
> listed.  The current list of files 00-INDEX says exist, but aren't at
> that location, is:

I'll fix some of these (or accept patches to do so).
Thanks.

> 404 errors:
> Documentation/time_interpolators.txt
> Documentation/voyager.txt
> Documentation/powerpc/booting-without-of.txt
> Documentation/powerpc/mpc52xx-device-tree-bindings.txt
> Documentation/arm/msm
> Documentation/arm/Samsung-S3C24XX
> Documentation/arm/Sharp-LH
> Documentation/arm/SPEAr
> Documentation/arm/empeg/
> Documentation/PCI/PCI-DMA-mapping.txt
> Documentation/networking/dgrs.txt
> Documentation/networking/ethertap.txt
> Documentation/networking/wavelan.txt
> Documentation/w1/masters/mxc_w1
> Documentation/vm/slabinfo.c
> Documentation/serial/hayes-esp.txt
> Documentation/filesystems/dentry-locking.txt
> Documentation/filesystems/reiser4.txt
> Documentation/s390/zfcpdump
> 
> The list of files which exist but aren't in a 00-INDEX is crazy long so
> I won't post it here.  (I can if you're interested...)
> 
> I'll probably get around to chipping away at some of that, but first I
> need to do a proper 2010 OLS paper index.  (And that's just a
> chronological index.  A _topic_ index is a huge undertaking.  I did a
> quick search for the NFS guys last night and came up with 7 papers, and
> I haven't even checked 2010 yet.  I'm only even considering an OLS paper
> topic index because I'd only have to _update_ it once a year, so the
> work involved is at least finite...)


---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

[PATCH] Remove obsolete Documentation/00-INDEX entries

[Rob Landley]

On 02/21/2011 02:03 PM, Randy Dunlap wrote:
>> I have a http://kernel.org/doc/make/doclinkcheck.py which finds the
>> files it lists which don't exist and the files which exist but aren't
>> listed.  The current list of files 00-INDEX says exist, but aren't at
>> that location, is:
> 
> I'll fix some of these (or accept patches to do so).
> Thanks.

Let's see...

From: Rob Landley <rlandley@parallels.com>

Time interpolators were removed in git 1f564ad6d41828
Voyager support went away in git b6b6e2b112caf

Signed-off-by: Rob Landley <rlandley@parallels.com>
---

 Documentation/00-INDEX |    4 ----
 1 file changed, 4 deletions(-)

diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
index 8dfc670..f607367 100644
--- a/Documentation/00-INDEX
+++ b/Documentation/00-INDEX
@@ -328,8 +328,6 @@ sysrq.txt
 	- info on the magic SysRq key.
 telephony/
 	- directory with info on telephony (e.g. voice over IP) support.
-time_interpolators.txt
-	- info on time interpolators.
 uml/
 	- directory with information about User Mode Linux.
 unicode.txt
@@ -346,8 +344,6 @@ vm/
 	- directory with info on the Linux vm code.
 volatile-considered-harmful.txt
 	- Why the "volatile" type class should not be used
-voyager.txt
-	- guide to running Linux on the Voyager architecture.
 w1/
 	- directory with documents regarding the 1-wire (w1) subsystem.
 watchdog/

Re: [PATCH] Remove obsolete Documentation/00-INDEX entries

[Randy Dunlap]

On Mon, 21 Feb 2011 14:34:51 -0600 Rob Landley wrote:

> On 02/21/2011 02:03 PM, Randy Dunlap wrote:
> >> I have a http://kernel.org/doc/make/doclinkcheck.py which finds the
> >> files it lists which don't exist and the files which exist but aren't
> >> listed.  The current list of files 00-INDEX says exist, but aren't at
> >> that location, is:
> > 
> > I'll fix some of these (or accept patches to do so).
> > Thanks.
> 
> Let's see...
> 
> From: Rob Landley <rlandley@parallels.com>
> 
> Time interpolators were removed in git 1f564ad6d41828
> Voyager support went away in git b6b6e2b112caf
> 
> Signed-off-by: Rob Landley <rlandley@parallels.com>
> ---

Thanks, added to my patch queue.

> 
>  Documentation/00-INDEX |    4 ----
>  1 file changed, 4 deletions(-)
> 
> diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
> index 8dfc670..f607367 100644
> --- a/Documentation/00-INDEX
> +++ b/Documentation/00-INDEX
> @@ -328,8 +328,6 @@ sysrq.txt
>  	- info on the magic SysRq key.
>  telephony/
>  	- directory with info on telephony (e.g. voice over IP) support.
> -time_interpolators.txt
> -	- info on time interpolators.
>  uml/
>  	- directory with information about User Mode Linux.
>  unicode.txt
> @@ -346,8 +344,6 @@ vm/
>  	- directory with info on the Linux vm code.
>  volatile-considered-harmful.txt
>  	- Why the "volatile" type class should not be used
> -voyager.txt
> -	- guide to running Linux on the Voyager architecture.
>  w1/
>  	- directory with documents regarding the 1-wire (w1) subsystem.
>  watchdog/


---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

[PATCH] Remove obsolete Documentation/powerpc/00-INDEX entries

[Rob Landley]

From: Rob Landley <rlandley@parallels.com>

The device tree infrastructure is being genericized so its documentation
moved out of the PowerPC directory.

Signed-off-by: Rob Landley <rlandley@parallels.com>
---

 Documentation/devicetree/00-INDEX |    8 ++++++++
 Documentation/powerpc/00-INDEX    |    4 ----
 2 files changed, 8 insertions(+), 4 deletions(-)

--- /dev/null	2011-02-13 16:59:19.073990002 -0600
+++ b/Documentation/devicetree/00-INDEX	2011-02-21 14:47:12.911544002 -0600
@@ -0,0 +1,8 @@
+Documentation for device trees, a data structure by which bootloaders pass
+hardware layout to Linux in a device-independent manner, simplifying hardware
+probing.  This subsystem is maintained by Grant Likely
+<grant.likely@secretlab.ca> and has a mailing list at
+https://lists.ozlabs.org/listinfo/devicetree-discuss
+
+booting-without-of.txt
+        - Booting Linux without Open Firmware, describes history and format of device trees.
diff --git a/Documentation/powerpc/00-INDEX b/Documentation/powerpc/00-INDEX
index e3960b8..5620fb5 100644
--- a/Documentation/powerpc/00-INDEX
+++ b/Documentation/powerpc/00-INDEX
@@ -5,8 +5,6 @@ please mail me.
 
 00-INDEX
 	- this file
-booting-without-of.txt
-	- Booting the Linux/ppc kernel without Open Firmware
 cpu_features.txt
 	- info on how we support a variety of CPUs with minimal compile-time
 	options.
@@ -16,8 +14,6 @@ hvcs.txt
 	- IBM "Hypervisor Virtual Console Server" Installation Guide
 mpc52xx.txt
 	- Linux 2.6.x on MPC52xx family
-mpc52xx-device-tree-bindings.txt
-	- MPC5200 Device Tree Bindings
 sound.txt
 	- info on sound support under Linux/PPC
 zImage_layout.txt

Re: [PATCH] Remove obsolete Documentation/powerpc/00-INDEX entries

[Randy Dunlap]

On Mon, 21 Feb 2011 15:34:09 -0600 Rob Landley wrote:

> From: Rob Landley <rlandley@parallels.com>
> 
> The device tree infrastructure is being genericized so its documentation
> moved out of the PowerPC directory.
> 
> Signed-off-by: Rob Landley <rlandley@parallels.com>

Added to my patch queue.  Thanks.

> ---
> 
>  Documentation/devicetree/00-INDEX |    8 ++++++++
>  Documentation/powerpc/00-INDEX    |    4 ----
>  2 files changed, 8 insertions(+), 4 deletions(-)
> 
> --- /dev/null	2011-02-13 16:59:19.073990002 -0600
> +++ b/Documentation/devicetree/00-INDEX	2011-02-21 14:47:12.911544002 -0600
> @@ -0,0 +1,8 @@
> +Documentation for device trees, a data structure by which bootloaders pass
> +hardware layout to Linux in a device-independent manner, simplifying hardware
> +probing.  This subsystem is maintained by Grant Likely
> +<grant.likely@secretlab.ca> and has a mailing list at
> +https://lists.ozlabs.org/listinfo/devicetree-discuss
> +
> +booting-without-of.txt
> +        - Booting Linux without Open Firmware, describes history and format of device trees.
> diff --git a/Documentation/powerpc/00-INDEX b/Documentation/powerpc/00-INDEX
> index e3960b8..5620fb5 100644
> --- a/Documentation/powerpc/00-INDEX
> +++ b/Documentation/powerpc/00-INDEX
> @@ -5,8 +5,6 @@ please mail me.
>  
>  00-INDEX
>  	- this file
> -booting-without-of.txt
> -	- Booting the Linux/ppc kernel without Open Firmware
>  cpu_features.txt
>  	- info on how we support a variety of CPUs with minimal compile-time
>  	options.
> @@ -16,8 +14,6 @@ hvcs.txt
>  	- IBM "Hypervisor Virtual Console Server" Installation Guide
>  mpc52xx.txt
>  	- Linux 2.6.x on MPC52xx family
> -mpc52xx-device-tree-bindings.txt
> -	- MPC5200 Device Tree Bindings
>  sound.txt
>  	- info on sound support under Linux/PPC
>  zImage_layout.txt


---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

Re: [PATCH] Remove obsolete Documentation/00-INDEX entries

[Jovi Zhang]

On Tue, Feb 22, 2011 at 4:55 AM, Randy Dunlap <rdunlap@xenotime.net> wrote:
> On Mon, 21 Feb 2011 14:34:51 -0600 Rob Landley wrote:
>
>> On 02/21/2011 02:03 PM, Randy Dunlap wrote:
>> >> I have a http://kernel.org/doc/make/doclinkcheck.py which finds the
>> >> files it lists which don't exist and the files which exist but aren't
>> >> listed.  The current list of files 00-INDEX says exist, but aren't at
>> >> that location, is:
>> >
>> > I'll fix some of these (or accept patches to do so).
>> > Thanks.
>>
>> Let's see...
>>
>> From: Rob Landley <rlandley@parallels.com>
>>
>> Time interpolators were removed in git 1f564ad6d41828
>> Voyager support went away in git b6b6e2b112caf
>>
>> Signed-off-by: Rob Landley <rlandley@parallels.com>
>> ---
>
> Thanks, added to my patch queue.
>
>>
>>  Documentation/00-INDEX |    4 ----
>>  1 file changed, 4 deletions(-)
>>
>> diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
>> index 8dfc670..f607367 100644
>> --- a/Documentation/00-INDEX
>> +++ b/Documentation/00-INDEX
>> @@ -328,8 +328,6 @@ sysrq.txt
>>       - info on the magic SysRq key.
>>  telephony/
>>       - directory with info on telephony (e.g. voice over IP) support.
>> -time_interpolators.txt
>> -     - info on time interpolators.
>>  uml/
>>       - directory with information about User Mode Linux.
>>  unicode.txt
>> @@ -346,8 +344,6 @@ vm/
>>       - directory with info on the Linux vm code.
>>  volatile-considered-harmful.txt
>>       - Why the "volatile" type class should not be used
>> -voyager.txt
>> -     - guide to running Linux on the Voyager architecture.
>>  w1/
>>       - directory with documents regarding the 1-wire (w1) subsystem.
>>  watchdog/
>
>
> ---
> ~Randy
> *** Remember to use Documentation/SubmitChecklist when testing your code ***
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at  http://www.tux.org/lkml/
>

There also have many doc located in Documentation directory, but not
in 00-INDEX file, like
apparmor.txt
bad_memory.txt
braille-console.txt
bt8xxgpio.txt
circular-buffers.txt
coccinelle.txt
credentials.txt
debugging-via-ohci1394.txt
devicetree/
dmaengine.txt
dynamic-debug-howto.txt
email-clients.txt
flexible-arrays.txt
futex-requeue-pi.txt
gcov.txt
...

Also there have some entry not list as alphabetical order.

Re: Update to http://kernel.org/doc

[Américo Wang]

On Sat, Feb 19, 2011 at 10:17:39PM -0600, Rob Landley wrote:
>Now that I'm actually doing kernel development as my day job (containers
>stuff for Parallels), I've taken some time to brush up the old kernel
>documentation directory on kernel.org that I theoretically maintain.
>
>It now includes:
>
...
>3) Links to a bunch of other web pages containing kernel documentation
>(including broken-up copies of all the OLS papers dating back to 2001).

This is pretty cool!

Thanks for your work!

Re: [PATCH] Remove obsolete Documentation/00-INDEX entries

[Rob Landley]

[-- Attachment #1: Type: text/plain, Size: 795 bytes --]

On 02/21/2011 11:43 PM, Jovi Zhang wrote:
> There also have many doc located in Documentation directory, but not
> in 00-INDEX file, like
> apparmor.txt
> bad_memory.txt
> braille-console.txt
> bt8xxgpio.txt
> circular-buffers.txt
> coccinelle.txt
> credentials.txt
> debugging-via-ohci1394.txt
> devicetree/
> dmaengine.txt
> dynamic-debug-howto.txt
> email-clients.txt
> flexible-arrays.txt
> futex-requeue-pi.txt
> gcov.txt
> ...
> 
> Also there have some entry not list as alphabetical order.

My script lists those as well: it finds a little over 1100 of them,
which is why I didn't post the list.  (Here it is gzipped and attached.)
 But that's also listing files for directories that have no 00-INDEX, so
I should probably filter that better...

Is alphabetical order a requirement?

Rob

[-- Attachment #2: blah.txt.gz --]
[-- Type: application/x-gzip, Size: 8499 bytes --]

Re: [PATCH] Remove obsolete Documentation/00-INDEX entries

[Jovi Zhang]

On Tue, Feb 22, 2011 at 2:59 PM, Rob Landley <rlandley@parallels.com> wrote:
> On 02/21/2011 11:43 PM, Jovi Zhang wrote:
>> There also have many doc located in Documentation directory, but not
>> in 00-INDEX file, like
>> apparmor.txt
>> bad_memory.txt
>> braille-console.txt
>> bt8xxgpio.txt
>> circular-buffers.txt
>> coccinelle.txt
>> credentials.txt
>> debugging-via-ohci1394.txt
>> devicetree/
>> dmaengine.txt
>> dynamic-debug-howto.txt
>> email-clients.txt
>> flexible-arrays.txt
>> futex-requeue-pi.txt
>> gcov.txt
>> ...
>>
>> Also there have some entry not list as alphabetical order.
>
> My script lists those as well: it finds a little over 1100 of them,
> which is why I didn't post the list.  (Here it is gzipped and attached.)
>  But that's also listing files for directories that have no 00-INDEX, so
> I should probably filter that better...
>
> Is alphabetical order a requirement?
>
> Rob
>

Hmm, not sure..., The header of 00-INDEX is like this:
>>>>
This is a brief list of all the files in ./linux/Documentation and what
they contain. If you add a documentation file, please list it here in
alphabetical order as well, or risk being hunted down like a rabid dog.
Please try and keep the descriptions small enough to fit on one line.
                                                        Thanks -- Paul G.
<<<

Re: [PATCH] Remove obsolete Documentation/00-INDEX entries

[Randy Dunlap]

On Tue, 22 Feb 2011 15:34:46 +0800 Jovi Zhang wrote:

> On Tue, Feb 22, 2011 at 2:59 PM, Rob Landley <rlandley@parallels.com> wrote:
> > On 02/21/2011 11:43 PM, Jovi Zhang wrote:
> >> There also have many doc located in Documentation directory, but not
> >> in 00-INDEX file, like
> >> apparmor.txt
> >> bad_memory.txt
> >> braille-console.txt
> >> bt8xxgpio.txt
> >> circular-buffers.txt
> >> coccinelle.txt
> >> credentials.txt
> >> debugging-via-ohci1394.txt
> >> devicetree/
> >> dmaengine.txt
> >> dynamic-debug-howto.txt
> >> email-clients.txt
> >> flexible-arrays.txt
> >> futex-requeue-pi.txt
> >> gcov.txt
> >> ...
> >>
> >> Also there have some entry not list as alphabetical order.
> >
> > My script lists those as well: it finds a little over 1100 of them,
> > which is why I didn't post the list.  (Here it is gzipped and attached.)
> >  But that's also listing files for directories that have no 00-INDEX, so
> > I should probably filter that better...
> >
> > Is alphabetical order a requirement?
> >
> > Rob
> >
> 
> Hmm, not sure..., The header of 00-INDEX is like this:
> >>>>
> This is a brief list of all the files in ./linux/Documentation and what
> they contain. If you add a documentation file, please list it here in
> alphabetical order as well, or risk being hunted down like a rabid dog.
> Please try and keep the descriptions small enough to fit on one line.
>                                                         Thanks -- Paul G.
> <<<

so Yes, alpha order, please.

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

net: update Documentation/networking/00-INDEX

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

Clean up entries in 00-INDEX: drop files that have been removed.

Reported-by: Rob Landley <rlandley@parallels.com>
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 Documentation/networking/00-INDEX |    6 ------
 1 file changed, 6 deletions(-)

--- linux-next-20110222.orig/Documentation/networking/00-INDEX
+++ linux-next-20110222/Documentation/networking/00-INDEX
@@ -40,8 +40,6 @@ decnet.txt
 	- info on using the DECnet networking layer in Linux.
 depca.txt
 	- the Digital DEPCA/EtherWORKS DE1?? and DE2?? LANCE Ethernet driver
-dgrs.txt
-	- the Digi International RightSwitch SE-X Ethernet driver
 dmfe.txt
 	- info on the Davicom DM9102(A)/DM9132/DM9801 fast ethernet driver.
 e100.txt
@@ -50,8 +48,6 @@ e1000.txt
 	- info on Intel's E1000 line of gigabit ethernet boards
 eql.txt
 	- serial IP load balancing
-ethertap.txt
-	- the Ethertap user space packet reception and transmission driver
 ewrk3.txt
 	- the Digital EtherWORKS 3 DE203/4/5 Ethernet driver
 filter.txt
@@ -104,8 +100,6 @@ tuntap.txt
 	- TUN/TAP device driver, allowing user space Rx/Tx of packets.
 vortex.txt
 	- info on using 3Com Vortex (3c590, 3c592, 3c595, 3c597) Ethernet cards.
-wavelan.txt
-	- AT&T GIS (nee NCR) WaveLAN card: An Ethernet-like radio transceiver
 x25.txt
 	- general info on X.25 development.
 x25-iface.txt

Re: net: update Documentation/networking/00-INDEX

[Rob Landley]

On 02/22/2011 04:23 PM, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> Clean up entries in 00-INDEX: drop files that have been removed.
> 
> Reported-by: Rob Landley <rlandley@parallels.com>
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>

Acked-by: Rob Landley <rlandley@parallels.com>

Re: [PATCH] Remove obsolete Documentation/powerpc/00-INDEX entries

[Rob Landley]

On 02/21/2011 03:40 PM, Randy Dunlap wrote:
> On Mon, 21 Feb 2011 15:34:09 -0600 Rob Landley wrote:
> 
>> From: Rob Landley <rlandley@parallels.com>
>>
>> The device tree infrastructure is being genericized so its documentation
>> moved out of the PowerPC directory.
>>
>> Signed-off-by: Rob Landley <rlandley@parallels.com>
> 
> Added to my patch queue.  Thanks.
> 
>> ---
>>
>>  Documentation/devicetree/00-INDEX |    8 ++++++++
>>  Documentation/powerpc/00-INDEX    |    4 ----
>>  2 files changed, 8 insertions(+), 4 deletions(-)
>>
>> --- /dev/null	2011-02-13 16:59:19.073990002 -0600
>> +++ b/Documentation/devicetree/00-INDEX	2011-02-21 14:47:12.911544002 -0600
>> @@ -0,0 +1,8 @@
>> +Documentation for device trees, a data structure by which bootloaders pass
>> +hardware layout to Linux in a device-independent manner, simplifying hardware
>> +probing.  This subsystem is maintained by Grant Likely
>> +<grant.likely@secretlab.ca> and has a mailing list at
>> +https://lists.ozlabs.org/listinfo/devicetree-discuss
>> +
>> +booting-without-of.txt
>> +        - Booting Linux without Open Firmware, describes history and format of device trees.

Gah, I screwed this one up.  All the other 00-INDEX files list
themselves as the first entry, ala:

>> diff --git a/Documentation/powerpc/00-INDEX b/Documentation/powerpc/00-INDEX
>> index e3960b8..5620fb5 100644
>> --- a/Documentation/powerpc/00-INDEX
>> +++ b/Documentation/powerpc/00-INDEX
>> @@ -5,8 +5,6 @@ please mail me.
>>  
>>  00-INDEX
>>  	- this file
>> -booting-without-of.txt
>> -	- Booting the Linux/ppc kernel without Open Firmware

See?

(This broke my index.html generator script, which uses the 00-INDEX line
to split "header info that does not contain files you link to" from
"alternating file/description lines" which come after it.  Yes, I broke
my own script.)

Sorry I didn't catch this quickly, I had to get on a plane and come to
Scale.  (Handing out flyers at the OpenVZ booth.)

Let me know if you want a replacement patch or a patch on top of this one.

Thanks,

Rob

Re: [PATCH] Remove obsolete Documentation/powerpc/00-INDEX entries

[Randy Dunlap]

On Fri, 25 Feb 2011 00:24:23 -0600 Rob Landley wrote:

> On 02/21/2011 03:40 PM, Randy Dunlap wrote:
> > On Mon, 21 Feb 2011 15:34:09 -0600 Rob Landley wrote:
> > 
> >> From: Rob Landley <rlandley@parallels.com>
> >>
> >> The device tree infrastructure is being genericized so its documentation
> >> moved out of the PowerPC directory.
> >>
> >> Signed-off-by: Rob Landley <rlandley@parallels.com>
> > 
> > Added to my patch queue.  Thanks.
> > 
> >> ---
> >>
> >>  Documentation/devicetree/00-INDEX |    8 ++++++++
> >>  Documentation/powerpc/00-INDEX    |    4 ----
> >>  2 files changed, 8 insertions(+), 4 deletions(-)
> >>
> >> --- /dev/null	2011-02-13 16:59:19.073990002 -0600
> >> +++ b/Documentation/devicetree/00-INDEX	2011-02-21 14:47:12.911544002 -0600
> >> @@ -0,0 +1,8 @@
> >> +Documentation for device trees, a data structure by which bootloaders pass
> >> +hardware layout to Linux in a device-independent manner, simplifying hardware
> >> +probing.  This subsystem is maintained by Grant Likely
> >> +<grant.likely@secretlab.ca> and has a mailing list at
> >> +https://lists.ozlabs.org/listinfo/devicetree-discuss
> >> +
> >> +booting-without-of.txt
> >> +        - Booting Linux without Open Firmware, describes history and format of device trees.
> 
> Gah, I screwed this one up.  All the other 00-INDEX files list
> themselves as the first entry, ala:
> 
> >> diff --git a/Documentation/powerpc/00-INDEX b/Documentation/powerpc/00-INDEX
> >> index e3960b8..5620fb5 100644
> >> --- a/Documentation/powerpc/00-INDEX
> >> +++ b/Documentation/powerpc/00-INDEX
> >> @@ -5,8 +5,6 @@ please mail me.
> >>  
> >>  00-INDEX
> >>  	- this file
> >> -booting-without-of.txt
> >> -	- Booting the Linux/ppc kernel without Open Firmware
> 
> See?
> 
> (This broke my index.html generator script, which uses the 00-INDEX line
> to split "header info that does not contain files you link to" from
> "alternating file/description lines" which come after it.  Yes, I broke
> my own script.)
> 
> Sorry I didn't catch this quickly, I had to get on a plane and come to
> Scale.  (Handing out flyers at the OpenVZ booth.)
> 
> Let me know if you want a replacement patch or a patch on top of this one.

Thanks for catching that.
A replacement patch, please.

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

Re: net: update Documentation/networking/00-INDEX

[David Miller]

From: Rob Landley <rlandley@parallels.com>
Date: Tue, 22 Feb 2011 18:09:49 -0600

> On 02/22/2011 04:23 PM, Randy Dunlap wrote:
>> From: Randy Dunlap <randy.dunlap@oracle.com>
>> 
>> Clean up entries in 00-INDEX: drop files that have been removed.
>> 
>> Reported-by: Rob Landley <rlandley@parallels.com>
>> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
> 
> Acked-by: Rob Landley <rlandley@parallels.com>

Applied, thanks.

Re: [PATCH] Remove obsolete Documentation/powerpc/00-INDEX entries

[Rob Landley]

On 02/25/2011 10:37 AM, Randy Dunlap wrote:
>> Let me know if you want a replacement patch or a patch on top of this one.
> 
> Thanks for catching that.
> A replacement patch, please.

Here you go:

From: Rob Landley <rlandley@parallels.com>

The device tree infrastructure is being genericized so its documentation moved
out of the PowerPC directory.

Signed-off-by: Rob Landley <rlandley@parallels.com>
---

 Documentation/devicetree/00-INDEX |   10 ++++++++++
 Documentation/powerpc/00-INDEX    |    4 ----
 2 files changed, 10 insertions(+), 4 deletions(-)

--- /dev/null	2011-02-13 16:59:19.073990002 -0600
+++ b/Documentation/devicetree/00-INDEX	2011-02-21 14:47:12.911544002 -0600
@@ -0,0 +1,10 @@
+Documentation for device trees, a data structure by which bootloaders pass
+hardware layout to Linux in a device-independent manner, simplifying hardware
+probing.  This subsystem is maintained by Grant Likely
+<grant.likely@secretlab.ca> and has a mailing list at
+https://lists.ozlabs.org/listinfo/devicetree-discuss
+
+00-INDEX
+	- this file
+booting-without-of.txt
+	- Booting Linux without Open Firmware, describes history and format of device trees.
diff --git a/Documentation/powerpc/00-INDEX b/Documentation/powerpc/00-INDEX
index e3960b8..5620fb5 100644
--- a/Documentation/powerpc/00-INDEX
+++ b/Documentation/powerpc/00-INDEX
@@ -5,8 +5,6 @@ please mail me.
 
 00-INDEX
 	- this file
-booting-without-of.txt
-	- Booting the Linux/ppc kernel without Open Firmware
 cpu_features.txt
 	- info on how we support a variety of CPUs with minimal compile-time
 	options.
@@ -16,8 +14,6 @@ hvcs.txt
 	- IBM "Hypervisor Virtual Console Server" Installation Guide
 mpc52xx.txt
 	- Linux 2.6.x on MPC52xx family
-mpc52xx-device-tree-bindings.txt
-	- MPC5200 Device Tree Bindings
 sound.txt
 	- info on sound support under Linux/PPC
 zImage_layout.txt

Re: [PATCH] Remove obsolete Documentation/powerpc/00-INDEX entries

[Randy Dunlap]

On Wed, 9 Mar 2011, Rob Landley wrote:

> On 02/25/2011 10:37 AM, Randy Dunlap wrote:
>>> Let me know if you want a replacement patch or a patch on top of this one.
>>
>> Thanks for catching that.
>> A replacement patch, please.
>
> Here you go:
>
> From: Rob Landley <rlandley@parallels.com>
>
> The device tree infrastructure is being genericized so its documentation moved
> out of the PowerPC directory.
>
> Signed-off-by: Rob Landley <rlandley@parallels.com>

applied, thanks.

> ---
>
> Documentation/devicetree/00-INDEX |   10 ++++++++++
> Documentation/powerpc/00-INDEX    |    4 ----
> 2 files changed, 10 insertions(+), 4 deletions(-)
>
> --- /dev/null	2011-02-13 16:59:19.073990002 -0600
> +++ b/Documentation/devicetree/00-INDEX	2011-02-21 14:47:12.911544002 -0600
> @@ -0,0 +1,10 @@
> +Documentation for device trees, a data structure by which bootloaders pass
> +hardware layout to Linux in a device-independent manner, simplifying hardware
> +probing.  This subsystem is maintained by Grant Likely
> +<grant.likely@secretlab.ca> and has a mailing list at
> +https://lists.ozlabs.org/listinfo/devicetree-discuss
> +
> +00-INDEX
> +	- this file
> +booting-without-of.txt
> +	- Booting Linux without Open Firmware, describes history and format of device trees.
> diff --git a/Documentation/powerpc/00-INDEX b/Documentation/powerpc/00-INDEX
> index e3960b8..5620fb5 100644
> --- a/Documentation/powerpc/00-INDEX
> +++ b/Documentation/powerpc/00-INDEX
> @@ -5,8 +5,6 @@ please mail me.
>
> 00-INDEX
> 	- this file
> -booting-without-of.txt
> -	- Booting the Linux/ppc kernel without Open Firmware
> cpu_features.txt
> 	- info on how we support a variety of CPUs with minimal compile-time
> 	options.
> @@ -16,8 +14,6 @@ hvcs.txt
> 	- IBM "Hypervisor Virtual Console Server" Installation Guide
> mpc52xx.txt
> 	- Linux 2.6.x on MPC52xx family
> -mpc52xx-device-tree-bindings.txt
> -	- MPC5200 Device Tree Bindings
> sound.txt
> 	- info on sound support under Linux/PPC
> zImage_layout.txt
>
>
>