Documentation:Update the INDEX of the documents

Documentation:Update the INDEX of the documents

[Yang Hongyang]

There are so many 00-INDEX file that are missing description of the current files in the dir.
Such as 00-INDEX in Documentation/x86/,Documentation/networking/,Documentation/
and so on.

It's a large amount of work for someone to go through all these documents and 
make summaries.

I'm willing to do some of the work but if someone else pick these up(especially the authors
of these new files) it will be a great help.^_^

-- 
Regards
Yang Hongyang

Re: Documentation:Update the INDEX of the documents

[Rob Landley]

On Wednesday 25 February 2009 01:16:59 Yang Hongyang wrote:> There are so many 00-INDEX file that are missing description of the current> files in the dir. Such as 00-INDEX in> Documentation/x86/,Documentation/networking/,Documentation/ and so on.>> It's a large amount of work for someone to go through all these documents> and make summaries.>> I'm willing to do some of the work but if someone else pick these> up(especially the authors of these new files) it will be a great help.^_^
Yeah, I used to police that.  I even wrote a script that would find the files that didn't have links and the links that didn't have files.  (It's at http://kernel.org/doc/make/doclinkcheck.py but it checks the html files generated by make/docdiridx.py and the easiest way to generate that is by calling make/make.sh to update the whole kernel.org/doc directory.)
I just ran it, here's the output.  I could make a cron job out of it if anybody cared...
404 errors:Documentation/cpusets.txtDocumentation/time_interpolators.txtDocumentation/isdn/README.eiconDocumentation/w1/masters/mxc_w1Documentation/PCI/PCI-DMA-mapping.txtDocumentation/arm/Samsung-S3C24XXDocumentation/arm/Sharp-LHDocumentation/arm/empeg/Documentation/filesystems/reiser4.txtDocumentation/networking/dgrs.txtDocumentation/networking/ethertap.txtDocumentation/s390/zfcpdumpDocumentation/powerpc/mpc52xx-device-tree-bindings.txtDocumentation/blackfin/bfin-gpio-note.txt
Unlinked documents:Documentation/ABI/READMEDocumentation/ABI/obsolete/Documentation/ABI/obsolete/dv1394Documentation/ABI/obsolete/o2cbDocumentation/ABI/removed/Documentation/ABI/removed/devfsDocumentation/ABI/removed/raw1394_legacy_isochronousDocumentation/ABI/stable/Documentation/ABI/stable/o2cbDocumentation/ABI/stable/syscallsDocumentation/ABI/stable/sysfs-class-ubiDocumentation/ABI/stable/sysfs-driver-usb-usbtmcDocumentation/ABI/stable/sysfs-moduleDocumentation/ABI/testing/Documentation/ABI/testing/debugfs-pktcdvdDocumentation/ABI/testing/procfs-diskstatsDocumentation/ABI/testing/sysfs-blockDocumentation/ABI/testing/sysfs-bus-cssDocumentation/ABI/testing/sysfs-bus-pciDocumentation/ABI/testing/sysfs-bus-umcDocumentation/ABI/testing/sysfs-bus-usbDocumentation/ABI/testing/sysfs-bus-usb-devices-usbsevsegDocumentation/ABI/testing/sysfs-c2portDocumentation/ABI/testing/sysfs-classDocumentation/ABI/testing/sysfs-class-bdiDocumentation/ABI/testing/sysfs-class-pktcdvdDocumentation/ABI/testing/sysfs-class-regulatorDocumentation/ABI/testing/sysfs-class-usb_hostDocumentation/ABI/testing/sysfs-class-uwb_rcDocumentation/ABI/testing/sysfs-devDocumentation/ABI/testing/sysfs-devicesDocumentation/ABI/testing/sysfs-devices-memoryDocumentation/ABI/testing/sysfs-firmware-acpiDocumentation/ABI/testing/sysfs-firmware-memmapDocumentation/ABI/testing/sysfs-firmware-sgi_uvDocumentation/ABI/testing/sysfs-gpioDocumentation/ABI/testing/sysfs-ibftDocumentation/ABI/testing/sysfs-kernel-mmDocumentation/ABI/testing/sysfs-kernel-mm-hugepagesDocumentation/ABI/testing/sysfs-kernel-uidsDocumentation/ABI/testing/sysfs-ocfs2Documentation/ABI/testing/sysfs-powerDocumentation/ABI/testing/sysfs-profilingDocumentation/ABI/testing/sysfs-wusb_cbafDocumentation/DMA-attributes.txtDocumentation/DMA-mapping.txtDocumentation/DocBook/.debugobjects.xml.cmdDocumentation/DocBook/.device-drivers.xml.cmdDocumentation/DocBook/.deviceiobook.xml.cmdDocumentation/DocBook/.filesystems.xml.cmdDocumentation/DocBook/.gadget.xml.cmdDocumentation/DocBook/.genericirq.xml.cmdDocumentation/DocBook/.gitignoreDocumentation/DocBook/.kernel-api.xml.cmdDocumentation/DocBook/.kernel-hacking.xml.cmdDocumentation/DocBook/.kernel-locking.xml.cmdDocumentation/DocBook/.kgdb.xml.cmdDocumentation/DocBook/.libata.xml.cmdDocumentation/DocBook/.librs.xml.cmdDocumentation/DocBook/.lsm.xml.cmdDocumentation/DocBook/.mac80211.xml.cmdDocumentation/DocBook/.mcabook.xml.cmdDocumentation/DocBook/.mtdnand.xml.cmdDocumentation/DocBook/.networking.xml.cmdDocumentation/DocBook/.procfs-guide.xml.cmdDocumentation/DocBook/.rapidio.xml.cmdDocumentation/DocBook/.regulator.xml.cmdDocumentation/DocBook/.s390-drivers.xml.cmdDocumentation/DocBook/.scsi.xml.cmdDocumentation/DocBook/.sh.xml.cmdDocumentation/DocBook/.uio-howto.xml.cmdDocumentation/DocBook/.usb.xml.cmdDocumentation/DocBook/.writing_usb_driver.xml.cmdDocumentation/DocBook/.z8530book.xml.cmdDocumentation/DocBook/MakefileDocumentation/DocBook/debugobjects.tmplDocumentation/DocBook/debugobjects.xmlDocumentation/DocBook/device-drivers.tmplDocumentation/DocBook/device-drivers.xmlDocumentation/DocBook/deviceiobook.tmplDocumentation/DocBook/deviceiobook.xmlDocumentation/DocBook/filesystems.tmplDocumentation/DocBook/filesystems.xmlDocumentation/DocBook/gadget.tmplDocumentation/DocBook/gadget.xmlDocumentation/DocBook/genericirq.tmplDocumentation/DocBook/genericirq.xmlDocumentation/DocBook/kernel-api.tmplDocumentation/DocBook/kernel-api.xmlDocumentation/DocBook/kernel-hacking.tmplDocumentation/DocBook/kernel-hacking.xmlDocumentation/DocBook/kernel-locking.tmplDocumentation/DocBook/kernel-locking.xmlDocumentation/DocBook/kgdb.tmplDocumentation/DocBook/kgdb.xmlDocumentation/DocBook/libata.tmplDocumentation/DocBook/libata.xmlDocumentation/DocBook/librs.tmplDocumentation/DocBook/librs.xmlDocumentation/DocBook/lsm.tmplDocumentation/DocBook/lsm.xmlDocumentation/DocBook/mac80211.tmplDocumentation/DocBook/mac80211.xmlDocumentation/DocBook/mcabook.tmplDocumentation/DocBook/mcabook.xmlDocumentation/DocBook/mtdnand.tmplDocumentation/DocBook/mtdnand.xmlDocumentation/DocBook/networking.tmplDocumentation/DocBook/networking.xmlDocumentation/DocBook/procfs-guide.tmplDocumentation/DocBook/procfs-guide.xmlDocumentation/DocBook/procfs_example.cDocumentation/DocBook/procfs_example.xmlDocumentation/DocBook/rapidio.tmplDocumentation/DocBook/rapidio.xmlDocumentation/DocBook/regulator.tmplDocumentation/DocBook/regulator.xmlDocumentation/DocBook/s390-drivers.tmplDocumentation/DocBook/s390-drivers.xmlDocumentation/DocBook/scsi.tmplDocumentation/DocBook/scsi.xmlDocumentation/DocBook/sh.tmplDocumentation/DocBook/sh.xmlDocumentation/DocBook/stylesheet.xslDocumentation/DocBook/uio-howto.tmplDocumentation/DocBook/uio-howto.xmlDocumentation/DocBook/usb.tmplDocumentation/DocBook/usb.xmlDocumentation/DocBook/writing_usb_driver.tmplDocumentation/DocBook/writing_usb_driver.xmlDocumentation/DocBook/z8530book.tmplDocumentation/DocBook/z8530book.xmlDocumentation/Intel-IOMMU.txtDocumentation/MakefileDocumentation/PCI/Documentation/RCU/rculist_nulls.txtDocumentation/SELinux.txtDocumentation/Smack.txtDocumentation/accounting/.gitignoreDocumentation/accounting/MakefileDocumentation/accounting/cgroupstats.txtDocumentation/accounting/delay-accounting.txtDocumentation/accounting/getdelays.cDocumentation/accounting/taskstats-struct.txtDocumentation/accounting/taskstats.txtDocumentation/acpi/debug.txtDocumentation/acpi/dsdt-override.txtDocumentation/acpi/method-tracing.txtDocumentation/aoe/aoe.txtDocumentation/aoe/autoload.shDocumentation/aoe/mkdevs.shDocumentation/aoe/mkshelf.shDocumentation/aoe/status.shDocumentation/aoe/todo.txtDocumentation/aoe/udev-install.shDocumentation/aoe/udev.txtDocumentation/arm/IXP4xxDocumentation/arm/SA1100/ADSBitsyDocumentation/arm/SA1100/AssabetDocumentation/arm/SA1100/BrutusDocumentation/arm/SA1100/CERFDocumentation/arm/SA1100/FreeBirdDocumentation/arm/SA1100/GraphicsClientDocumentation/arm/SA1100/GraphicsMasterDocumentation/arm/SA1100/HUW_WEBPANELDocumentation/arm/SA1100/ItsyDocumentation/arm/SA1100/LARTDocumentation/arm/SA1100/PLEBDocumentation/arm/SA1100/PangolinDocumentation/arm/SA1100/TifonDocumentation/arm/SA1100/VictorDocumentation/arm/SA1100/YopyDocumentation/arm/SA1100/empegDocumentation/arm/SA1100/nanoEngineDocumentation/arm/SA1100/serial_UARTDocumentation/arm/Samsung-S3C24XX/Documentation/arm/Samsung-S3C24XX/DMA.txtDocumentation/arm/Samsung-S3C24XX/EB2410ITX.txtDocumentation/arm/Samsung-S3C24XX/GPIO.txtDocumentation/arm/Samsung-S3C24XX/H1940.txtDocumentation/arm/Samsung-S3C24XX/NAND.txtDocumentation/arm/Samsung-S3C24XX/Overview.txtDocumentation/arm/Samsung-S3C24XX/S3C2412.txtDocumentation/arm/Samsung-S3C24XX/S3C2413.txtDocumentation/arm/Samsung-S3C24XX/SMDK2440.txtDocumentation/arm/Samsung-S3C24XX/Suspend.txtDocumentation/arm/Samsung-S3C24XX/USB-Host.txtDocumentation/arm/Sharp-LH/Documentation/arm/Sharp-LH/ADC-LH7-TouchscreenDocumentation/arm/Sharp-LH/CompactFlashDocumentation/arm/Sharp-LH/IOBarrierDocumentation/arm/Sharp-LH/KEV7A400Documentation/arm/Sharp-LH/LCDPanelsDocumentation/arm/Sharp-LH/LPD7A400Documentation/arm/Sharp-LH/LPD7A40XDocumentation/arm/Sharp-LH/SDRAMDocumentation/arm/Sharp-LH/VectoredInterruptControllerDocumentation/arm/VFP/release-notes.txtDocumentation/arm/nwfpe/NOTESDocumentation/arm/nwfpe/READMEDocumentation/arm/nwfpe/README.FPEDocumentation/arm/nwfpe/TODODocumentation/arm/pxa/Documentation/arm/pxa/mfp.txtDocumentation/auxdisplay/.gitignoreDocumentation/auxdisplay/MakefileDocumentation/auxdisplay/cfag12864bDocumentation/auxdisplay/cfag12864b-example.cDocumentation/auxdisplay/ks0108Documentation/bad_memory.txtDocumentation/blackfin/bfin-gpio-notes.txtDocumentation/block/data-integrity.txtDocumentation/block/queue-sysfs.txtDocumentation/braille-console.txtDocumentation/bt8xxgpio.txtDocumentation/c2port.txtDocumentation/cgroups/Documentation/cgroups/cgroups.txtDocumentation/cgroups/cpuacct.txtDocumentation/cgroups/cpusets.txtDocumentation/cgroups/devices.txtDocumentation/cgroups/freezer-subsystem.txtDocumentation/cgroups/memcg_test.txtDocumentation/cgroups/memory.txtDocumentation/cgroups/resource_counter.txtDocumentation/connector/.gitignoreDocumentation/connector/MakefileDocumentation/connector/cn_test.cDocumentation/connector/connector.txtDocumentation/connector/ucon.cDocumentation/console/console.txtDocumentation/cpu-freq/amd-powernow.txtDocumentation/cpu-freq/core.txtDocumentation/cpu-freq/cpu-drivers.txtDocumentation/cpu-freq/cpufreq-nforce2.txtDocumentation/cpu-freq/cpufreq-stats.txtDocumentation/cpu-freq/governors.txtDocumentation/cpu-freq/index.txtDocumentation/cpu-freq/user-guide.txtDocumentation/cpuidle/core.txtDocumentation/cpuidle/driver.txtDocumentation/cpuidle/governor.txtDocumentation/cpuidle/sysfs.txtDocumentation/credentials.txtDocumentation/cris/READMEDocumentation/crypto/api-intro.txtDocumentation/crypto/async-tx-api.txtDocumentation/crypto/descore-readme.txtDocumentation/debugging-via-ohci1394.txtDocumentation/development-process/1.IntroDocumentation/development-process/2.ProcessDocumentation/development-process/3.Early-stageDocumentation/development-process/4.CodingDocumentation/development-process/5.PostingDocumentation/development-process/6.FollowthroughDocumentation/development-process/7.AdvancedTopicsDocumentation/development-process/8.ConclusionDocumentation/device-mapper/delay.txtDocumentation/device-mapper/dm-crypt.txtDocumentation/device-mapper/dm-io.txtDocumentation/device-mapper/dm-uevent.txtDocumentation/device-mapper/kcopyd.txtDocumentation/device-mapper/linear.txtDocumentation/device-mapper/snapshot.txtDocumentation/device-mapper/striped.txtDocumentation/device-mapper/zero.txtDocumentation/dmaengine.txtDocumentation/driver-model/binding.txtDocumentation/driver-model/bus.txtDocumentation/driver-model/class.txtDocumentation/driver-model/device.txtDocumentation/driver-model/devres.txtDocumentation/driver-model/driver.txtDocumentation/driver-model/interface.txtDocumentation/driver-model/overview.txtDocumentation/driver-model/platform.txtDocumentation/driver-model/porting.txtDocumentation/dvb/README.dvb-usbDocumentation/dvb/README.flexcopDocumentation/dvb/avermedia.txtDocumentation/dvb/bt8xx.txtDocumentation/dvb/cards.txtDocumentation/dvb/ci.txtDocumentation/dvb/contributors.txtDocumentation/dvb/faq.txtDocumentation/dvb/get_dvb_firmwareDocumentation/dvb/opera-firmware.txtDocumentation/dvb/readme.txtDocumentation/dvb/technisat.txtDocumentation/dvb/ttusb-dec.txtDocumentation/dvb/udev.txtDocumentation/early-userspace/READMEDocumentation/early-userspace/buffer-format.txtDocumentation/email-clients.txtDocumentation/fault-injection/fault-injection.txtDocumentation/fb/cmap_xfbdev.txtDocumentation/fb/cyblafb/bugsDocumentation/fb/cyblafb/creditsDocumentation/fb/cyblafb/documentationDocumentation/fb/cyblafb/fb.modesDocumentation/fb/cyblafb/performanceDocumentation/fb/cyblafb/todoDocumentation/fb/cyblafb/usageDocumentation/fb/cyblafb/whatsnewDocumentation/fb/cyblafb/whycyblafbDocumentation/fb/gxfb.txtDocumentation/fb/lxfb.txtDocumentation/fb/metronomefb.txtDocumentation/fb/sh7760fb.txtDocumentation/fb/tridentfb.txtDocumentation/fb/uvesafb.txtDocumentation/fb/viafb.modesDocumentation/fb/viafb.txtDocumentation/filesystems/autofs4-mount-control.txtDocumentation/filesystems/btrfs.txtDocumentation/filesystems/configfs/MakefileDocumentation/filesystems/configfs/configfs.txtDocumentation/filesystems/configfs/configfs_example_explicit.cDocumentation/filesystems/configfs/configfs_example_macros.cDocumentation/filesystems/devpts.txtDocumentation/filesystems/fiemap.txtDocumentation/filesystems/gfs2-glocks.txtDocumentation/filesystems/nfs-rdma.txtDocumentation/filesystems/omfs.txtDocumentation/filesystems/quota.txtDocumentation/filesystems/squashfs.txtDocumentation/filesystems/ubifs.txtDocumentation/firmware_class/READMEDocumentation/firmware_class/hotplug-scriptDocumentation/frv/README.txtDocumentation/frv/atomic-ops.txtDocumentation/frv/booting.txtDocumentation/frv/clock.txtDocumentation/frv/configuring.txtDocumentation/frv/features.txtDocumentation/frv/gdbinitDocumentation/frv/gdbstub.txtDocumentation/frv/kernel-ABI.txtDocumentation/frv/mmu-layout.txtDocumentation/ftrace.txtDocumentation/hwmon/abituguruDocumentation/hwmon/abituguru-datasheetDocumentation/hwmon/abituguru3Documentation/hwmon/adm1021Documentation/hwmon/adm1025Documentation/hwmon/adm1026Documentation/hwmon/adm1031Documentation/hwmon/adm9240Documentation/hwmon/ads7828Documentation/hwmon/adt7462Documentation/hwmon/adt7470Documentation/hwmon/adt7473Documentation/hwmon/adt7475Documentation/hwmon/asb100Documentation/hwmon/coretempDocumentation/hwmon/dme1737Documentation/hwmon/ds1621Documentation/hwmon/f71805fDocumentation/hwmon/f71882fgDocumentation/hwmon/fscherDocumentation/hwmon/gl518smDocumentation/hwmon/hpfall.cDocumentation/hwmon/ibmaemDocumentation/hwmon/it87Documentation/hwmon/k8tempDocumentation/hwmon/lis3lv02dDocumentation/hwmon/lm63Documentation/hwmon/lm70Documentation/hwmon/lm75Documentation/hwmon/lm77Documentation/hwmon/lm78Documentation/hwmon/lm80Documentation/hwmon/lm83Documentation/hwmon/lm85Documentation/hwmon/lm87Documentation/hwmon/lm90Documentation/hwmon/lm92Documentation/hwmon/lm93Documentation/hwmon/ltc4245Documentation/hwmon/max1619Documentation/hwmon/max6650Documentation/hwmon/pc87360Documentation/hwmon/pc87427Documentation/hwmon/sis5595Documentation/hwmon/smsc47b397Documentation/hwmon/smsc47m1Documentation/hwmon/smsc47m192Documentation/hwmon/sysfs-interfaceDocumentation/hwmon/thmc50Documentation/hwmon/userspace-toolsDocumentation/hwmon/via686aDocumentation/hwmon/vt1211Documentation/hwmon/w83627ehfDocumentation/hwmon/w83627hfDocumentation/hwmon/w83781dDocumentation/hwmon/w83791dDocumentation/hwmon/w83792dDocumentation/hwmon/w83793Documentation/hwmon/w83l785tsDocumentation/hwmon/w83l786ngDocumentation/i2c/busses/Documentation/i2c/busses/i2c-ali1535Documentation/i2c/busses/i2c-ali1563Documentation/i2c/busses/i2c-ali15x3Documentation/i2c/busses/i2c-amd756Documentation/i2c/busses/i2c-amd8111Documentation/i2c/busses/i2c-i801Documentation/i2c/busses/i2c-nforce2Documentation/i2c/busses/i2c-ocoresDocumentation/i2c/busses/i2c-parportDocumentation/i2c/busses/i2c-parport-lightDocumentation/i2c/busses/i2c-pca-isaDocumentation/i2c/busses/i2c-piix4Documentation/i2c/busses/i2c-sis5595Documentation/i2c/busses/i2c-sis630Documentation/i2c/busses/i2c-sis96xDocumentation/i2c/busses/i2c-taos-evmDocumentation/i2c/busses/i2c-viaDocumentation/i2c/busses/i2c-viaproDocumentation/i2c/busses/i2c-voodoo3Documentation/i2c/busses/scx200_acbDocumentation/i2c/chips/Documentation/i2c/chips/eepromDocumentation/i2c/chips/max6875Documentation/i2c/chips/pca9539Documentation/i2c/chips/pcf8574Documentation/i2c/chips/pcf8575Documentation/i2c/chips/pcf8591Documentation/i2c/dev-interfaceDocumentation/i2c/fault-codesDocumentation/i2c/functionalityDocumentation/i2c/i2c-protocolDocumentation/i2c/i2c-stubDocumentation/i2c/smbus-protocolDocumentation/i2c/summaryDocumentation/i2c/ten-bit-addressesDocumentation/i2c/upgrading-clientsDocumentation/i2c/writing-clientsDocumentation/i2o/READMEDocumentation/i2o/ioctlDocumentation/ia64/.gitignoreDocumentation/ia64/IRQ-redir.txtDocumentation/ia64/MakefileDocumentation/ia64/READMEDocumentation/ia64/aliasing-test.cDocumentation/ia64/aliasing.txtDocumentation/ia64/efirtc.txtDocumentation/ia64/err_inject.txtDocumentation/ia64/fsys.txtDocumentation/ia64/kvm.txtDocumentation/ia64/mca.txtDocumentation/ia64/paravirt_ops.txtDocumentation/ia64/serial.txtDocumentation/ia64/xen.txtDocumentation/ics932s401Documentation/ide/Documentation/ide/warm-plug-howto.txtDocumentation/infiniband/core_locking.txtDocumentation/infiniband/ipoib.txtDocumentation/infiniband/sysfs.txtDocumentation/infiniband/user_mad.txtDocumentation/infiniband/user_verbs.txtDocumentation/input/amijoy.txtDocumentation/input/appletouch.txtDocumentation/input/atarikbd.txtDocumentation/input/cd32.txtDocumentation/input/cs461x.txtDocumentation/input/elantech.txtDocumentation/input/ff.txtDocumentation/input/gameport-programming.txtDocumentation/input/iforce-protocol.txtDocumentation/input/input-programming.txtDocumentation/input/input.txtDocumentation/input/interactive.figDocumentation/input/joystick-api.txtDocumentation/input/joystick-parport.txtDocumentation/input/joystick.txtDocumentation/input/notifier.txtDocumentation/input/shape.figDocumentation/input/walkera0701.txtDocumentation/input/xpad.txtDocumentation/input/yealink.txtDocumentation/io-mapping.txtDocumentation/isdn/HiSax.certDocumentation/isdn/INTERFACE.faxDocumentation/isdn/README.gigasetDocumentation/isdn/README.mISDNDocumentation/ja_JP/Documentation/ja_JP/HOWTODocumentation/ja_JP/SubmitChecklistDocumentation/ja_JP/SubmittingPatchesDocumentation/ja_JP/stable_api_nonsense.txtDocumentation/ja_JP/stable_kernel_rules.txtDocumentation/kdump/gdbmacros.txtDocumentation/kdump/kdump.txtDocumentation/ko_KR/Documentation/ko_KR/HOWTODocumentation/ko_KR/stable_api_nonsense.txtDocumentation/laptops/disk-shock-protection.txtDocumentation/lguest/Documentation/lguest/MakefileDocumentation/lguest/extractDocumentation/lguest/lguest.cDocumentation/lguest/lguest.txtDocumentation/lockstat.txtDocumentation/m68k/README.buddhaDocumentation/make/Documentation/make/headers_install.txtDocumentation/markers.txtDocumentation/mn10300/Documentation/mn10300/ABI.txtDocumentation/mn10300/compartmentalisation.txtDocumentation/mtd/Documentation/mtd/nand_ecc.txtDocumentation/namespaces/compatibility-list.txtDocumentation/networking/.gitignoreDocumentation/networking/3c359.txtDocumentation/networking/3c509.txtDocumentation/networking/LICENSE.qla3xxxDocumentation/networking/LICENSE.qlgeDocumentation/networking/MakefileDocumentation/networking/README.ipw2100Documentation/networking/README.ipw2200Documentation/networking/bonding.txtDocumentation/networking/cxgb.txtDocumentation/networking/dccp.txtDocumentation/networking/dl2k.txtDocumentation/networking/dm9000.txtDocumentation/networking/driver.txtDocumentation/networking/fib_trie.txtDocumentation/networking/gen_stats.txtDocumentation/networking/generic-hdlc.txtDocumentation/networking/gianfar.txtDocumentation/networking/ifenslave.cDocumentation/networking/ipvs-sysctl.txtDocumentation/networking/ixgb.txtDocumentation/networking/l2tp.txtDocumentation/networking/mac80211-injection.txtDocumentation/networking/mac80211_hwsim/Documentation/networking/mac80211_hwsim/READMEDocumentation/networking/mac80211_hwsim/hostapd.confDocumentation/networking/mac80211_hwsim/wpa_supplicant.confDocumentation/networking/multiqueue.txtDocumentation/networking/netconsole.txtDocumentation/networking/netif-msg.txtDocumentation/networking/operstates.txtDocumentation/networking/packet_mmap.txtDocumentation/networking/phonet.txtDocumentation/networking/phy.txtDocumentation/networking/pktgen.txtDocumentation/networking/ppp_generic.txtDocumentation/networking/proc_net_tcp.txtDocumentation/networking/radiotap-headers.txtDocumentation/networking/regulatory.txtDocumentation/networking/rxrpc.txtDocumentation/networking/s2io.txtDocumentation/networking/sctp.txtDocumentation/networking/secid.txtDocumentation/networking/spider_net.txtDocumentation/networking/tc-actions-env-rules.txtDocumentation/networking/tproxy.txtDocumentation/networking/udplite.txtDocumentation/networking/xfrm_proc.txtDocumentation/networking/xfrm_sync.txtDocumentation/networking/xfrm_sysctl.txtDocumentation/pcmcia/.gitignoreDocumentation/pcmcia/MakefileDocumentation/pcmcia/crc32hash.cDocumentation/pcmcia/devicetable.txtDocumentation/pcmcia/driver-changes.txtDocumentation/pcmcia/driver.txtDocumentation/power/regulator/Documentation/power/regulator/consumer.txtDocumentation/power/regulator/machine.txtDocumentation/power/regulator/overview.txtDocumentation/power/regulator/regulator.txtDocumentation/powerpc/bootwrapper.txtDocumentation/powerpc/dts-bindings/Documentation/powerpc/dts-bindings/4xx/Documentation/powerpc/dts-bindings/4xx/ndfc.txtDocumentation/powerpc/dts-bindings/fsl/Documentation/powerpc/dts-bindings/fsl/83xx-512x-pci.txtDocumentation/powerpc/dts-bindings/fsl/8xxx_gpio.txtDocumentation/powerpc/dts-bindings/fsl/board.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/Documentation/powerpc/dts-bindings/fsl/cpm_qe/cpm.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/cpm/Documentation/powerpc/dts-bindings/fsl/cpm_qe/cpm/brg.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/cpm/i2c.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/cpm/pic.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/cpm/usb.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/gpio.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/network.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/qe.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/qe/Documentation/powerpc/dts-bindings/fsl/cpm_qe/qe/firmware.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/qe/par_io.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/qe/pincfg.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/qe/ucc.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/qe/usb.txtDocumentation/powerpc/dts-bindings/fsl/cpm_qe/serial.txtDocumentation/powerpc/dts-bindings/fsl/diu.txtDocumentation/powerpc/dts-bindings/fsl/dma.txtDocumentation/powerpc/dts-bindings/fsl/gtm.txtDocumentation/powerpc/dts-bindings/fsl/guts.txtDocumentation/powerpc/dts-bindings/fsl/i2c.txtDocumentation/powerpc/dts-bindings/fsl/lbc.txtDocumentation/powerpc/dts-bindings/fsl/mcu-mpc8349emitx.txtDocumentation/powerpc/dts-bindings/fsl/mpc5200.txtDocumentation/powerpc/dts-bindings/fsl/msi-pic.txtDocumentation/powerpc/dts-bindings/fsl/pmc.txtDocumentation/powerpc/dts-bindings/fsl/sata.txtDocumentation/powerpc/dts-bindings/fsl/sec.txtDocumentation/powerpc/dts-bindings/fsl/spi.txtDocumentation/powerpc/dts-bindings/fsl/ssi.txtDocumentation/powerpc/dts-bindings/fsl/tsec.txtDocumentation/powerpc/dts-bindings/fsl/upm-nand.txtDocumentation/powerpc/dts-bindings/fsl/usb.txtDocumentation/powerpc/dts-bindings/gpio/Documentation/powerpc/dts-bindings/gpio/led.txtDocumentation/powerpc/kvm_440.txtDocumentation/powerpc/phyp-assisted-dump.txtDocumentation/prctl/Documentation/prctl/disable-tsc-ctxt-sw-stress-test.cDocumentation/prctl/disable-tsc-on-off-stress-test.cDocumentation/prctl/disable-tsc-test.cDocumentation/rfkill.txtDocumentation/s390/kvm.txtDocumentation/s390/zfcpdump.txtDocumentation/scsi/advansys.txtDocumentation/scsi/cxgb3i.txtDocumentation/scsi/link_power_management_policy.txtDocumentation/serial/driverDocumentation/sh/clk.txtDocumentation/sh/new-machine.txtDocumentation/sh/register-banks.txtDocumentation/sound/alsa/Documentation/sound/alsa/ALSA-Configuration.txtDocumentation/sound/alsa/Audigy-mixer.txtDocumentation/sound/alsa/Audiophile-Usb.txtDocumentation/sound/alsa/Bt87x.txtDocumentation/sound/alsa/CMIPCI.txtDocumentation/sound/alsa/ControlNames.txtDocumentation/sound/alsa/DocBook/Documentation/sound/alsa/DocBook/alsa-driver-api.tmplDocumentation/sound/alsa/DocBook/writing-an-alsa-driver.tmplDocumentation/sound/alsa/HD-Audio-Models.txtDocumentation/sound/alsa/HD-Audio.txtDocumentation/sound/alsa/Joystick.txtDocumentation/sound/alsa/MIXART.txtDocumentation/sound/alsa/OSS-Emulation.txtDocumentation/sound/alsa/Procfile.txtDocumentation/sound/alsa/SB-Live-mixer.txtDocumentation/sound/alsa/VIA82xx-mixer.txtDocumentation/sound/alsa/emu10k1-jack.txtDocumentation/sound/alsa/hda_codec.txtDocumentation/sound/alsa/hdspm.txtDocumentation/sound/alsa/powersave.txtDocumentation/sound/alsa/seq_oss.htmlDocumentation/sound/alsa/serial-u16550.txtDocumentation/sound/alsa/soc/Documentation/sound/alsa/soc/DAI.txtDocumentation/sound/alsa/soc/clocking.txtDocumentation/sound/alsa/soc/codec.txtDocumentation/sound/alsa/soc/dapm.txtDocumentation/sound/alsa/soc/machine.txtDocumentation/sound/alsa/soc/overview.txtDocumentation/sound/alsa/soc/platform.txtDocumentation/sound/alsa/soc/pops_clicks.txtDocumentation/sound/oss/Documentation/sound/oss/ALSDocumentation/sound/oss/AudioExcelDSP16Documentation/sound/oss/CMI8330Documentation/sound/oss/CS4232Documentation/sound/oss/ESSDocumentation/sound/oss/ESS1868Documentation/sound/oss/IntroductionDocumentation/sound/oss/MultiSoundDocumentation/sound/oss/OPL3Documentation/sound/oss/OptiDocumentation/sound/oss/PAS16Documentation/sound/oss/PSSDocumentation/sound/oss/PSS-updatesDocumentation/sound/oss/README.OSSDocumentation/sound/oss/README.modulesDocumentation/sound/oss/README.ymfsbDocumentation/sound/oss/SoundProDocumentation/sound/oss/SoundblasterDocumentation/sound/oss/Tropez+Documentation/sound/oss/VIBRA16Documentation/sound/oss/WaveArtistDocumentation/sound/oss/btaudioDocumentation/sound/oss/mwaveDocumentation/sound/oss/ultrasoundDocumentation/sound/oss/vwsndDocumentation/sparc/README-2.5Documentation/spi/.gitignoreDocumentation/spi/MakefileDocumentation/spi/butterflyDocumentation/spi/pxa2xxDocumentation/spi/spi-lm70llpDocumentation/spi/spi-summaryDocumentation/spi/spidevDocumentation/spi/spidev_fdx.cDocumentation/spi/spidev_test.cDocumentation/thermal/Documentation/thermal/sysfs-api.txtDocumentation/tracepoints.txtDocumentation/tracers/Documentation/tracers/mmiotrace.txtDocumentation/uml/UserModeLinux-HOWTO.txtDocumentation/unaligned-memory-access.txtDocumentation/usb/CREDITSDocumentation/usb/URB.txtDocumentation/usb/WUSB-Design-overview.txtDocumentation/usb/acm.txtDocumentation/usb/anchors.txtDocumentation/usb/authorization.txtDocumentation/usb/callbacks.txtDocumentation/usb/dma.txtDocumentation/usb/ehci.txtDocumentation/usb/error-codes.txtDocumentation/usb/gadget_printer.txtDocumentation/usb/gadget_serial.txtDocumentation/usb/hiddev.txtDocumentation/usb/hotplug.txtDocumentation/usb/iuu_phoenix.txtDocumentation/usb/linux.infDocumentation/usb/misc_usbsevseg.txtDocumentation/usb/mtouchusb.txtDocumentation/usb/ohci.txtDocumentation/usb/persist.txtDocumentation/usb/power-management.txtDocumentation/usb/proc_usb_info.txtDocumentation/usb/rio.txtDocumentation/usb/usb-help.txtDocumentation/usb/usb-serial.txtDocumentation/usb/usbmon.txtDocumentation/usb/wusb-cbafDocumentation/video4linux/.gitignoreDocumentation/video4linux/API.htmlDocumentation/video4linux/CARDLIST.au0828Documentation/video4linux/CARDLIST.bttvDocumentation/video4linux/CARDLIST.cx23885Documentation/video4linux/CARDLIST.cx88Documentation/video4linux/CARDLIST.em28xxDocumentation/video4linux/CARDLIST.ivtvDocumentation/video4linux/CARDLIST.saa7134Documentation/video4linux/CARDLIST.tunerDocumentation/video4linux/CARDLIST.usbvisionDocumentation/video4linux/CQcam.txtDocumentation/video4linux/MakefileDocumentation/video4linux/README.cpiaDocumentation/video4linux/README.cpia2Documentation/video4linux/README.cx88Documentation/video4linux/README.irDocumentation/video4linux/README.ivtvDocumentation/video4linux/README.pvrusb2Documentation/video4linux/README.saa7134Documentation/video4linux/ZoranDocumentation/video4linux/bttv/Documentation/video4linux/bttv/CONTRIBUTORSDocumentation/video4linux/bttv/CardsDocumentation/video4linux/bttv/ICsDocumentation/video4linux/bttv/Insmod-optionsDocumentation/video4linux/bttv/MAKEDEVDocumentation/video4linux/bttv/Modprobe.confDocumentation/video4linux/bttv/Modules.confDocumentation/video4linux/bttv/PROBLEMSDocumentation/video4linux/bttv/READMEDocumentation/video4linux/bttv/README.WINVIEWDocumentation/video4linux/bttv/README.freezeDocumentation/video4linux/bttv/README.quirksDocumentation/video4linux/bttv/Sound-FAQDocumentation/video4linux/bttv/SpecsDocumentation/video4linux/bttv/THANKSDocumentation/video4linux/bttv/TunersDocumentation/video4linux/cafe_ccicDocumentation/video4linux/cpia2_overview.txtDocumentation/video4linux/cx18.txtDocumentation/video4linux/cx2341x/Documentation/video4linux/cx2341x/README.hm12Documentation/video4linux/cx2341x/README.vbiDocumentation/video4linux/cx2341x/fw-calling.txtDocumentation/video4linux/cx2341x/fw-decoder-api.txtDocumentation/video4linux/cx2341x/fw-decoder-regs.txtDocumentation/video4linux/cx2341x/fw-dma.txtDocumentation/video4linux/cx2341x/fw-encoder-api.txtDocumentation/video4linux/cx2341x/fw-memory.txtDocumentation/video4linux/cx2341x/fw-osd-api.txtDocumentation/video4linux/cx2341x/fw-upload.txtDocumentation/video4linux/cx88/Documentation/video4linux/cx88/hauppauge-wintv-cx88-ir.txtDocumentation/video4linux/et61x251.txtDocumentation/video4linux/extract_xc3028.plDocumentation/video4linux/gspca.txtDocumentation/video4linux/hauppauge-wintv-cx88-ir.txtDocumentation/video4linux/ibmcam.txtDocumentation/video4linux/lifeview.txtDocumentation/video4linux/m5602.txtDocumentation/video4linux/meye.txtDocumentation/video4linux/not-in-cx2388x-datasheet.txtDocumentation/video4linux/ov511.txtDocumentation/video4linux/radiotrack.txtDocumentation/video4linux/se401.txtDocumentation/video4linux/si470x.txtDocumentation/video4linux/sn9c102.txtDocumentation/video4linux/soc-camera.txtDocumentation/video4linux/stv680.txtDocumentation/video4linux/v4l2-framework.txtDocumentation/video4linux/v4lgrab.cDocumentation/video4linux/w9966.txtDocumentation/video4linux/w9968cf.txtDocumentation/video4linux/zc0301.txtDocumentation/video4linux/zr364xx.txtDocumentation/vm/.gitignoreDocumentation/vm/MakefileDocumentation/vm/pagemap.txtDocumentation/vm/unevictable-lru.txtDocumentation/w1/masters/mxc-w1Documentation/w1/masters/omap-hdqDocumentation/watchdog/src/.gitignoreDocumentation/watchdog/src/MakefileDocumentation/watchdog/src/watchdog-simple.cDocumentation/watchdog/src/watchdog-test.cDocumentation/wimax/Documentation/wimax/README.i2400mDocumentation/wimax/README.wimaxDocumentation/x86/Documentation/x86/boot.txtDocumentation/x86/i386/IO-APIC.txtDocumentation/x86/pat.txtDocumentation/x86/usb-legacy-support.txtDocumentation/x86/zero-page.txtDocumentation/zh_CN/Documentation/zh_CN/CodingStyleDocumentation/zh_CN/HOWTODocumentation/zh_CN/SubmittingDriversDocumentation/zh_CN/SubmittingPatchesDocumentation/zh_CN/oops-tracing.txtDocumentation/zh_CN/sparse.txtDocumentation/zh_CN/stable_api_nonsense.txtDocumentation/zh_CN/stable_kernel_rules.txtDocumentation/zh_CN/volatile-considered-harmful.txt\0ÿôèº{.nÇ+‰·Ÿ®‰­†+%ŠËÿ±éݶ\x17¥Šwÿº{.nÇ+‰·¥Š{±þG«éÿŠ{ayº\x1dʇڙë,j\a­¢f£¢·hšïêÿ‘êçz_è®\x03(­éšŽŠÝ¢j"ú\x1a¶^[m§ÿÿ¾\a«þG«éÿ¢¸?™¨è­Ú&£ø§~á¶iO•æ¬z·švØ^\x14\x04\x1a¶^[m§ÿÿÃ\fÿ¶ìÿ¢¸?–I¥

Re: Documentation:Update the INDEX of the documents

[Theodore Tso]

On Wed, Feb 25, 2009 at 03:16:59PM +0800, Yang Hongyang wrote:
> There are so many 00-INDEX file that are missing description of the
> current files in the dir.  Such as 00-INDEX in
> Documentation/x86/,Documentation/networking/,Documentation/ and so
> on.
> 
> It's a large amount of work for someone to go through all these
> documents and make summaries.
> 
> I'm willing to do some of the work but if someone else pick these
> up(especially the authors of these new files) it will be a great
> help.^_^

Before you embark on this large amount of work, we should probably ask
a question first --- how useful are the 00-INDEX files?  I don't find
them particularly interesting, given that my normal way of finding
documentation in the Documentation directory is:

find . -type f | xargs grep <keyword>

Or, if I have a git tree of the Linux sources handy:

git grep <keyword> -- Documentation

If folks do find the 00-INDEX files useful, my suggestion would be to
make a way of automatically extracting them from the individual files
and/or directories, and then making the 00-INDEX files to be
automatically generated.

						- Ted

Re: Documentation:Update the INDEX of the documents

[Yang Hongyang]

On Wed, Feb 25, 2009 at 10:59 PM, Theodore Tso <tytso@mit.edu> wrote:
> On Wed, Feb 25, 2009 at 03:16:59PM +0800, Yang Hongyang wrote:
>> There are so many 00-INDEX file that are missing description of the
>> current files in the dir.  Such as 00-INDEX in
>> Documentation/x86/,Documentation/networking/,Documentation/ and so
>> on.
>>
>> It's a large amount of work for someone to go through all these
>> documents and make summaries.
>>
>> I'm willing to do some of the work but if someone else pick these
>> up(especially the authors of these new files) it will be a great
>> help.^_^
>
> Before you embark on this large amount of work, we should probably ask
> a question first --- how useful are the 00-INDEX files?  I don't find
> them particularly interesting, given that my normal way of finding
> documentation in the Documentation directory is:
>
> find . -type f | xargs grep <keyword>
>
> Or, if I have a git tree of the Linux sources handy:
>
> git grep <keyword> -- Documentation
>
> If folks do find the 00-INDEX files useful, my suggestion would be to
> make a way of automatically extracting them from the individual files
> and/or directories, and then making the 00-INDEX files to be
> automatically generated.

Sounds a good idea to me.If nobody interested in the 00-INDEX files,
just remove it.

>
>                                                - Ted
> --
> 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/
>

Re: Documentation:Update the INDEX of the documents

[Yang Hongyang]

On Wed, Feb 25, 2009 at 10:59 PM, Theodore Tso <tytso@mit.edu> wrote:
> On Wed, Feb 25, 2009 at 03:16:59PM +0800, Yang Hongyang wrote:
>> There are so many 00-INDEX file that are missing description of the
>> current files in the dir.  Such as 00-INDEX in
>> Documentation/x86/,Documentation/networking/,Documentation/ and so
>> on.
>>
>> It's a large amount of work for someone to go through all these
>> documents and make summaries.
>>
>> I'm willing to do some of the work but if someone else pick these
>> up(especially the authors of these new files) it will be a great
>> help.^_^
>
> Before you embark on this large amount of work, we should probably ask
> a question first --- how useful are the 00-INDEX files?  I don't find
> them particularly interesting, given that my normal way of finding
> documentation in the Documentation directory is:

I think the 00-INDEX files is used to generate the html files.

>
> find . -type f | xargs grep <keyword>
>
> Or, if I have a git tree of the Linux sources handy:
>
> git grep <keyword> -- Documentation
>
> If folks do find the 00-INDEX files useful, my suggestion would be to
> make a way of automatically extracting them from the individual files
> and/or directories, and then making the 00-INDEX files to be
> automatically generated.

Sounds like a good idea but How to automatically generate
 the summaries then?

>
>                                                - Ted
> --
> 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/
>

Re: Documentation:Update the INDEX of the documents

[Theodore Tso]

On Wed, Feb 25, 2009 at 11:25:08PM +0800, Yang Hongyang wrote:
> > If folks do find the 00-INDEX files useful, my suggestion would be to
> > make a way of automatically extracting them from the individual files
> > and/or directories, and then making the 00-INDEX files to be
> > automatically generated.
> 
> Sounds like a good idea but How to automatically generate
>  the summaries then?

Well, for text files (including subdirectory's 00-INDEX files) we
could have a convention which is the first line of the file should be
a (max 60 characters) one-line summary of the file.

We would probably have to do something special with non-free-form-text
files, including structured text files like Docbook files.  So it's
not quite so straightforward, but it should be doable.

    	     		      	     	       - Ted

Re: Documentation:Update the INDEX of the documents

[Yang Hongyang]

Theodore Tso wrote:
> On Wed, Feb 25, 2009 at 11:25:08PM +0800, Yang Hongyang wrote:
>>> If folks do find the 00-INDEX files useful, my suggestion would be to
>>> make a way of automatically extracting them from the individual files
>>> and/or directories, and then making the 00-INDEX files to be
>>> automatically generated.
>> Sounds like a good idea but How to automatically generate
>>  the summaries then?
> 
> Well, for text files (including subdirectory's 00-INDEX files) we
> could have a convention which is the first line of the file should be
> a (max 60 characters) one-line summary of the file.
> 
> We would probably have to do something special with non-free-form-text
> files, including structured text files like Docbook files.  So it's
> not quite so straightforward, but it should be doable.

Yeah,if we do this one-line summary thing,we still have to go through
all these documents.So why not just update the 00-INDEX and then tell
the authors that will add docs to the kernel do the "00-INDEX work"
 themselves?

> 
>     	     		      	     	       - Ted
> 
> 


-- 
Regards
Yang Hongyang

Re: Documentation:Update the INDEX of the documents

[Randy Dunlap]

Yang Hongyang wrote:
> Theodore Tso wrote:
>> On Wed, Feb 25, 2009 at 11:25:08PM +0800, Yang Hongyang wrote:
>>>> If folks do find the 00-INDEX files useful, my suggestion would be to
>>>> make a way of automatically extracting them from the individual files
>>>> and/or directories, and then making the 00-INDEX files to be
>>>> automatically generated.
>>> Sounds like a good idea but How to automatically generate
>>>  the summaries then?
>> Well, for text files (including subdirectory's 00-INDEX files) we
>> could have a convention which is the first line of the file should be
>> a (max 60 characters) one-line summary of the file.
>>
>> We would probably have to do something special with non-free-form-text
>> files, including structured text files like Docbook files.  So it's
>> not quite so straightforward, but it should be doable.
> 
> Yeah,if we do this one-line summary thing,we still have to go through
> all these documents.So why not just update the 00-INDEX and then tell
> the authors that will add docs to the kernel do the "00-INDEX work"
>  themselves?

I doubt that the 00-INDEX files are that useful...


-- 
~Randy

Re: Documentation:Update the INDEX of the documents

[Yang Hongyang]

Randy Dunlap wrote:
> Yang Hongyang wrote:
>> Theodore Tso wrote:
>>> On Wed, Feb 25, 2009 at 11:25:08PM +0800, Yang Hongyang wrote:
>>>>> If folks do find the 00-INDEX files useful, my suggestion would be to
>>>>> make a way of automatically extracting them from the individual files
>>>>> and/or directories, and then making the 00-INDEX files to be
>>>>> automatically generated.
>>>> Sounds like a good idea but How to automatically generate
>>>>  the summaries then?
>>> Well, for text files (including subdirectory's 00-INDEX files) we
>>> could have a convention which is the first line of the file should be
>>> a (max 60 characters) one-line summary of the file.
>>>
>>> We would probably have to do something special with non-free-form-text
>>> files, including structured text files like Docbook files.  So it's
>>> not quite so straightforward, but it should be doable.
>> Yeah,if we do this one-line summary thing,we still have to go through
>> all these documents.So why not just update the 00-INDEX and then tell
>> the authors that will add docs to the kernel do the "00-INDEX work"
>>  themselves?
> 
> I doubt that the 00-INDEX files are that useful...
> 
> 

I think it depends on the individual^_^

-- 
Regards
Yang Hongyang

Re: Documentation:Update the INDEX of the documents

[Theodore Tso]

On Thu, Feb 26, 2009 at 08:49:48AM +0800, Yang Hongyang wrote:
> Yeah ,if we do this one-line summary thing,we still have to go through
> all these documents. So why not just update the 00-INDEX and then tell
> the authors that will add docs to the kernel do the "00-INDEX work"
>  themselves?

The difference is that if we go through the documents, it's something
we do *once*.  And after the convention has been established, in the
long term, it should be less work for all concerned.

     	      	     	     	      	  - Ted

Re: Documentation:Update the INDEX of the documents

[Rob Landley]

On Wednesday 25 February 2009 20:37:14 Theodore Tso wrote:
> On Thu, Feb 26, 2009 at 08:49:48AM +0800, Yang Hongyang wrote:
> > Yeah ,if we do this one-line summary thing,we still have to go through
> > all these documents. So why not just update the 00-INDEX and then tell
> > the authors that will add docs to the kernel do the "00-INDEX work"
> >  themselves?
>
> The difference is that if we go through the documents, it's something
> we do *once*.  And after the convention has been established, in the
> long term, it should be less work for all concerned.

I envy your optimisim.

Rob

Re: Documentation:Update the INDEX of the documents

[Rob Landley]

On Wednesday 25 February 2009 08:59:50 Theodore Tso wrote:
> On Wed, Feb 25, 2009 at 03:16:59PM +0800, Yang Hongyang wrote:
> > There are so many 00-INDEX file that are missing description of the
> > current files in the dir.  Such as 00-INDEX in
> > Documentation/x86/,Documentation/networking/,Documentation/ and so
> > on.
> >
> > It's a large amount of work for someone to go through all these
> > documents and make summaries.
> >
> > I'm willing to do some of the work but if someone else pick these
> > up(especially the authors of these new files) it will be a great
> > help.^_^
>
> Before you embark on this large amount of work, we should probably ask
> a question first --- how useful are the 00-INDEX files?  I don't find
> them particularly interesting, given that my normal way of finding
> documentation in the Documentation directory is:
>
> find . -type f | xargs grep <keyword>
>
> Or, if I have a git tree of the Linux sources handy:
>
> git grep <keyword> -- Documentation
>
> If folks do find the 00-INDEX files useful, my suggestion would be to
> make a way of automatically extracting them from the individual files
> and/or directories, and then making the 00-INDEX files to be
> automatically generated.

I have a script that automatically generates html indexes from them for 
http://kernel.org/doc/Documentation which is at least a use. :)

I'd be happy to generate those html indexes from something else, but there 
isn't an obvious reliable source of single line comments in the files 
themselves.  For a lot of 'em you can take the first nonblank line and ignore 
things like the trailing colon in unshare.txt, and maybe you could even 
automatically ignore things like the sentence fragment at the end of kref.txt.

But what do you do about the first like of IRQ-affinity.txt being 
"ChangeLog:", or hw_random.txt starting with "Introduction:"?  (And of course 
logo.gif isn't a text file.  And we haven't even gotten to the 
subdirectories...)

Rob