aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/filesystems/index.rst (follow)
AgeCommit message (Collapse)AuthorFilesLines
2018-12-20docs: improve pathname-lookup document structureNeilBrown1-2/+12
Get rid of some unneeded structural elements around the new (to RST) pathname-lookup document. Signed-off-by: NeilBrown <neilb@suse.com> [ jc: grabbed from email and changelog added ] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2018-12-06Documentation: convert path-lookup from markdown to resturctured textNeilBrown1-0/+11
This allows the document to be integrated with the main documentation tree. Changes include: - rename from .md to .rst - use `` for code, not single ` - use correct sub-section marking - fix indented blocks, both code and non-code - fix external-link markup Signed-off-by: NeilBrown <neilb@suse.com> [jc: changed the toctree organization a bit] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2018-07-03fs: Add more kernel-doc to the produced documentationMatthew Wilcox1-0/+33
People have gone to all the effort of writing kernel-doc for these functions; the least we can do is put them in the "Other functions" part of the VFS documentation. Signed-off-by: Matthew Wilcox <willy@infradead.org> Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2017-10-31fscrypt: add a documentation file for filesystem-level encryptionEric Biggers1-0/+11
Perhaps long overdue, add a documentation file for filesystem-level encryption, a.k.a. fscrypt or fs/crypto/, to the Documentation directory. The new file is based loosely on the latest version of the "EXT4 Encryption Design Document (public version)" Google Doc, but with many improvements made, including: - Reflect the reality that it is not specific to ext4 anymore. - More thoroughly document the design and user-visible API/behavior. - Replace outdated information, such as the outdated explanation of how encrypted filenames are hashed for indexed directories and how encrypted filenames are presented to userspace without the key. (This was changed just before release.) For now the focus is on the design and user-visible API/behavior, not on how to add encryption support to a filesystem --- since the internal API is still pretty messy and any standalone documentation for it would become outdated as things get refactored over time. Reviewed-by: Michael Halcrow <mhalcrow@google.com> Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
2017-05-16docs-rst: don't ignore internal functions for jbd2 docsMauro Carvalho Chehab1-1/+0
Those functions are currently ignored, causing references at the documentation to be lost. Don't ignore it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-05-16docs-rst: filesystems: use c domain references where neededMauro Carvalho Chehab1-36/+40
Instead of just mention the function names, use cross-references to the kernel-doc tags where pertinent. While not all function documentation is included here, I double-checked that all functions mentioned there still exists. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-05-16docs-rst: convert filesystems book to ReSTMauro Carvalho Chehab1-0/+314
Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>