]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
docs: f2fs: wrap ASCII tables in literal blocks to fix LaTeX build
authorMasaharu Noguchi <nogunix@gmail.com>
Mon, 17 Nov 2025 12:27:54 +0000 (21:27 +0900)
committerJaegeuk Kim <jaegeuk@kernel.org>
Thu, 4 Dec 2025 02:00:05 +0000 (02:00 +0000)
Sphinx's LaTeX builder fails when converting the nested ASCII tables in
f2fs.rst, producing the following error:

  "Markup is unsupported in LaTeX: longtable does not support nesting a table."

Wrap the affected ASCII tables in literal code blocks to force Sphinx to
render them verbatim. This prevents nested longtables and fixes the PDF
build failure on Sphinx 8.2.x.

Acked-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
Signed-off-by: Masaharu Noguchi <nogunix@gmail.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>
Reviewed-by: Chao Yu <chao@kernel.org>
Signed-off-by: Jaegeuk Kim <jaegeuk@kernel.org>
Documentation/filesystems/f2fs.rst

index a8d02fe5be8399e454c5ffa9ee0c4c2ddc140212..cb90d1ae82d012c3dd9b312b29d02ae494522039 100644 (file)
@@ -188,34 +188,36 @@ fault_type=%d              Support configuring fault injection type, should be
                         enabled with fault_injection option, fault type value
                         is shown below, it supports single or combined type.
 
-                        ===========================      ==========
-                        Type_Name                        Type_Value
-                        ===========================      ==========
-                        FAULT_KMALLOC                    0x00000001
-                        FAULT_KVMALLOC                   0x00000002
-                        FAULT_PAGE_ALLOC                 0x00000004
-                        FAULT_PAGE_GET                   0x00000008
-                        FAULT_ALLOC_BIO                  0x00000010 (obsolete)
-                        FAULT_ALLOC_NID                  0x00000020
-                        FAULT_ORPHAN                     0x00000040
-                        FAULT_BLOCK                      0x00000080
-                        FAULT_DIR_DEPTH                  0x00000100
-                        FAULT_EVICT_INODE                0x00000200
-                        FAULT_TRUNCATE                   0x00000400
-                        FAULT_READ_IO                    0x00000800
-                        FAULT_CHECKPOINT                 0x00001000
-                        FAULT_DISCARD                    0x00002000
-                        FAULT_WRITE_IO                   0x00004000
-                        FAULT_SLAB_ALLOC                 0x00008000
-                        FAULT_DQUOT_INIT                 0x00010000
-                        FAULT_LOCK_OP                    0x00020000
-                        FAULT_BLKADDR_VALIDITY           0x00040000
-                        FAULT_BLKADDR_CONSISTENCE        0x00080000
-                        FAULT_NO_SEGMENT                 0x00100000
-                        FAULT_INCONSISTENT_FOOTER        0x00200000
-                        FAULT_TIMEOUT                    0x00400000 (1000ms)
-                        FAULT_VMALLOC                    0x00800000
-                        ===========================      ==========
+                        .. code-block:: none
+
+                            ===========================      ==========
+                            Type_Name                        Type_Value
+                            ===========================      ==========
+                            FAULT_KMALLOC                    0x00000001
+                            FAULT_KVMALLOC                   0x00000002
+                            FAULT_PAGE_ALLOC                 0x00000004
+                            FAULT_PAGE_GET                   0x00000008
+                            FAULT_ALLOC_BIO                  0x00000010 (obsolete)
+                            FAULT_ALLOC_NID                  0x00000020
+                            FAULT_ORPHAN                     0x00000040
+                            FAULT_BLOCK                      0x00000080
+                            FAULT_DIR_DEPTH                  0x00000100
+                            FAULT_EVICT_INODE                0x00000200
+                            FAULT_TRUNCATE                   0x00000400
+                            FAULT_READ_IO                    0x00000800
+                            FAULT_CHECKPOINT                 0x00001000
+                            FAULT_DISCARD                    0x00002000
+                            FAULT_WRITE_IO                   0x00004000
+                            FAULT_SLAB_ALLOC                 0x00008000
+                            FAULT_DQUOT_INIT                 0x00010000
+                            FAULT_LOCK_OP                    0x00020000
+                            FAULT_BLKADDR_VALIDITY           0x00040000
+                            FAULT_BLKADDR_CONSISTENCE        0x00080000
+                            FAULT_NO_SEGMENT                 0x00100000
+                            FAULT_INCONSISTENT_FOOTER        0x00200000
+                            FAULT_TIMEOUT                    0x00400000 (1000ms)
+                            FAULT_VMALLOC                    0x00800000
+                            ===========================      ==========
 mode=%s                         Control block allocation mode which supports "adaptive"
                         and "lfs". In "lfs" mode, there should be no random
                         writes towards main area.
