diff options
Diffstat (limited to 'Documentation/DocBook/filesystems.tmpl')
| -rw-r--r-- | Documentation/DocBook/filesystems.tmpl | 70 |
1 files changed, 47 insertions, 23 deletions
diff --git a/Documentation/DocBook/filesystems.tmpl b/Documentation/DocBook/filesystems.tmpl index 39fa2aba7f9..bcdfdb9a927 100644 --- a/Documentation/DocBook/filesystems.tmpl +++ b/Documentation/DocBook/filesystems.tmpl @@ -40,29 +40,29 @@ <chapter id="vfs"> <title>The Linux VFS</title> - <sect1><title>The Filesystem types</title> + <sect1 id="the_filesystem_types"><title>The Filesystem types</title> !Iinclude/linux/fs.h </sect1> - <sect1><title>The Directory Cache</title> + <sect1 id="the_directory_cache"><title>The Directory Cache</title> !Efs/dcache.c !Iinclude/linux/dcache.h </sect1> - <sect1><title>Inode Handling</title> + <sect1 id="inode_handling"><title>Inode Handling</title> !Efs/inode.c !Efs/bad_inode.c </sect1> - <sect1><title>Registration and Superblocks</title> + <sect1 id="registration_and_superblocks"><title>Registration and Superblocks</title> !Efs/super.c </sect1> - <sect1><title>File Locks</title> + <sect1 id="file_locks"><title>File Locks</title> !Efs/locks.c !Ifs/locks.c </sect1> - <sect1><title>Other Functions</title> + <sect1 id="other_functions"><title>Other Functions</title> !Efs/mpage.c !Efs/namei.c !Efs/buffer.c -!Efs/bio.c +!Eblock/bio.c !Efs/seq_file.c !Efs/filesystems.c !Efs/fs-writeback.c @@ -73,26 +73,30 @@ <chapter id="proc"> <title>The proc filesystem</title> - <sect1><title>sysctl interface</title> + <sect1 id="sysctl_interface"><title>sysctl interface</title> !Ekernel/sysctl.c </sect1> - <sect1><title>proc filesystem interface</title> + <sect1 id="proc_filesystem_interface"><title>proc filesystem interface</title> !Ifs/proc/base.c </sect1> </chapter> + <chapter id="fs_events"> + <title>Events based on file descriptors</title> +!Efs/eventfd.c + </chapter> + <chapter id="sysfs"> <title>The Filesystem for Exporting Kernel Objects</title> !Efs/sysfs/file.c !Efs/sysfs/symlink.c -!Efs/sysfs/bin.c </chapter> <chapter id="debugfs"> <title>The debugfs filesystem</title> - <sect1><title>debugfs interface</title> + <sect1 id="debugfs_interface"><title>debugfs interface</title> !Efs/debugfs/inode.c !Efs/debugfs/file.c </sect1> @@ -134,9 +138,9 @@ <title>The Linux Journalling API</title> - <sect1> + <sect1 id="journaling_overview"> <title>Overview</title> - <sect2> + <sect2 id="journaling_details"> <title>Details</title> <para> The journalling layer is easy to use. You need to @@ -219,8 +223,8 @@ all your transactions. </para> <para> -Then at umount time , in your put_super() (2.4) or write_super() (2.5) -you can then call journal_destroy() to clean up your in-core journal object. +Then at umount time , in your put_super() you can then call journal_destroy() +to clean up your in-core journal object. </para> <para> @@ -307,7 +311,7 @@ particular inode. </sect2> - <sect2> + <sect2 id="jbd_summary"> <title>Summary</title> <para> Using the journal is a matter of wrapping the different context changes, @@ -349,7 +353,7 @@ an example. </sect1> - <sect1> + <sect1 id="data_types"> <title>Data Types</title> <para> The journalling layer uses typedefs to 'hide' the concrete definitions @@ -358,31 +362,31 @@ an example. Obviously the hiding is not enforced as this is 'C'. </para> - <sect2><title>Structures</title> + <sect2 id="structures"><title>Structures</title> !Iinclude/linux/jbd.h </sect2> </sect1> - <sect1> + <sect1 id="functions"> <title>Functions</title> <para> The functions here are split into two groups those that affect a journal as a whole, and those which are used to manage transactions </para> - <sect2><title>Journal Level</title> + <sect2 id="journal_level"><title>Journal Level</title> !Efs/jbd/journal.c !Ifs/jbd/recovery.c </sect2> - <sect2><title>Transasction Level</title> + <sect2 id="transaction_level"><title>Transasction Level</title> !Efs/jbd/transaction.c </sect2> </sect1> - <sect1> + <sect1 id="see_also"> <title>See also</title> <para> <citation> - <ulink url="ftp://ftp.uk.linux.org/pub/linux/sct/fs/jfs/journal-design.ps.gz"> + <ulink url="http://kernel.org/pub/linux/kernel/people/sct/ext3/journal-design.ps.gz"> Journaling the Linux ext2fs Filesystem, LinuxExpo 98, Stephen Tweedie </ulink> </citation> @@ -398,4 +402,24 @@ an example. </chapter> + <chapter id="splice"> + <title>splice API</title> + <para> + splice is a method for moving blocks of data around inside the + kernel, without continually transferring them between the kernel + and user space. + </para> +!Ffs/splice.c + </chapter> + + <chapter id="pipes"> + <title>pipes API</title> + <para> + Pipe interfaces are all for in-kernel (builtin image) use. + They are not exported for use by modules. + </para> +!Iinclude/linux/pipe_fs_i.h +!Ffs/pipe.c + </chapter> + </book> |