The lists use an asterisk in parentheses (``(*)``) as the bullet marker, which isn't recognized by Sphinx as the proper bullet. Replace with just an asterisk. Signed-off-by: Bagas Sanjaya --- Documentation/filesystems/afs.rst | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/Documentation/filesystems/afs.rst b/Documentation/filesystems/afs.rst index f15ba388bbde79..6135d64ada6372 100644 --- a/Documentation/filesystems/afs.rst +++ b/Documentation/filesystems/afs.rst @@ -23,17 +23,14 @@ This filesystem provides a fairly simple secure AFS filesystem driver. It is under development and does not yet provide the full feature set. The features it does support include: - (*) Security (currently only AFS kaserver and KerberosIV tickets). - - (*) File reading and writing. - - (*) Automounting. - - (*) Local caching (via fscache). + * Security (currently only AFS kaserver and KerberosIV tickets). + * File reading and writing. + * Automounting. + * Local caching (via fscache). It does not yet support the following AFS features: - (*) pioctl() system call. + * pioctl() system call. Compilation @@ -146,15 +143,15 @@ Proc Filesystem The AFS module creates a "/proc/fs/afs/" directory and populates it: - (*) A "cells" file that lists cells currently known to the afs module and - their usage counts:: + * A "cells" file that lists cells currently known to the afs module and + their usage counts:: [root@andromeda ~]# cat /proc/fs/afs/cells USE NAME 3 cambridge.redhat.com - (*) A directory per cell that contains files that list volume location - servers, volumes, and active servers known within that cell:: + * A directory per cell that contains files that list volume location + servers, volumes, and active servers known within that cell:: [root@andromeda ~]# cat /proc/fs/afs/cambridge.redhat.com/servers USE ADDR STATE -- An old man doll... just what I always wanted! - Clara Filesystems for DAX implementation inspiration is listed in "See also" admonitions, one for each filesystem (ext2, ext4, and xfs). Coalesce them into a bullet list. While at it, also link to XFS developer documentation in Documentation/filesystems/xfs/ instead of user-facing counterpart in Docmentation/admin-guide/xfs.rst. Signed-off-by: Bagas Sanjaya --- Documentation/filesystems/dax.rst | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/Documentation/filesystems/dax.rst b/Documentation/filesystems/dax.rst index 5b283f3d1eb113..e0631d5f6251d4 100644 --- a/Documentation/filesystems/dax.rst +++ b/Documentation/filesystems/dax.rst @@ -234,17 +234,9 @@ exposure of uninitialized data through mmap. These filesystems may be used for inspiration: -.. seealso:: - - ext2: see Documentation/filesystems/ext2.rst - -.. seealso:: - - xfs: see Documentation/admin-guide/xfs.rst - -.. seealso:: - - ext4: see Documentation/filesystems/ext4/ + * :doc:`ext2 ` + * :doc:`ext4 ` + * :doc:`xfs ` Handling Media Errors -- An old man doll... just what I always wanted! - Clara Subsections of "Enabling DAX on xfs and ext4" section (both "Summary" and "Details") are marked up as section heading instead, which makes their way to filesystems toctree entry. Demote them. Signed-off-by: Bagas Sanjaya --- Documentation/filesystems/dax.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/filesystems/dax.rst b/Documentation/filesystems/dax.rst index e0631d5f6251d4..f9243d45ce1280 100644 --- a/Documentation/filesystems/dax.rst +++ b/Documentation/filesystems/dax.rst @@ -38,7 +38,7 @@ Enabling DAX on xfs and ext4 ---------------------------- Summary -------- +~~~~~~~ 1. There exists an in-kernel file access mode flag `S_DAX` that corresponds to the statx flag `STATX_ATTR_DAX`. See the manpage for statx(2) for details @@ -95,7 +95,7 @@ Summary Details -------- +~~~~~~~ There are 2 per-file dax flags. One is a persistent inode setting (`FS_XFLAG_DAX`) and the other is a volatile flag indicating the active state of the feature -- An old man doll... just what I always wanted! - Clara Mount options list is rendered in htmldocs output as combined with preceding paragraph due to missing separator between them. Add it. Signed-off-by: Bagas Sanjaya --- Documentation/filesystems/zonefs.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/filesystems/zonefs.rst b/Documentation/filesystems/zonefs.rst index c22124c2213d5d..58cfb1183589dd 100644 --- a/Documentation/filesystems/zonefs.rst +++ b/Documentation/filesystems/zonefs.rst @@ -307,6 +307,7 @@ Mount options ------------- zonefs defines several mount options: + * errors= * explicit-open -- An old man doll... just what I always wanted! - Clara Format zonefs I/O error processing table as reST grid table. Signed-off-by: Bagas Sanjaya --- Documentation/filesystems/zonefs.rst | 53 +++++++++++++++++----------- 1 file changed, 32 insertions(+), 21 deletions(-) diff --git a/Documentation/filesystems/zonefs.rst b/Documentation/filesystems/zonefs.rst index 58cfb1183589dd..a2e97bd69b6347 100644 --- a/Documentation/filesystems/zonefs.rst +++ b/Documentation/filesystems/zonefs.rst @@ -255,30 +255,41 @@ permissions. Further action taken by zonefs I/O error recovery can be controlled by the user with the "errors=xxx" mount option. The table below summarizes the result of zonefs I/O error processing depending on the mount option and on the zone -conditions:: +conditions: +--------------+-----------+-----------------------------------------+ | | | Post error state | - | "errors=xxx" | device | access permissions | - | mount | zone | file file device zone | - | option | condition | size read write read write | - +--------------+-----------+-----------------------------------------+ - | | good | fixed yes no yes yes | - | remount-ro | read-only | as is yes no yes no | - | (default) | offline | 0 no no no no | - +--------------+-----------+-----------------------------------------+ - | | good | fixed yes no yes yes | - | zone-ro | read-only | as is yes no yes no | - | | offline | 0 no no no no | - +--------------+-----------+-----------------------------------------+ - | | good | 0 no no yes yes | - | zone-offline | read-only | 0 no no yes no | - | | offline | 0 no no no no | - +--------------+-----------+-----------------------------------------+ - | | good | fixed yes yes yes yes | - | repair | read-only | as is yes no yes no | - | | offline | 0 no no no no | - +--------------+-----------+-----------------------------------------+ + | | +--------+---------------+----------------+ + | | | | access permissions | + | "errors=xxx" | device | file +---------------+----------------+ + | mount | zone | size | file | device zone | + | option | condition | +-------+-------+--------+-------+ + | | | | read | write | read | write | + +==============+===========+========+=======+=======+========+=======+ + | | good | fixed | yes | no | yes | yes | + | +-----------+--------+-------+-------+--------+-------+ + | remount-ro | read-only | as is | yes | no | yes | no | + | (default) +-----------+--------+-------+-------+--------+-------+ + | | offline | 0 | no | no | no | no | + +--------------+-----------+--------+-------+-------+--------+-------+ + | | good | fixed | yes | no | yes | yes | + | +-----------+--------+-------+-------+--------+-------+ + | zone-ro | read-only | as is | yes | no | yes | no | + | +-----------+--------+-------+-------+--------+-------+ + | | offline | 0 | no | no | no | no | + +--------------+-----------+--------+-------+-------+--------+-------+ + | | good | 0 | no | no | yes | yes | + | +-----------+--------+-------+-------+--------+-------+ + | zone-offline | read-only | 0 | no | no | yes | no | + | +-----------+--------+-------+-------+--------+-------+ + | | offline | 0 | no | no | no | no | + +--------------+-----------+--------+-------+-------+--------+-------+ + | | good | fixed | yes | yes | yes | yes | + | +-----------+--------+-------+-------+--------+-------+ + | repair | read-only | as is | yes | no | yes | no | + | +-----------+--------+-------+-------+--------+-------+ + | | offline | 0 | no | no | no | no | + +--------------+-----------+--------+-------+-------+--------+-------+ Further notes: -- An old man doll... just what I always wanted! - Clara