@@ -296,14 +298,15 @@ nocheckpoint_merge         Disable checkpoint merge feature.
 compress_algorithm=%s   Control compress algorithm, currently f2fs supports "lzo",
                         "lz4", "zstd" and "lzo-rle" algorithm.
 compress_algorithm=%s:%d Control compress algorithm and its compress level, now, only
-                        "lz4" and "zstd" support compress level config.
-
-                         =========      ===========
-                        algorithm      level range
-                         =========      ===========
-                        lz4            3 - 16
-                        zstd           1 - 22
-                         =========      ===========
+                        "lz4" and "zstd" support compress level config::
+
+                                =========      ===========
+                                algorithm      level range
+                                =========      ===========
+                                lz4            3 - 16
+                                zstd           1 - 22
+                                =========      ===========
+
 compress_log_size=%u    Support configuring compress cluster size. The size will
                         be 4KB * (1 << %u). The default and minimum sizes are 16KB.
 compress_extension=%s   Support adding specified extension, so that f2fs can enable
@@ -368,38 +371,42 @@ errors=%s          Specify f2fs behavior on critical errors. This supports modes:
                         the partition in read-only mode. By default it uses "continue"
                         mode.
 
-                        ====================== =============== =============== ========
-                        mode                   continue        remount-ro      panic
-                        ====================== =============== =============== ========
-                        access ops             normal          normal          N/A
-                        syscall errors         -EIO            -EROFS          N/A
-                        mount option           rw              ro              N/A
-                        pending dir write      keep            keep            N/A
-                        pending non-dir write  drop            keep            N/A
-                        pending node write     drop            keep            N/A
-                        pending meta write     keep            keep            N/A
-                        ====================== =============== =============== ========
+                        .. code-block:: none
+
+                            ====================== =============== =============== ========
+                            mode                   continue        remount-ro      panic
+                            ====================== =============== =============== ========
+                            access ops             normal          normal          N/A
+                            syscall errors         -EIO            -EROFS          N/A
+                            mount option           rw              ro              N/A
+                            pending dir write      keep            keep            N/A
+                            pending non-dir write  drop            keep            N/A
+                            pending node write     drop            keep            N/A
+                            pending meta write     keep            keep            N/A
+                            ====================== =============== =============== ========
 nat_bits                Enable nat_bits feature to enhance full/empty nat blocks access,
                         by default it's disabled.
 lookup_mode=%s          Control the directory lookup behavior for casefolded
                         directories. This option has no effect on directories
                         that do not have the casefold feature enabled.
 
-                        ================== ========================================
-                        Value              Description
-                        ================== ========================================
-                        perf               (Default) Enforces a hash-only lookup.
-                                           The linear search fallback is always
-                                           disabled, ignoring the on-disk flag.
-                        compat             Enables the linear search fallback for
-                                           compatibility with directory entries
-                                           created by older kernel that used a
-                                           different case-folding algorithm.
-                                           This mode ignores the on-disk flag.
-                        auto               F2FS determines the mode based on the
-                                           on-disk `SB_ENC_NO_COMPAT_FALLBACK_FL`
-                                           flag.
-                        ================== ========================================
+                        .. code-block:: none
+
+                            ================== ========================================
+                            Value              Description
+                            ================== ========================================
+                            perf               (Default) Enforces a hash-only lookup.
+                                               The linear search fallback is always
+                                               disabled, ignoring the on-disk flag.
+                            compat             Enables the linear search fallback for
+                                               compatibility with directory entries
+                                               created by older kernel that used a
+                                               different case-folding algorithm.
+                                               This mode ignores the on-disk flag.
+                            auto               F2FS determines the mode based on the
+                                               on-disk `SB_ENC_NO_COMPAT_FALLBACK_FL`
+                                               flag.
+                            ================== ========================================
 ======================== ============================================================
 
 Debugfs Entries