[PATCH] Add section IDs to Documentation/DocBook/filesystems.tmpl

Rob Landley
2007-10-14T05:57:32Z

From: Rob Landley <rob@landley.net>

Add recommended section IDs to Documentation/DocBook/filesystems.tmpl

Signed-off-by: Rob Landley <rob@landley.net>
---

Documentation/DocBook/filesystems.tmpl | 36 +++++++++++------------
1 file changed, 18 insertions(+), 18 deletions(-)

diff -r 79f0ea1e0e70 Documentation/DocBook/filesystems.tmpl
--- a/Documentation/DocBook/filesystems.tmpl Tue Oct 09 21:00:40 2007 +0000
+++ b/Documentation/DocBook/filesystems.tmpl Sat Oct 13 23:16:49 2007 -0500
@@ -40,25 +40,25 @@

<chapter id="vfs">
The Linux VFS
- <sect1> The Filesystem types
+ <sect1 id="the_filesystem_types"> The Filesystem types
!Iinclude/linux/fs.h
</sect1>
- <sect1> The Directory Cache
+ <sect1 id="the_directory_cache"> The Directory Cache
!Efs/dcache.c
!Iinclude/linux/dcache.h
</sect1>
- <sect1> Inode Handling
+ <sect1 id="inode_handling"> Inode Handling
!Efs/inode.c
!Efs/bad_inode.c
</sect1>
- <sect1> Registration and Superblocks
+ <sect1 id="registration_and_superblocks"> Registration and Superblocks
!Efs/super.c
</sect1>
- <sect1> File Locks
+ <sect1 id="file_locks"> File Locks
!Efs/locks.c
!Ifs/locks.c
</sect1>
- <sect1> Other Functions
+ <sect1 id="other_functions"> Other Functions
!Efs/mpage.c
!Efs/namei.c
!Efs/buffer.c
@@ -73,11 +73,11 @@
<chapter id="proc">
The proc filesystem

- <sect1> sysctl interface
+ <sect1 id="sysctl_interface"> sysctl interface
!Ekernel/sysctl.c
</sect1>

- <sect1> proc filesystem interface
+ <sect1 id="proc_filesystem_interface"> proc filesystem interface
!Ifs/proc/base.c
</sect1>
</chapter>
@@ -92,7 +92,7 @@
<chapter id="debugfs">
The debugfs filesystem

- <sect1> debugfs interface
+ <sect1 id="debugfs_interface"> debugfs interface
!Efs/debugfs/inode.c
!Efs/debugfs/file.c
</sect1>
@@ -134,9 +134,9 @@

The Linux Journalling API

- <sect1>
+ <sect1 id="journaling_overview">
Overview
- <sect2>
+ <sect2 id="journaling_details">
Details

The journalling layer is easy to use. You need to
@@ -307,7 +307,7 @@ particular inode.

</sect2>

- <sect2>
+ <sect2 id="jbd_summary">
Summary

Using the journal is a matter of wrapping the different context changes,
@@ -349,7 +349,7 @@ an example.

</sect1>

- <sect1>
+ <sect1 id="data_types">
Data Types

The journalling layer uses typedefs to 'hide' the concrete definitions
@@ -358,27 +358,27 @@ an example.

Obviously the hiding is not enforced as this is 'C'.

- <sect2> Structures
+ <sect2 id="structures"> Structures
!Iinclude/linux/jbd.h
</sect2>
</sect1>

- <sect1>
+ <sect1 id="functions">
Functions

The functions here are split into two groups those that
affect a journal as a whole, and those which are used to
manage transactions

- <sect2> Journal Level
+ <sect2 id="journal_level"> Journal Level
!Efs/jbd/journal.c
!Ifs/jbd/recovery.c
</sect2>
- <sect2> Transasction Level
+ <sect2 id="transaction_level"> Transasction Level
!Efs/jbd/transaction.c
</sect2>
</sect1>
- <sect1>
+ <sect1 id="see_also">
See also

<citation>

--
"One of my most productive days was throwing away 1000 lines of code."
- Ken Thompson.