Documentation/00-INDEX: fix typo
PATCH 1/4 Documentation/00-INDEX: fix typo
--- Documentation/00-INDEX | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
Documentation/00-INDEX +1 -1
@@ -71,7 +71,7 @@ atomic_ops.txt auxdisplay/ - misc. LCD driver documentation (cfag12864b, ks0108). basic_profiling.txt - - basic instructions for those who wants to profile Linux kernel. + - basic instructions for those who want to profile Linux kernel. binfmt_misc.txt - info on the kernel support for extra binary formats. blackfin/
Signature · 1 line
1.7.4.4
PATCH 2/4 Documentation/00-INDEX: improve description for sh/
--- Documentation/00-INDEX | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
Documentation/00-INDEX +1 -1
@@ -303,7 +303,7 @@ sgi-ioc4.txt sgi-visws.txt - short blurb on the SGI Visual Workstations. sh/ - - directory with info on porting Linux to a new architecture. + - directory with info on adding new boards to LinuxSH. sound/ - directory with info on sound card support. sparc/
Signature · 1 line
1.7.4.4
Re: [PATCH 2/4] Documentation/00-INDEX: improve description for sh/
Quoted 1 line · On Sat, 23 Apr 2011 18:15:42 +0200 Cyril Brulebois wrote:
Signed-off-by Cyril Brulebois <[email protected]>
Thanks.
Quoted 10 lines
--- Documentation/00-INDEX | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)Documentation/00-INDEX +0
-0
Documentation/00-INDEX sgi-ioc4.txt · line 309
Quoted 8 lines
Documentation/00-INDEX +1
-1@@ -303,7 +303,7 @@ sgi-ioc4.txt sgi-visws.txt - short blurb on the SGI Visual Workstations. sh/ - - directory with info on porting Linux to a new architecture. + - directory with info on adding new boards to LinuxSH. sound/ - directory with info on sound card support. sparc/
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
PATCH 3/4 Documentation/00-INDEX.sh: add script to help keeping the index up-to-date
In reply to Cyril Brulebois--- Documentation/00-INDEX.sh | 24 ++++++++++++++++++++++++ 1 files changed, 24 insertions(+), 0 deletions(-) create mode 100755 Documentation/00-INDEX.sh
Documentation/00-INDEX.sh new file +24 -0
@@ -0,0 +1,24 @@ +#!/bin/sh +# Copyright 2011 Cyril Brulebois <[email protected]> +# +# Try and keep the 00-INDEX file up-to-date. + +# List all entries below the 00-INDEX entry: +documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -v '^\s'|sed 's,/$,,') + +# List all files/directories except 00-INDEX* and Makefile: +present=$(ls -1|grep -v '^00-INDEX'|grep -v '^Makefile$') + +echo "Undocumented:" +for i in $present; do + if ! echo "$documented"|grep -qs "\<$i\>"; then + echo " $i" + fi +done + +echo "Documented but missing:" +for i in $documented; do + if [ ! -e $i ]; then + echo " $i" + fi +done
Signature · 1 line
1.7.4.4
Re: [PATCH 3/4] Documentation/00-INDEX.sh: add script to help keeping the index up-to-date
Quoted 27 lines · On Sat, 23 Apr 2011 18:15:43 +0200 Cyril Brulebois wrote:
Signed-off-by Cyril Brulebois <[email protected]>--- Documentation/00-INDEX.sh | 24 ++++++++++++++++++++++++ 1 files changed, 24 insertions(+), 0 deletions(-) create mode 100755 Documentation/00-INDEX.shDocumentation/00-INDEX.sh new file +14
-0@@ -0,0 +1,24 @@ +#!/bin/sh +# Copyright 2011 Cyril Brulebois <[email protected]> +# +# Try and keep the 00-INDEX file up-to-date. + +# List all entries below the 00-INDEX entry: +documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -v '^\s'|sed 's,/$,,') + +# List all files/directories except 00-INDEX* and Makefile: +present=$(ls -1|grep -v '^00-INDEX'|grep -v '^Makefile$') + +echo "Undocumented:" +for i in $present; do + if ! echo "$documented"|grep -qs "\<$i\>"; then
Documentation/00-INDEX.sh line 24
Quoted 10 lines
Documentation/00-INDEX.sh new file +10
-0+ echo " $i" + fi +done + +echo "Documented but missing:" +for i in $documented; do + if [ ! -e $i ]; then + echo " $i" + fi +done
Good idea, thanks.
but what am I doing wrong?
cd Documentation
sh ./00-INDEX.sh
The "undocumented" list looks correct (well, it could omit .orig files), but the "Documented but missing" list contains words, e.g.:
-
this
file.
-
info
on
kernel
<->
userspace
and
relative
interface
stability.
-
brute
force
method
of
doing
binary
search
of
patches
on and on and on ...
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
Re: [PATCH 3/4] Documentation/00-INDEX.sh: add script to help keeping the index up-to-date
Randy Dunlap <[email protected]> (23/04/2011):
Quoted 7 lines
but what am I doing wrong?
cd Documentation
sh ./00-INDEX.shThe "undocumented" list looks correct (well, it could omit .orig files), but the "Documented but missing" list contains words, e.g.:
Looks like sed's not filtering out lines before '00-INDEX'; my reading of POSIX sed specification[1] would seem to confirm the filtering should work, see:
[2addr]d
Delete the pattern space and start the next cycle.
1. http://pubs.opengroup.org/onlinepubs/007908799/xcu/sed.html
Maybe some regex fun then; what if you remove the anchors (^ and $)?
And anyway, using sed --posix to disable all GNU extensions gives the expected output here (with GNU sed version 4.2.1).
What's your sed/system, so that I can check what's going on there, and how to deal with it?
Using 'grep -A $ABIGNUMBER' could be a workaround I guess, but a ugly one…
KiBi.
Re: [PATCH 3/4] Documentation/00-INDEX.sh: add script to help keeping the index up-to-date
Quoted 17 lines · On Sat, 23 Apr 2011 19:15:22 +0200 Cyril Brulebois wrote:
Randy Dunlap <[email protected]> (23/04/2011):
Quoted 7 lines
but what am I doing wrong?
cd Documentation
sh ./00-INDEX.shThe "undocumented" list looks correct (well, it could omit .orig files), but the "Documented but missing" list contains words, e.g.:
Looks like sed's not filtering out lines before '00-INDEX'; my reading of POSIX sed specification[1] would seem to confirm the filtering should work, see:
[2addr]d
Delete the pattern space and start the next cycle.1. http://pubs.opengroup.org/onlinepubs/007908799/xcu/sed.html
Quoted 7 lines
Maybe some regex fun then; what if you remove the anchors (^ and $)?
And anyway, using sed --posix to disable all GNU extensions gives the expected output here (with GNU sed version 4.2.1).
What's your sed/system, so that I can check what's going on there, and how to deal with it?
Fedora 11 and
Quoted 1 line
sed --version
GNU sed version 4.2.1
Quoted 2 lines
Using 'grep -A $ABIGNUMBER' could be a workaround I guess, but a ugly one…
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
Re: [PATCH 3/4] Documentation/00-INDEX.sh: add script to help keeping the index up-to-date
In reply to Randy DunlapRandy Dunlap <[email protected]> (23/04/2011):
Quoted 3 lines
The "undocumented" list looks correct (well, it could omit .orig files), but the "Documented but missing" list contains words, e.g.:
[…]
One coffee later… Looks like your grep is behaving as if "grep -F" was passed; that might be better with an explicit "grep -G" (which is the default), see patch below?
Documentation/00-INDEX.sh +1 -1
@@ -4,7 +4,7 @@ # Try and keep the 00-INDEX file up-to-date. # List all entries below the 00-INDEX entry: -documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -v '^\s'|sed 's,/$,,') +documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -G -v '^\s'|sed 's,/$,,') # List all files/directories except 00-INDEX* and Makefile: present=$(ls -1|grep -v '^00-INDEX'|grep -v '^Makefile$')
Maybe some grep alias in your environment? I couldn't reproduce the behaviour you mentioned even using (unpack+PATH+LD_LIBRARY_PATH) pcre-7.8-2.fc11.ppc.rpm and sed-4.2.1-1.fc11.ppc.rpm, until I tried various options like passing -F to grep.
KiBi.
Re: [PATCH 3/4] Documentation/00-INDEX.sh: add script to help keeping the index up-to-date
Quoted 8 lines · On Sat, 23 Apr 2011 23:05:37 +0200 Cyril Brulebois wrote:
Randy Dunlap <[email protected]> (23/04/2011):
Quoted 3 lines
The "undocumented" list looks correct (well, it could omit .orig files), but the "Documented but missing" list contains words, e.g.:
[…]One coffee later… Looks like your grep is behaving as if "grep -F" was passed; that might be better with an explicit "grep -G" (which is the default), see patch below?
Sorry, this patch didn't help (did not change the output).
Quoted 15 lines
Documentation/00-INDEX.sh +1
-1@@ -4,7 +4,7 @@ # Try and keep the 00-INDEX file up-to-date. # List all entries below the 00-INDEX entry: -documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -v '^\s'|sed 's,/$,,') +documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -G -v '^\s'|sed 's,/$,,') # List all files/directories except 00-INDEX* and Makefile: present=$(ls -1|grep -v '^00-INDEX'|grep -v '^Makefile$')
Quoted 4 lines
Maybe some grep alias in your environment? I couldn't reproduce the behaviour you mentioned even using (unpack+PATH+LD_LIBRARY_PATH) pcre-7.8-2.fc11.ppc.rpm and sed-4.2.1-1.fc11.ppc.rpm, until I tried various options like passing -F to grep.
I couldn't find any grep alias, but I changed "grep" in 00-INDEX.sh to "/bin/grep" anyway, and still got the same results.
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
Re: [PATCH 3/4] Documentation/00-INDEX.sh: add script to help keeping the index up-to-date
Quoted 28 lines · On Sun, 24 Apr 2011 11:58:11 -0700 Randy Dunlap wrote:
Quoted 8 lines · On Sat, 23 Apr 2011 23:05:37 +0200 Cyril Brulebois wrote:
Randy Dunlap <[email protected]> (23/04/2011):
Quoted 3 lines
The "undocumented" list looks correct (well, it could omit .orig files), but the "Documented but missing" list contains words, e.g.:
[…]One coffee later… Looks like your grep is behaving as if "grep -F" was passed; that might be better with an explicit "grep -G" (which is the default), see patch below?
Sorry, this patch didn't help (did not change the output).
Quoted 15 lines
Documentation/00-INDEX.sh +1
-1@@ -4,7 +4,7 @@ # Try and keep the 00-INDEX file up-to-date. # List all entries below the 00-INDEX entry: -documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -v '^\s'|sed 's,/$,,') +documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -G -v '^\s'|sed 's,/$,,') # List all files/directories except 00-INDEX* and Makefile: present=$(ls -1|grep -v '^00-INDEX'|grep -v '^Makefile$')
Quoted 7 lines
Quoted 4 lines
Maybe some grep alias in your environment? I couldn't reproduce the behaviour you mentioned even using (unpack+PATH+LD_LIBRARY_PATH) pcre-7.8-2.fc11.ppc.rpm and sed-4.2.1-1.fc11.ppc.rpm, until I tried various options like passing -F to grep.
I couldn't find any grep alias, but I changed "grep" in
00-INDEX.shto "/bin/grep" anyway, and still got the same results.
ad I don't see any environment variables that would affect grep either.
Anyway, using this line instead of any one of the lines above works for me:
documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -G -v ^[[:space:]]|sed 's:/$::')
i.e., use ^[[:space:]] instead of the (original) '^\s'.
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
Re: [PATCH 3/4] Documentation/00-INDEX.sh: add script to help keeping the index up-to-date
Randy Dunlap <[email protected]> (26/04/2011):
Quoted 7 lines
ad I don't see any environment variables that would affect grep either.
Anyway, using this line instead of any one of the lines above works for me:
documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -G -v ^[[:space:]]|sed 's:/$::')
i.e., use ^[[:space:]] instead of the (original) '^\s'.
Hm, I still can't reproduce your original issue, even with a Fedora 11 system; but anyway, using [[:space:]] looks good. In the upcoming patch I'm also dropping -G: It's the default for GNU grep, and it's not POSIX-documented[1] anyway.
1. http://pubs.opengroup.org/onlinepubs/009695399/utilities/grep.html
Thanks, and sorry for the extra round-trips for such a simple patch.
KiBi.
PATCH v2 3/4 Documentation/00-INDEX.sh: add script to help keeping the index up-to-date
v2: Use [[:space:]] instead of \s for better portability, thanks to Randy Dunlap.
--- Documentation/00-INDEX.sh | 24 ++++++++++++++++++++++++ 1 files changed, 24 insertions(+), 0 deletions(-) create mode 100755 Documentation/00-INDEX.sh
Documentation/00-INDEX.sh new file +24 -0
@@ -0,0 +1,24 @@ +#!/bin/sh +# Copyright 2011 Cyril Brulebois <[email protected]> +# +# Try and keep the 00-INDEX file up-to-date. + +# List all entries below the 00-INDEX entry: +documented=$(sed '1,/^00-INDEX$/d' 00-INDEX|grep -v '^[[:space:]]'|sed 's,/$,,') + +# List all files/directories except 00-INDEX* and Makefile: +present=$(ls -1|grep -v '^00-INDEX'|grep -v '^Makefile$') + +echo "Undocumented:" +for i in $present; do + if ! echo "$documented"|grep -qs "\<$i\>"; then + echo " $i" + fi +done + +echo "Documented but missing:" +for i in $documented; do + if [ ! -e $i ]; then + echo " $i" + fi +done
Signature · 1 line
1.7.4.4
PATCH 4/4 Documentation/00-INDEX: update with new top-level files
In reply to Cyril Brulebois--- Documentation/00-INDEX | 66 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 66 insertions(+), 0 deletions(-)
Documentation/00-INDEX +66 -0
@@ -24,10 +24,14 @@ CodingStyle development-process/ - An extended tutorial on how to work with the kernel development process. +DMA-API-HOWTO.txt + - guide about the dynamic DMA mapping for device driver writers. DMA-API.txt - DMA API, pci_ API & extensions for non-consistent memory machines. DMA-ISA-LPC.txt - How to do DMA with ISA (and LPC) devices. +DMA-attributes.txt + - documentation on the semantics of the DMA attributes. DocBook/ - directory with DocBook templates etc. for kernel documentation. HOWTO
@@ -38,16 +42,22 @@ IRQ-affinity.txt - how to select which CPU(s) handle which interrupt events on SMP. IRQ.txt - description of what an IRQ is. +Intel-IOMMU.txt + - documentation on some Intel virtualization technologies. ManagementStyle - how to (attempt to) manage kernel hackers. RCU/ - directory with info on RCU (read-copy update). SAK.txt - info on Secure Attention Keys. +SELinux.txt + - how to get started with the SELinux security enhancement. SM501.txt - Silicon Motion SM501 multimedia companion chip SecurityBugs - procedure for reporting security bugs found in the kernel. +Smack.txt + - documentation on the Smack Linux Security Module. SubmitChecklist - Linux kernel patch submission checklist. SubmittingDrivers
@@ -62,6 +72,8 @@ acpi/ - info on ACPI-specific hooks in the kernel. aoe/ - description of AoE (ATA over Ethernet) along with config examples. +apparmor.txt + - documentation on the AppArmor security extension. applying-patches.txt - description of various trees and how to apply their patches. arm/
@@ -70,6 +82,8 @@ atomic_ops.txt - semantics and behavior of atomic and bitmask operations. auxdisplay/ - misc. LCD driver documentation (cfag12864b, ks0108). +bad_memory.txt + - info on how to deal with bad memory (as reported by memtest86+). basic_profiling.txt - basic instructions for those who want to profile Linux kernel. binfmt_misc.txt
@@ -80,6 +94,10 @@ block/ - info on the Block I/O (BIO) layer. blockdev/ - info on block devices & drivers +braille-console.txt + - info on getting early boot messages on a braille device. +bt8xxgpio.txt + - info on the driver for BT8xx based PCI GPIO-cards. btmrvl.txt - info on Marvell Bluetooth driver usage. bus-virt-phys-mapping.txt
@@ -90,6 +108,10 @@ cdrom/ - directory with information on the CD-ROM drivers that Linux has. cgroups/ - cgroups features, including cpusets and memory controller. +circular-buffers.txt + - info on measuring circular buffers, and using memory barriers. +coccinelle.txt + - info on getting and using Coccinelle on the Linux kernel. connector/ - docs on the netlink based userspace<->kernel space communication mod. console/
@@ -104,6 +126,8 @@ cpuidle/ - info on CPU_IDLE, CPU idle state management subsystem. cputopology.txt - documentation on how CPU topology info is exported via sysfs. +credentials.txt + - documentation about credentials in Linux. cris/ - directory with info about Linux on CRIS architecture. crypto/
@@ -112,24 +136,32 @@ dcdbas.txt - information on the Dell Systems Management Base Driver. debugging-modules.txt - some notes on debugging modules after Linux 2.6.3. +debugging-via-ohci1394.txt + - info on debugging using physical DMA provided by FireWire controllers. dell_rbu.txt - document demonstrating the use of the Dell Remote BIOS Update driver. device-mapper/ - directory with info on Device Mapper. devices.txt - plain ASCII listing of all the nodes in /dev/ with major minor #'s. +dmaengine.txt + - placeholder for/link to Documentation/crypto/async-tx-api.txt dontdiff - file containing a list of files that should never be diff'ed. driver-model/ - directory with info about Linux driver model. dvb/ - info on Linux Digital Video Broadcast (DVB) subsystem. +dynamic-debug-howto.txt + - documentation on how to use the dynamic debug feature. early-userspace/ - info about initramfs, klibc, and userspace early during boot. edac.txt - information on EDAC - Error Detection And Correction eisa.txt - info on EISA bus support. +email-clients.txt + - mail client hints for the Linux mailing lists. fault-injection/ - dir with docs about the fault injection capabilities infrastructure. fb/
@@ -140,8 +172,14 @@ filesystems/ - info on the vfs and the various filesystems that Linux supports. firmware_class/ - request_firmware() hotplug interface info. +flexible-arrays.txt + - documentation on using flexible arrays in the kernel. frv/ - Fujitsu FR-V Linux documentation. +futex-requeue-pi.txt + - documentation on futex requeuing and priority inheritance. +gcov.txt + - how to use GCC's coverage testing tool with the Linux kernel. gpio.txt - overview of GPIO (General Purpose Input/Output) access conventions. highuid.txt
@@ -152,6 +190,8 @@ hw_random.txt - info on Linux support for random number generator in i8xx chipsets. hwmon/ - directory with docs on various hardware monitoring drivers. +hwspinlock.txt + - documentation about hardware spinlock modules. i2c/ - directory with info about the I2C bus/protocol (2 wire, kHz speed). i2o/
@@ -164,8 +204,12 @@ infiniband/ - directory with documents concerning Linux InfiniBand support. initrd.txt - how to use the RAM disk as an initial/temporary root filesystem. +init.txt + - explanations about the "no init found" boot hang message. input/ - info on Linux input device support. +intel_txt.txt + - documentation on Intel's Trusted Execution Technology (TXT). io-mapping.txt - description of io_mapping functions in linux/io-mapping.h io_ordering.txt
@@ -194,8 +238,14 @@ kernel-parameters.txt - summary listing of command line / boot prompt args for the kernel. keys-request-key.txt - description of the kernel key request service. +keys-trusted-encrypted.txt + - info on the Trusted and Encrypted keys in the kernel key ring service. keys.txt - description of the kernel key retention service. +kmemcheck.txt + - documentation on the kernel-side memory checker. +kmemleak.txt + - documentation on the kernel memory leak detector. kobject.txt - info of the kobject infrastructure of the Linux kernel. kprobes.txt
@@ -212,6 +262,8 @@ local_ops.txt - semantics and behavior of local atomic operations. lockdep-design.txt - documentation on the runtime locking correctness validator. +lockstat.txt + - documentation about statistics on locks. logo.gif - full colour GIF image of Linux logo (penguin - Tux). logo.txt
@@ -224,6 +276,8 @@ mca.txt - info on supporting Micro Channel Architecture (e.g. PS/2) systems. md.txt - info on boot arguments for the multiple devices driver. +media-framework.txt + - info on the kernel-side implementation of the media framework. memory-barriers.txt - info on Linux kernel memory barriers. memory-hotplug.txt
@@ -278,6 +332,8 @@ prio_tree.txt - info on radix-priority-search-tree use for indexing vmas. rbtree.txt - info on what red-black trees are and what they are for. +rfkill.txt + - info on the subsystem allowing to disable any radio transmitter. robust-futex-ABI.txt - documentation of the robust futex ABI. robust-futexes.txt
@@ -328,14 +384,20 @@ sysrq.txt - info on the magic SysRq key. telephony/ - directory with info on telephony (e.g. voice over IP) support. +tomoyo.txt + - documentation on the TOMOYO Linux Security Module. uml/ - directory with information about User Mode Linux. +unaligned-memory-access.txt + - documentation on unaligned accesses, and how to avoid them. unicode.txt - info on the Unicode character/font mapping used in Linux. unshare.txt - description of the Linux unshare system call. usb/ - directory with info regarding the Universal Serial Bus. +vgaarbiter.txt + - documentation on how to deal with legacy VGA devices. video-output.txt - sysfs class driver interface to enable/disable a video output device. video4linux/
@@ -348,7 +410,11 @@ w1/ - directory with documents regarding the 1-wire (w1) subsystem. watchdog/ - how to auto-reboot Linux if it has "fallen and can't get up". ;-) +workqueue.txt + - documentation on concurrency managed workqueues. x86/x86_64/ - directory with info on Linux support for AMD x86-64 (Hammer) machines. +xz.txt + - documentation on XZ data compression in Linux. zorro.txt - info on writing drivers for Zorro bus devices found on Amigas.
Signature · 1 line
1.7.4.4
Re: [PATCH 4/4] Documentation/00-INDEX: update with new top-level files
Quoted 1 line · On Sat, 23 Apr 2011 18:15:44 +0200 Cyril Brulebois wrote:
Signed-off-by Cyril Brulebois <[email protected]>
Thanks.
I plan to move security-related files to Documentation/security/.
Quoted 241 lines
--- Documentation/00-INDEX | 66 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 66 insertions(+), 0 deletions(-)Documentation/00-INDEX +66
-0@@ -24,10 +24,14 @@ CodingStyle development-process/ - An extended tutorial on how to work with the kernel development process. +DMA-API-HOWTO.txt + - guide about the dynamic DMA mapping for device driver writers. DMA-API.txt - DMA API, pci_ API & extensions for non-consistent memory machines. DMA-ISA-LPC.txt - How to do DMA with ISA (and LPC) devices. +DMA-attributes.txt + - documentation on the semantics of the DMA attributes. DocBook/ - directory with DocBook templates etc. for kernel documentation. HOWTO@@ -38,16 +42,22 @@ IRQ-affinity.txt - how to select which CPU(s) handle which interrupt events on SMP. IRQ.txt - description of what an IRQ is. +Intel-IOMMU.txt + - documentation on some Intel virtualization technologies. ManagementStyle - how to (attempt to) manage kernel hackers. RCU/ - directory with info on RCU (read-copy update). SAK.txt - info on Secure Attention Keys. +SELinux.txt + - how to get started with the SELinux security enhancement. SM501.txt - Silicon Motion SM501 multimedia companion chip SecurityBugs - procedure for reporting security bugs found in the kernel. +Smack.txt + - documentation on the Smack Linux Security Module. SubmitChecklist - Linux kernel patch submission checklist. SubmittingDrivers@@ -62,6 +72,8 @@ acpi/ - info on ACPI-specific hooks in the kernel. aoe/ - description of AoE (ATA over Ethernet) along with config examples. +apparmor.txt + - documentation on the AppArmor security extension. applying-patches.txt - description of various trees and how to apply their patches. arm/@@ -70,6 +82,8 @@ atomic_ops.txt - semantics and behavior of atomic and bitmask operations. auxdisplay/ - misc. LCD driver documentation (cfag12864b, ks0108). +bad_memory.txt + - info on how to deal with bad memory (as reported by memtest86+). basic_profiling.txt - basic instructions for those who want to profile Linux kernel. binfmt_misc.txt@@ -80,6 +94,10 @@ block/ - info on the Block I/O (BIO) layer. blockdev/ - info on block devices & drivers +braille-console.txt + - info on getting early boot messages on a braille device. +bt8xxgpio.txt + - info on the driver for BT8xx based PCI GPIO-cards. btmrvl.txt - info on Marvell Bluetooth driver usage. bus-virt-phys-mapping.txt@@ -90,6 +108,10 @@ cdrom/ - directory with information on the CD-ROM drivers that Linux has. cgroups/ - cgroups features, including cpusets and memory controller. +circular-buffers.txt + - info on measuring circular buffers, and using memory barriers. +coccinelle.txt + - info on getting and using Coccinelle on the Linux kernel. connector/ - docs on the netlink based userspace<->kernel space communication mod. console/@@ -104,6 +126,8 @@ cpuidle/ - info on CPU_IDLE, CPU idle state management subsystem. cputopology.txt - documentation on how CPU topology info is exported via sysfs. +credentials.txt + - documentation about credentials in Linux. cris/ - directory with info about Linux on CRIS architecture. crypto/@@ -112,24 +136,32 @@ dcdbas.txt - information on the Dell Systems Management Base Driver. debugging-modules.txt - some notes on debugging modules after Linux 2.6.3. +debugging-via-ohci1394.txt + - info on debugging using physical DMA provided by FireWire controllers. dell_rbu.txt - document demonstrating the use of the Dell Remote BIOS Update driver. device-mapper/ - directory with info on Device Mapper. devices.txt - plain ASCII listing of all the nodes in /dev/ with major minor #'s. +dmaengine.txt + - placeholder for/link to Documentation/crypto/async-tx-api.txt dontdiff - file containing a list of files that should never be diff'ed. driver-model/ - directory with info about Linux driver model. dvb/ - info on Linux Digital Video Broadcast (DVB) subsystem. +dynamic-debug-howto.txt + - documentation on how to use the dynamic debug feature. early-userspace/ - info about initramfs, klibc, and userspace early during boot. edac.txt - information on EDAC - Error Detection And Correction eisa.txt - info on EISA bus support. +email-clients.txt + - mail client hints for the Linux mailing lists. fault-injection/ - dir with docs about the fault injection capabilities infrastructure. fb/@@ -140,8 +172,14 @@ filesystems/ - info on the vfs and the various filesystems that Linux supports. firmware_class/ - request_firmware() hotplug interface info. +flexible-arrays.txt + - documentation on using flexible arrays in the kernel. frv/ - Fujitsu FR-V Linux documentation. +futex-requeue-pi.txt + - documentation on futex requeuing and priority inheritance. +gcov.txt + - how to use GCC's coverage testing tool with the Linux kernel. gpio.txt - overview of GPIO (General Purpose Input/Output) access conventions. highuid.txt@@ -152,6 +190,8 @@ hw_random.txt - info on Linux support for random number generator in i8xx chipsets. hwmon/ - directory with docs on various hardware monitoring drivers. +hwspinlock.txt + - documentation about hardware spinlock modules. i2c/ - directory with info about the I2C bus/protocol (2 wire, kHz speed). i2o/@@ -164,8 +204,12 @@ infiniband/ - directory with documents concerning Linux InfiniBand support. initrd.txt - how to use the RAM disk as an initial/temporary root filesystem. +init.txt + - explanations about the "no init found" boot hang message. input/ - info on Linux input device support. +intel_txt.txt + - documentation on Intel's Trusted Execution Technology (TXT). io-mapping.txt - description of io_mapping functions in linux/io-mapping.h io_ordering.txt@@ -194,8 +238,14 @@ kernel-parameters.txt - summary listing of command line / boot prompt args for the kernel. keys-request-key.txt - description of the kernel key request service. +keys-trusted-encrypted.txt + - info on the Trusted and Encrypted keys in the kernel key ring service. keys.txt - description of the kernel key retention service. +kmemcheck.txt + - documentation on the kernel-side memory checker. +kmemleak.txt + - documentation on the kernel memory leak detector. kobject.txt - info of the kobject infrastructure of the Linux kernel. kprobes.txt@@ -212,6 +262,8 @@ local_ops.txt - semantics and behavior of local atomic operations. lockdep-design.txt - documentation on the runtime locking correctness validator. +lockstat.txt + - documentation about statistics on locks. logo.gif - full colour GIF image of Linux logo (penguin - Tux). logo.txt@@ -224,6 +276,8 @@ mca.txt - info on supporting Micro Channel Architecture (e.g. PS/2) systems. md.txt - info on boot arguments for the multiple devices driver. +media-framework.txt + - info on the kernel-side implementation of the media framework. memory-barriers.txt - info on Linux kernel memory barriers. memory-hotplug.txt@@ -278,6 +332,8 @@ prio_tree.txt - info on radix-priority-search-tree use for indexing vmas. rbtree.txt - info on what red-black trees are and what they are for. +rfkill.txt + - info on the subsystem allowing to disable any radio transmitter. robust-futex-ABI.txt - documentation of the robust futex ABI. robust-futexes.txt@@ -328,14 +384,20 @@ sysrq.txt - info on the magic SysRq key. telephony/ - directory with info on telephony (e.g. voice over IP) support. +tomoyo.txt + - documentation on the TOMOYO Linux Security Module. uml/ - directory with information about User Mode Linux. +unaligned-memory-access.txt + - documentation on unaligned accesses, and how to avoid them. unicode.txt - info on the Unicode character/font mapping used in Linux. unshare.txt - description of the Linux unshare system call. usb/ - directory with info regarding the Universal Serial Bus. +vgaarbiter.txt + - documentation on how to deal with legacy VGA devices. video-output.txt - sysfs class driver interface to enable/disable a video output device. video4linux/@@ -348,7 +410,11 @@ w1/ - directory with documents regarding the 1-wire (w1) subsystem. watchdog/ - how to auto-reboot Linux if it has "fallen and can't get up". ;-) +workqueue.txt + - documentation on concurrency managed workqueues. x86/x86_64/ - directory with info on Linux support for AMD x86-64 (Hammer) machines. +xz.txt + - documentation on XZ data compression in Linux. zorro.txt - info on writing drivers for Zorro bus devices found on Amigas.
Quoted 1 line · On Sat, 23 Apr 2011 18:15:41 +0200 Cyril Brulebois wrote:
Signed-off-by Cyril Brulebois <[email protected]>
Thanks.
Quoted 10 lines
--- Documentation/00-INDEX | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)Documentation/00-INDEX +0
-0
Documentation/00-INDEX atomic_ops.txt · line 77
Quoted 8 lines
Documentation/00-INDEX +1
-1@@ -71,7 +71,7 @@ atomic_ops.txt auxdisplay/ - misc. LCD driver documentation (cfag12864b, ks0108). basic_profiling.txt - - basic instructions for those who wants to profile Linux kernel. + - basic instructions for those who want to profile Linux kernel. binfmt_misc.txt - info on the kernel support for extra binary formats. blackfin/
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***