Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Fri, Jan 31, 2014 at 5:24 PM, Andrew Morton wrote: > On Wed, 29 Jan 2014 22:24:11 -0600 Rob Landley wrote: > >> On 01/29/14 18:27, Henrik Austad wrote: >> > Some of the 00-INDEX files are somewhat outdated and some folders does not >> > contain 00-INDEX at all. Only outdated (with the notably exception of >> > spi) indexes are touched here, the 169 folders without 00-INDEX has not >> > been touched. >> > >> > This applies to Linus' tip (0e47c969). >> >> Looks like an improvement. >> >> Acked-by: Rob Landley > > Are these 00-INDEX files actually useful? I've never opened one of > them in my life. I think I introduced them some decades ago, but after a basic search I could not incriminate myself, so I do ACK the blanket removal -- FWIW. :) Paul. -- -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Fri, Jan 31, 2014 at 5:24 PM, Andrew Morton a...@linux-foundation.org wrote: On Wed, 29 Jan 2014 22:24:11 -0600 Rob Landley r...@landley.net wrote: On 01/29/14 18:27, Henrik Austad wrote: Some of the 00-INDEX files are somewhat outdated and some folders does not contain 00-INDEX at all. Only outdated (with the notably exception of spi) indexes are touched here, the 169 folders without 00-INDEX has not been touched. This applies to Linus' tip (0e47c969). Looks like an improvement. Acked-by: Rob Landley r...@landley.net Are these 00-INDEX files actually useful? I've never opened one of them in my life. I think I introduced them some decades ago, but after a basic search I could not incriminate myself, so I do ACK the blanket removal -- FWIW. :) Paul. -- -- To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Sun, 2014-02-02 at 01:04 -0600, Rob Landley wrote: > Back before kernel.org did its epic barn door locking after the horses > escaped, I used to use them to generate HTML indexes for > kernel.org/doc/Documentation, but sometime after they took away my > ability to rsync updates to that they replaced that directory with a raw > git checkout. I'm still waiting for them to replace the HTML versions of > the menuconfig help text and the htmldocs output with raw git checkouts too. > > I periodically poke them about it, ala > https://bugzilla.kernel.org/show_bug.cgi?id=52721#c7 but the answer is > always crickets chirping or "you should upload web pages with git just > like you browse the web with git, watch video with git, play skyrim with > git, edit code with git, compile code with git... there is no other > software tool." At which point I wander off for another 6 months. > > So I used to have a use for it, but since kernel.org got all paranoid I > can't use it that way anymore. (That's why I haven't been updating these > files when the patches themselves don't. It's on my todo list, but it's > really hard to _care_ when they so obviously don't.) Has it not occurred to you that everyone else moved on from this. Sure there were annoying and painful adjustments that had to be made and processes that had to be completely rebuilt and sure it was hard to build a chain of trust to people in obscure places but everyone else did it. Business people are fond of dividing the world into Doers and Whiners. I don't entirely buy this because in my personal experience if something ends up being really hard, Doers like to whine about how hard it was to do in the pub afterwards ... I know I do, particularly over single malts. The essential truth, I think, is that people with the drive to do something use that drive to overcome obstacles in their path; people without it use the obstacles as an excuse for why something didn't get done. Fundamentally, Open Source is about Doers and thus, while there are many self help groups for Whiners Open Source lists like LKML aren't among them. James -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Sun, 2014-02-02 at 01:04 -0600, Rob Landley wrote: Back before kernel.org did its epic barn door locking after the horses escaped, I used to use them to generate HTML indexes for kernel.org/doc/Documentation, but sometime after they took away my ability to rsync updates to that they replaced that directory with a raw git checkout. I'm still waiting for them to replace the HTML versions of the menuconfig help text and the htmldocs output with raw git checkouts too. I periodically poke them about it, ala https://bugzilla.kernel.org/show_bug.cgi?id=52721#c7 but the answer is always crickets chirping or you should upload web pages with git just like you browse the web with git, watch video with git, play skyrim with git, edit code with git, compile code with git... there is no other software tool. At which point I wander off for another 6 months. So I used to have a use for it, but since kernel.org got all paranoid I can't use it that way anymore. (That's why I haven't been updating these files when the patches themselves don't. It's on my todo list, but it's really hard to _care_ when they so obviously don't.) Has it not occurred to you that everyone else moved on from this. Sure there were annoying and painful adjustments that had to be made and processes that had to be completely rebuilt and sure it was hard to build a chain of trust to people in obscure places but everyone else did it. Business people are fond of dividing the world into Doers and Whiners. I don't entirely buy this because in my personal experience if something ends up being really hard, Doers like to whine about how hard it was to do in the pub afterwards ... I know I do, particularly over single malts. The essential truth, I think, is that people with the drive to do something use that drive to overcome obstacles in their path; people without it use the obstacles as an excuse for why something didn't get done. Fundamentally, Open Source is about Doers and thus, while there are many self help groups for Whiners Open Source lists like LKML aren't among them. James -- To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On 01/31/14 16:24, Andrew Morton wrote: On Wed, 29 Jan 2014 22:24:11 -0600 Rob Landley wrote: On 01/29/14 18:27, Henrik Austad wrote: Some of the 00-INDEX files are somewhat outdated and some folders does not contain 00-INDEX at all. Only outdated (with the notably exception of spi) indexes are touched here, the 169 folders without 00-INDEX has not been touched. This applies to Linus' tip (0e47c969). Looks like an improvement. Acked-by: Rob Landley Are these 00-INDEX files actually useful? I've never opened one of them in my life. Back before kernel.org did its epic barn door locking after the horses escaped, I used to use them to generate HTML indexes for kernel.org/doc/Documentation, but sometime after they took away my ability to rsync updates to that they replaced that directory with a raw git checkout. I'm still waiting for them to replace the HTML versions of the menuconfig help text and the htmldocs output with raw git checkouts too. I periodically poke them about it, ala https://bugzilla.kernel.org/show_bug.cgi?id=52721#c7 but the answer is always crickets chirping or "you should upload web pages with git just like you browse the web with git, watch video with git, play skyrim with git, edit code with git, compile code with git... there is no other software tool." At which point I wander off for another 6 months. So I used to have a use for it, but since kernel.org got all paranoid I can't use it that way anymore. (That's why I haven't been updating these files when the patches themselves don't. It's on my todo list, but it's really hard to _care_ when they so obviously don't.) Insufficiently gruntled, Rob -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Fri, Jan 31, 2014 at 02:24:42PM -0800, Andrew Morton wrote: > On Wed, 29 Jan 2014 22:24:11 -0600 Rob Landley wrote: > > > On 01/29/14 18:27, Henrik Austad wrote: > > > Some of the 00-INDEX files are somewhat outdated and some folders does not > > > contain 00-INDEX at all. Only outdated (with the notably exception of > > > spi) indexes are touched here, the 169 folders without 00-INDEX has not > > > been touched. > > > > > > This applies to Linus' tip (0e47c969). > > > > Looks like an improvement. > > > > Acked-by: Rob Landley > > Are these 00-INDEX files actually useful? I've never opened one of > them in my life. That depends. They serve as a very nice starting point when you start to dig into a particular part of the kernel. Once you're up and running however, you probably won't need the index-files all that much. So, I'd say they serve a purpose, but not a major one. For that reason, I didn't start adding index-files to those directories that don't have them. So, should we start an epic bikeshedding-context and ask "should we scrap all 00-INDEX files in Documentation?" ;) Either way, outdated index-files are pretty stupid, which was my motivation for at least keeping them current. -- Henrik Austad signature.asc Description: Digital signature
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Fri, Jan 31, 2014 at 02:24:42PM -0800, Andrew Morton wrote: On Wed, 29 Jan 2014 22:24:11 -0600 Rob Landley r...@landley.net wrote: On 01/29/14 18:27, Henrik Austad wrote: Some of the 00-INDEX files are somewhat outdated and some folders does not contain 00-INDEX at all. Only outdated (with the notably exception of spi) indexes are touched here, the 169 folders without 00-INDEX has not been touched. This applies to Linus' tip (0e47c969). Looks like an improvement. Acked-by: Rob Landley r...@landley.net Are these 00-INDEX files actually useful? I've never opened one of them in my life. That depends. They serve as a very nice starting point when you start to dig into a particular part of the kernel. Once you're up and running however, you probably won't need the index-files all that much. So, I'd say they serve a purpose, but not a major one. For that reason, I didn't start adding index-files to those directories that don't have them. So, should we start an epic bikeshedding-context and ask should we scrap all 00-INDEX files in Documentation? ;) Either way, outdated index-files are pretty stupid, which was my motivation for at least keeping them current. -- Henrik Austad signature.asc Description: Digital signature
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On 01/31/14 16:24, Andrew Morton wrote: On Wed, 29 Jan 2014 22:24:11 -0600 Rob Landley r...@landley.net wrote: On 01/29/14 18:27, Henrik Austad wrote: Some of the 00-INDEX files are somewhat outdated and some folders does not contain 00-INDEX at all. Only outdated (with the notably exception of spi) indexes are touched here, the 169 folders without 00-INDEX has not been touched. This applies to Linus' tip (0e47c969). Looks like an improvement. Acked-by: Rob Landley r...@landley.net Are these 00-INDEX files actually useful? I've never opened one of them in my life. Back before kernel.org did its epic barn door locking after the horses escaped, I used to use them to generate HTML indexes for kernel.org/doc/Documentation, but sometime after they took away my ability to rsync updates to that they replaced that directory with a raw git checkout. I'm still waiting for them to replace the HTML versions of the menuconfig help text and the htmldocs output with raw git checkouts too. I periodically poke them about it, ala https://bugzilla.kernel.org/show_bug.cgi?id=52721#c7 but the answer is always crickets chirping or you should upload web pages with git just like you browse the web with git, watch video with git, play skyrim with git, edit code with git, compile code with git... there is no other software tool. At which point I wander off for another 6 months. So I used to have a use for it, but since kernel.org got all paranoid I can't use it that way anymore. (That's why I haven't been updating these files when the patches themselves don't. It's on my todo list, but it's really hard to _care_ when they so obviously don't.) Insufficiently gruntled, Rob -- To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Wed, 29 Jan 2014 22:24:11 -0600 Rob Landley wrote: > On 01/29/14 18:27, Henrik Austad wrote: > > Some of the 00-INDEX files are somewhat outdated and some folders does not > > contain 00-INDEX at all. Only outdated (with the notably exception of > > spi) indexes are touched here, the 169 folders without 00-INDEX has not > > been touched. > > > > This applies to Linus' tip (0e47c969). > > Looks like an improvement. > > Acked-by: Rob Landley Are these 00-INDEX files actually useful? I've never opened one of them in my life. -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Wed, 29 Jan 2014 22:24:11 -0600 Rob Landley r...@landley.net wrote: On 01/29/14 18:27, Henrik Austad wrote: Some of the 00-INDEX files are somewhat outdated and some folders does not contain 00-INDEX at all. Only outdated (with the notably exception of spi) indexes are touched here, the 169 folders without 00-INDEX has not been touched. This applies to Linus' tip (0e47c969). Looks like an improvement. Acked-by: Rob Landley r...@landley.net Are these 00-INDEX files actually useful? I've never opened one of them in my life. -- To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Wed, Jan 29, 2014 at 10:24:11PM -0600, Rob Landley wrote: > [...] > However, I'm curious about this bit: > > >--- a/Documentation/00-INDEX > >+++ b/Documentation/00-INDEX > >@@ -1,11 +1,11 @@ > > > >-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 keep the descriptions small enough to fit on one line. > >- Thanks -- Paul G. > >+# 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 keep the descriptions small enough to fit on one line. > >+#Thanks -- Paul G. > > > >-Following translations are available on the WWW: > >+# Following translations are available on the WWW: > > Is there a reason for that? Ahem, yes, but not anymore. Leftovers from my initial index-traverse.py hack. Updated patch below. henrik >From 78882b49b0910079aa574781accc9426e215ac78 Mon Sep 17 00:00:00 2001 From: Henrik Austad Date: Thu, 31 Oct 2013 14:19:10 +0100 Subject: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/ Some of the 00-INDEX files are somewhat outdated and some folders does not contain 00-INDEX at all. Only outdated (with the notably exception of spi) indexes are touched here, the 169 folders without 00-INDEX has not been touched. This applies to Linus' tip (0e47c969). New 00-INDEX - spi/* was added in a series of commits dating back to 2006 Added files (missing in (*/)00-INDEX) - dmatest.txt was added by 851b7e16 (dmatest: run test via debugfs). - this_cpu_ops.txt was added by a1b2a555 (percpu: add documentation on this_cpu operations) - ww-mutex-design.txt was added by 040a0a37 (mutex: Add support for wound/wait style locks) - bcache.txt was added by cafe5635 (bcache: A block layer cache) - kernel-per-CPU-kthreads.txt was added by 49717cb40 (kthread: Document ways of reducing OS jitter due to per-CPU kthreads). - phy.txt was added by ff764963 (phy: add generic PHY framework) - block/null_blk was added by 12f8f4fc (null_blk: documentation) - module-signing.txt was added by 3cafea30 (Add Documentation/module-signing.txt file) - assoc_array.txt was added by 3cb98950 (Add a generic associative array implementation.) - arm/IXP4xx was part of the initial repo (1da177e4). - arm/cluster-pm-race-avoidance.txt was added by 7fe31d28 (ARM: mcpm: introduce helpers for platform coherency exit/setup). - arm/firmware.txt was added by 7366b92a (ARM: Add interface for registering and calling firmware-specific operations). - arm/kernel_mode_neon.txt was added by 2afd0a05 (ARM: 7825/1: document the use of NEON in kernel mode) - arm/tcm.txt was added by bc581770 (ARM: 5580/2: ARM TCM (Tightly-Coupled Memory) support v3) - arm/vlocks.txt was added by 9762f12d (ARM: mcpm: Add baremetal voting mutexes) - blackfin/gptimers-example.c, Makefile was added by 4b60779d (Blackfin: add an example showing how to use the gptimers API) - devicetree/usage-model.txt was added by 31134efc (dt: Linux DT usage model documentation) - fb/api.txt was added by fb21c2f4 (fbdev: Add FOURCC-based format configuration API) - fb/sm501.txt was added by e6a04980 (video, sm501: add edid and commandline support) - fb/udlfb.txt was added by 96f8d864 (fbdev: move udlfb out of staging.) - filesystems/Makefile was added by 1e0051ae (Documentation/fs/: split txt and source files) - filesystems/nfs/nfsd-admin-interfaces.txt was added by 8a4c6e19 (nfsd: document kernel interfaces for nfsd configuration) - ide/warm-plug-howto.txt was added by f74c9141 (ide: add warm-plug support for IDE devices (take 2)) - laptops/Makefile was added by d49129ac (Documentation/laptop/: split txt and source files). - leds/leds-blinkm.txt was added by b54cf35a (LEDS: add BlinkM RGB LED driver, documentation and update MAINTAINERS) - leds/ledtrig-oneshot.txt was added by 5e417281c (leds: add oneshot trigger) - leds/ledtrig-transient.txt was added by 44e1e9f8 (leds: add new transient trigger for one shot timer activation) - m68k/README.buddha was part of the initial repo (1da177e4). - networking/LICENSE.(qla3xxx|qlcnic|qlge) was added by 5a4faa87, 40839129, c4e84bde. - networking/Makefile was added by 3794f3e8 (docsrc: build Documentation/ sources) - networking/i40evf.txt was added by 105bf2fe (i40evf: add driver to kernel build system) - networking/ipsec.txt was added by b3c6efbc (xfrm: Add file to document IPsec corner case) - networking/mac80211-auth-assoc-deauth.txt was added by 3cd7920a (mac80211: add auth/assoc/deauth flow diagram) - networking/netlink_mmap.txt was added by 5683264c (netlink: add documentation for memory mapped I/O) -
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On 01/29/14 18:27, Henrik Austad wrote: Some of the 00-INDEX files are somewhat outdated and some folders does not contain 00-INDEX at all. Only outdated (with the notably exception of spi) indexes are touched here, the 169 folders without 00-INDEX has not been touched. This applies to Linus' tip (0e47c969). Looks like an improvement. Acked-by: Rob Landley (My own scripts to find this stuff are based on maintaining http://kernel.org/doc and the kernel developers are no longer capable of providing rsync access to that, despite repeated requests. Most recently https://bugzilla.kernel.org/show_bug.cgi?id=52721 ) However, I'm curious about this bit: --- a/Documentation/00-INDEX +++ b/Documentation/00-INDEX @@ -1,11 +1,11 @@ -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 keep the descriptions small enough to fit on one line. -Thanks -- Paul G. +# 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 keep the descriptions small enough to fit on one line. +# Thanks -- Paul G. -Following translations are available on the WWW: +# Following translations are available on the WWW: Is there a reason for that? Rob -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Thu, Jan 30, 2014 at 01:27:55AM +0100, Henrik Austad wrote: > Some of the 00-INDEX files are somewhat outdated and some folders does not > contain 00-INDEX at all. Only outdated (with the notably exception of > spi) indexes are touched here, the 169 folders without 00-INDEX has not > been touched. > > This applies to Linus' tip (0e47c969). RCU parts: Reviewed-by: Paul E. McKenney > New 00-INDEX > - spi/* was added in a series of commits dating back to 2006 > > Added files (missing in (*/)00-INDEX) > - dmatest.txt was added by 851b7e16 (dmatest: run test via > debugfs). > - this_cpu_ops.txt was added by a1b2a555 (percpu: add documentation on > this_cpu operations) > - ww-mutex-design.txt was added by 040a0a37 (mutex: Add support for > wound/wait style locks) > - bcache.txt was added by cafe5635 (bcache: A block layer cache) > - kernel-per-CPU-kthreads.txt was added by 49717cb40 (kthread: Document > ways of reducing OS jitter due to per-CPU kthreads). > - phy.txt was added by ff764963 (phy: add generic PHY framework) > - block/null_blk was added by 12f8f4fc (null_blk: documentation) > - module-signing.txt was added by 3cafea30 (Add > Documentation/module-signing.txt file) > - assoc_array.txt was added by 3cb98950 (Add a generic associative array > implementation.) > - arm/IXP4xx was part of the initial repo (1da177e4). > - arm/cluster-pm-race-avoidance.txt was added by 7fe31d28 (ARM: mcpm: > introduce helpers for platform coherency exit/setup). > - arm/firmware.txt was added by 7366b92a (ARM: Add interface for > registering and calling firmware-specific operations). > - arm/kernel_mode_neon.txt was added by 2afd0a05 (ARM: 7825/1: document > the use of NEON in kernel mode) > - arm/tcm.txt was added by bc581770 (ARM: 5580/2: ARM TCM > (Tightly-Coupled Memory) support v3) > - arm/vlocks.txt was added by 9762f12d (ARM: mcpm: Add baremetal voting > mutexes) > - blackfin/gptimers-example.c, Makefile was added by 4b60779d (Blackfin: > add an example showing how to use the gptimers API) > - devicetree/usage-model.txt was added by 31134efc (dt: Linux DT usage > model documentation) > - fb/api.txt was added by fb21c2f4 (fbdev: Add FOURCC-based format > configuration API) > - fb/sm501.txt was added by e6a04980 (video, sm501: add edid and > commandline support) > - fb/udlfb.txt was added by 96f8d864 (fbdev: move udlfb out of staging.) > - filesystems/Makefile was added by 1e0051ae (Documentation/fs/: split > txt and source files) > - filesystems/nfs/nfsd-admin-interfaces.txt was added by 8a4c6e19 (nfsd: > document kernel interfaces for nfsd configuration) > - ide/warm-plug-howto.txt was added by f74c9141 (ide: add warm-plug > support for IDE devices (take 2)) > - laptops/Makefile was added by d49129ac (Documentation/laptop/: split > txt and source files). > - leds/leds-blinkm.txt was added by b54cf35a (LEDS: add BlinkM RGB LED > driver, documentation and update MAINTAINERS) > - leds/ledtrig-oneshot.txt was added by 5e417281c (leds: add oneshot > trigger) > - leds/ledtrig-transient.txt was added by 44e1e9f8 (leds: add new > transient trigger for one shot timer activation) > - m68k/README.buddha was part of the initial repo (1da177e4). > - networking/LICENSE.(qla3xxx|qlcnic|qlge) was added by 5a4faa87, > 40839129, c4e84bde. > - networking/Makefile was added by 3794f3e8 (docsrc: build > Documentation/ sources) > - networking/i40evf.txt was added by 105bf2fe (i40evf: add driver to > kernel build system) > - networking/ipsec.txt was added by b3c6efbc (xfrm: Add file to document > IPsec corner case) > - networking/mac80211-auth-assoc-deauth.txt was added by 3cd7920a > (mac80211: add auth/assoc/deauth flow diagram) > - networking/netlink_mmap.txt was added by 5683264c (netlink: add > documentation for memory mapped I/O) > - networking/nf_conntrack-sysctl.txt was added by c9f9e0e1 (netfilter: > doc: add nf_conntrack sysctl api documentation) > lan) > - networking/team.txt was added by 3d249d4c (net: introduce ethernet > teaming device) > - networking/vxlan.txt was added by d342894c (vxlan: virtual extensible > - power/runtime_pm.txt was added by 5e928f77 (PM: Introduce core > framework for run-time PM of I/O devices (rev. 17)) > - power/charger-manager.txt was added by 3bb3dbbd (power_supply: Add > initial Charger-Manager driver) > - RCU/lockdep-splat.txt was added by d7bd2d68 (rcu: Document > terpretation of RCU-lockdep splats) > - s390/kvm.txt was added by 5ecee4b (KVM: s390: API documentation) > - s390/qeth.txt was added by b4d72c08 (qeth: bridgeport support - basic > control) > - scheduler/sched-bwc.txt was added by 88ebc08e (sched: Add > documentation for bandwidth control) > - scsi/advansys.txt was added by 4bd6d7f3 ([SCSI] advansys: Move > documentation to Documentation/scsi) > - scsi/bfa.txt was added by 1ec90174 ([SCSI] bfa: add readme file) > - scsi/bnx2fc.txt was added by 12b8fc10 ([SCSI] bnx2fc: Add driver > documentation) > -
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Thu, Jan 30, 2014 at 01:27:55AM +0100, Henrik Austad wrote: Some of the 00-INDEX files are somewhat outdated and some folders does not contain 00-INDEX at all. Only outdated (with the notably exception of spi) indexes are touched here, the 169 folders without 00-INDEX has not been touched. This applies to Linus' tip (0e47c969). RCU parts: Reviewed-by: Paul E. McKenney paul...@linux.vnet.ibm.com New 00-INDEX - spi/* was added in a series of commits dating back to 2006 Added files (missing in (*/)00-INDEX) - dmatest.txt was added by 851b7e16 (dmatest: run test via debugfs). - this_cpu_ops.txt was added by a1b2a555 (percpu: add documentation on this_cpu operations) - ww-mutex-design.txt was added by 040a0a37 (mutex: Add support for wound/wait style locks) - bcache.txt was added by cafe5635 (bcache: A block layer cache) - kernel-per-CPU-kthreads.txt was added by 49717cb40 (kthread: Document ways of reducing OS jitter due to per-CPU kthreads). - phy.txt was added by ff764963 (phy: add generic PHY framework) - block/null_blk was added by 12f8f4fc (null_blk: documentation) - module-signing.txt was added by 3cafea30 (Add Documentation/module-signing.txt file) - assoc_array.txt was added by 3cb98950 (Add a generic associative array implementation.) - arm/IXP4xx was part of the initial repo (1da177e4). - arm/cluster-pm-race-avoidance.txt was added by 7fe31d28 (ARM: mcpm: introduce helpers for platform coherency exit/setup). - arm/firmware.txt was added by 7366b92a (ARM: Add interface for registering and calling firmware-specific operations). - arm/kernel_mode_neon.txt was added by 2afd0a05 (ARM: 7825/1: document the use of NEON in kernel mode) - arm/tcm.txt was added by bc581770 (ARM: 5580/2: ARM TCM (Tightly-Coupled Memory) support v3) - arm/vlocks.txt was added by 9762f12d (ARM: mcpm: Add baremetal voting mutexes) - blackfin/gptimers-example.c, Makefile was added by 4b60779d (Blackfin: add an example showing how to use the gptimers API) - devicetree/usage-model.txt was added by 31134efc (dt: Linux DT usage model documentation) - fb/api.txt was added by fb21c2f4 (fbdev: Add FOURCC-based format configuration API) - fb/sm501.txt was added by e6a04980 (video, sm501: add edid and commandline support) - fb/udlfb.txt was added by 96f8d864 (fbdev: move udlfb out of staging.) - filesystems/Makefile was added by 1e0051ae (Documentation/fs/: split txt and source files) - filesystems/nfs/nfsd-admin-interfaces.txt was added by 8a4c6e19 (nfsd: document kernel interfaces for nfsd configuration) - ide/warm-plug-howto.txt was added by f74c9141 (ide: add warm-plug support for IDE devices (take 2)) - laptops/Makefile was added by d49129ac (Documentation/laptop/: split txt and source files). - leds/leds-blinkm.txt was added by b54cf35a (LEDS: add BlinkM RGB LED driver, documentation and update MAINTAINERS) - leds/ledtrig-oneshot.txt was added by 5e417281c (leds: add oneshot trigger) - leds/ledtrig-transient.txt was added by 44e1e9f8 (leds: add new transient trigger for one shot timer activation) - m68k/README.buddha was part of the initial repo (1da177e4). - networking/LICENSE.(qla3xxx|qlcnic|qlge) was added by 5a4faa87, 40839129, c4e84bde. - networking/Makefile was added by 3794f3e8 (docsrc: build Documentation/ sources) - networking/i40evf.txt was added by 105bf2fe (i40evf: add driver to kernel build system) - networking/ipsec.txt was added by b3c6efbc (xfrm: Add file to document IPsec corner case) - networking/mac80211-auth-assoc-deauth.txt was added by 3cd7920a (mac80211: add auth/assoc/deauth flow diagram) - networking/netlink_mmap.txt was added by 5683264c (netlink: add documentation for memory mapped I/O) - networking/nf_conntrack-sysctl.txt was added by c9f9e0e1 (netfilter: doc: add nf_conntrack sysctl api documentation) lan) - networking/team.txt was added by 3d249d4c (net: introduce ethernet teaming device) - networking/vxlan.txt was added by d342894c (vxlan: virtual extensible - power/runtime_pm.txt was added by 5e928f77 (PM: Introduce core framework for run-time PM of I/O devices (rev. 17)) - power/charger-manager.txt was added by 3bb3dbbd (power_supply: Add initial Charger-Manager driver) - RCU/lockdep-splat.txt was added by d7bd2d68 (rcu: Document terpretation of RCU-lockdep splats) - s390/kvm.txt was added by 5ecee4b (KVM: s390: API documentation) - s390/qeth.txt was added by b4d72c08 (qeth: bridgeport support - basic control) - scheduler/sched-bwc.txt was added by 88ebc08e (sched: Add documentation for bandwidth control) - scsi/advansys.txt was added by 4bd6d7f3 ([SCSI] advansys: Move documentation to Documentation/scsi) - scsi/bfa.txt was added by 1ec90174 ([SCSI] bfa: add readme file) - scsi/bnx2fc.txt was added by 12b8fc10 ([SCSI] bnx2fc: Add driver documentation) - scsi/cxgb3i.txt was added by c3673464 ([SCSI] cxgb3i: Add cxgb3i iSCSI
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On 01/29/14 18:27, Henrik Austad wrote: Some of the 00-INDEX files are somewhat outdated and some folders does not contain 00-INDEX at all. Only outdated (with the notably exception of spi) indexes are touched here, the 169 folders without 00-INDEX has not been touched. This applies to Linus' tip (0e47c969). Looks like an improvement. Acked-by: Rob Landley r...@landley.net (My own scripts to find this stuff are based on maintaining http://kernel.org/doc and the kernel developers are no longer capable of providing rsync access to that, despite repeated requests. Most recently https://bugzilla.kernel.org/show_bug.cgi?id=52721 ) However, I'm curious about this bit: --- a/Documentation/00-INDEX +++ b/Documentation/00-INDEX @@ -1,11 +1,11 @@ -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 keep the descriptions small enough to fit on one line. -Thanks -- Paul G. +# 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 keep the descriptions small enough to fit on one line. +# Thanks -- Paul G. -Following translations are available on the WWW: +# Following translations are available on the WWW: Is there a reason for that? Rob -- To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/
On Wed, Jan 29, 2014 at 10:24:11PM -0600, Rob Landley wrote: [...] However, I'm curious about this bit: --- a/Documentation/00-INDEX +++ b/Documentation/00-INDEX @@ -1,11 +1,11 @@ -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 keep the descriptions small enough to fit on one line. - Thanks -- Paul G. +# 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 keep the descriptions small enough to fit on one line. +#Thanks -- Paul G. -Following translations are available on the WWW: +# Following translations are available on the WWW: Is there a reason for that? Ahem, yes, but not anymore. Leftovers from my initial index-traverse.py hack. Updated patch below. henrik From 78882b49b0910079aa574781accc9426e215ac78 Mon Sep 17 00:00:00 2001 From: Henrik Austad hen...@austad.us Date: Thu, 31 Oct 2013 14:19:10 +0100 Subject: [PATCH] Documentation cleanup, update 00-INDEX files in Documentation/ Some of the 00-INDEX files are somewhat outdated and some folders does not contain 00-INDEX at all. Only outdated (with the notably exception of spi) indexes are touched here, the 169 folders without 00-INDEX has not been touched. This applies to Linus' tip (0e47c969). New 00-INDEX - spi/* was added in a series of commits dating back to 2006 Added files (missing in (*/)00-INDEX) - dmatest.txt was added by 851b7e16 (dmatest: run test via debugfs). - this_cpu_ops.txt was added by a1b2a555 (percpu: add documentation on this_cpu operations) - ww-mutex-design.txt was added by 040a0a37 (mutex: Add support for wound/wait style locks) - bcache.txt was added by cafe5635 (bcache: A block layer cache) - kernel-per-CPU-kthreads.txt was added by 49717cb40 (kthread: Document ways of reducing OS jitter due to per-CPU kthreads). - phy.txt was added by ff764963 (phy: add generic PHY framework) - block/null_blk was added by 12f8f4fc (null_blk: documentation) - module-signing.txt was added by 3cafea30 (Add Documentation/module-signing.txt file) - assoc_array.txt was added by 3cb98950 (Add a generic associative array implementation.) - arm/IXP4xx was part of the initial repo (1da177e4). - arm/cluster-pm-race-avoidance.txt was added by 7fe31d28 (ARM: mcpm: introduce helpers for platform coherency exit/setup). - arm/firmware.txt was added by 7366b92a (ARM: Add interface for registering and calling firmware-specific operations). - arm/kernel_mode_neon.txt was added by 2afd0a05 (ARM: 7825/1: document the use of NEON in kernel mode) - arm/tcm.txt was added by bc581770 (ARM: 5580/2: ARM TCM (Tightly-Coupled Memory) support v3) - arm/vlocks.txt was added by 9762f12d (ARM: mcpm: Add baremetal voting mutexes) - blackfin/gptimers-example.c, Makefile was added by 4b60779d (Blackfin: add an example showing how to use the gptimers API) - devicetree/usage-model.txt was added by 31134efc (dt: Linux DT usage model documentation) - fb/api.txt was added by fb21c2f4 (fbdev: Add FOURCC-based format configuration API) - fb/sm501.txt was added by e6a04980 (video, sm501: add edid and commandline support) - fb/udlfb.txt was added by 96f8d864 (fbdev: move udlfb out of staging.) - filesystems/Makefile was added by 1e0051ae (Documentation/fs/: split txt and source files) - filesystems/nfs/nfsd-admin-interfaces.txt was added by 8a4c6e19 (nfsd: document kernel interfaces for nfsd configuration) - ide/warm-plug-howto.txt was added by f74c9141 (ide: add warm-plug support for IDE devices (take 2)) - laptops/Makefile was added by d49129ac (Documentation/laptop/: split txt and source files). - leds/leds-blinkm.txt was added by b54cf35a (LEDS: add BlinkM RGB LED driver, documentation and update MAINTAINERS) - leds/ledtrig-oneshot.txt was added by 5e417281c (leds: add oneshot trigger) - leds/ledtrig-transient.txt was added by 44e1e9f8 (leds: add new transient trigger for one shot timer activation) - m68k/README.buddha was part of the initial repo (1da177e4). - networking/LICENSE.(qla3xxx|qlcnic|qlge) was added by 5a4faa87, 40839129, c4e84bde. - networking/Makefile was added by 3794f3e8 (docsrc: build Documentation/ sources) - networking/i40evf.txt was added by 105bf2fe (i40evf: add driver to kernel build system) - networking/ipsec.txt was added by b3c6efbc (xfrm: Add file to document IPsec corner case) - networking/mac80211-auth-assoc-deauth.txt was added by 3cd7920a (mac80211: add auth/assoc/deauth flow diagram) - networking/netlink_mmap.txt was added by 5683264c (netlink: add documentation for memory mapped I/O) -
