Skip to content

Commit fbc0774

Browse files
nogunixJaegeuk Kim
authored andcommitted
docs: f2fs: wrap ASCII tables in literal blocks to fix LaTeX build
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 <[email protected]> Reviewed-by: Akira Yokosawa <[email protected]> Signed-off-by: Masaharu Noguchi <[email protected]> Acked-by: Jonathan Corbet <[email protected]> Reviewed-by: Chao Yu <[email protected]> Signed-off-by: Jaegeuk Kim <[email protected]>
1 parent 1627a30 commit fbc0774

File tree

1 file changed

+69
-62
lines changed

1 file changed

+69
-62
lines changed

Documentation/filesystems/f2fs.rst

Lines changed: 69 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -188,34 +188,36 @@ fault_type=%d Support configuring fault injection type, should be
188188
enabled with fault_injection option, fault type value
189189
is shown below, it supports single or combined type.
190190

191-
=========================== ==========
192-
Type_Name Type_Value
193-
=========================== ==========
194-
FAULT_KMALLOC 0x00000001
195-
FAULT_KVMALLOC 0x00000002
196-
FAULT_PAGE_ALLOC 0x00000004
197-
FAULT_PAGE_GET 0x00000008
198-
FAULT_ALLOC_BIO 0x00000010 (obsolete)
199-
FAULT_ALLOC_NID 0x00000020
200-
FAULT_ORPHAN 0x00000040
201-
FAULT_BLOCK 0x00000080
202-
FAULT_DIR_DEPTH 0x00000100
203-
FAULT_EVICT_INODE 0x00000200
204-
FAULT_TRUNCATE 0x00000400
205-
FAULT_READ_IO 0x00000800
206-
FAULT_CHECKPOINT 0x00001000
207-
FAULT_DISCARD 0x00002000
208-
FAULT_WRITE_IO 0x00004000
209-
FAULT_SLAB_ALLOC 0x00008000
210-
FAULT_DQUOT_INIT 0x00010000
211-
FAULT_LOCK_OP 0x00020000
212-
FAULT_BLKADDR_VALIDITY 0x00040000
213-
FAULT_BLKADDR_CONSISTENCE 0x00080000
214-
FAULT_NO_SEGMENT 0x00100000
215-
FAULT_INCONSISTENT_FOOTER 0x00200000
216-
FAULT_TIMEOUT 0x00400000 (1000ms)
217-
FAULT_VMALLOC 0x00800000
218-
=========================== ==========
191+
.. code-block:: none
192+
193+
=========================== ==========
194+
Type_Name Type_Value
195+
=========================== ==========
196+
FAULT_KMALLOC 0x00000001
197+
FAULT_KVMALLOC 0x00000002
198+
FAULT_PAGE_ALLOC 0x00000004
199+
FAULT_PAGE_GET 0x00000008
200+
FAULT_ALLOC_BIO 0x00000010 (obsolete)
201+
FAULT_ALLOC_NID 0x00000020
202+
FAULT_ORPHAN 0x00000040
203+
FAULT_BLOCK 0x00000080
204+
FAULT_DIR_DEPTH 0x00000100
205+
FAULT_EVICT_INODE 0x00000200
206+
FAULT_TRUNCATE 0x00000400
207+
FAULT_READ_IO 0x00000800
208+
FAULT_CHECKPOINT 0x00001000
209+
FAULT_DISCARD 0x00002000
210+
FAULT_WRITE_IO 0x00004000
211+
FAULT_SLAB_ALLOC 0x00008000
212+
FAULT_DQUOT_INIT 0x00010000
213+
FAULT_LOCK_OP 0x00020000
214+
FAULT_BLKADDR_VALIDITY 0x00040000
215+
FAULT_BLKADDR_CONSISTENCE 0x00080000
216+
FAULT_NO_SEGMENT 0x00100000
217+
FAULT_INCONSISTENT_FOOTER 0x00200000
218+
FAULT_TIMEOUT 0x00400000 (1000ms)
219+
FAULT_VMALLOC 0x00800000
220+
=========================== ==========
219221
mode=%s Control block allocation mode which supports "adaptive"
220222
and "lfs". In "lfs" mode, there should be no random
221223
writes towards main area.
@@ -296,14 +298,15 @@ nocheckpoint_merge Disable checkpoint merge feature.
296298
compress_algorithm=%s Control compress algorithm, currently f2fs supports "lzo",
297299
"lz4", "zstd" and "lzo-rle" algorithm.
298300
compress_algorithm=%s:%d Control compress algorithm and its compress level, now, only
299-
"lz4" and "zstd" support compress level config.
300-
301-
========= ===========
302-
algorithm level range
303-
========= ===========
304-
lz4 3 - 16
305-
zstd 1 - 22
306-
========= ===========
301+
"lz4" and "zstd" support compress level config::
302+
303+
========= ===========
304+
algorithm level range
305+
========= ===========
306+
lz4 3 - 16
307+
zstd 1 - 22
308+
========= ===========
309+
307310
compress_log_size=%u Support configuring compress cluster size. The size will
308311
be 4KB * (1 << %u). The default and minimum sizes are 16KB.
309312
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:
368371
the partition in read-only mode. By default it uses "continue"
369372
mode.
370373

371-
====================== =============== =============== ========
372-
mode continue remount-ro panic
373-
====================== =============== =============== ========
374-
access ops normal normal N/A
375-
syscall errors -EIO -EROFS N/A
376-
mount option rw ro N/A
377-
pending dir write keep keep N/A
378-
pending non-dir write drop keep N/A
379-
pending node write drop keep N/A
380-
pending meta write keep keep N/A
381-
====================== =============== =============== ========
374+
.. code-block:: none
375+
376+
====================== =============== =============== ========
377+
mode continue remount-ro panic
378+
====================== =============== =============== ========
379+
access ops normal normal N/A
380+
syscall errors -EIO -EROFS N/A
381+
mount option rw ro N/A
382+
pending dir write keep keep N/A
383+
pending non-dir write drop keep N/A
384+
pending node write drop keep N/A
385+
pending meta write keep keep N/A
386+
====================== =============== =============== ========
382387
nat_bits Enable nat_bits feature to enhance full/empty nat blocks access,
383388
by default it's disabled.
384389
lookup_mode=%s Control the directory lookup behavior for casefolded
385390
directories. This option has no effect on directories
386391
that do not have the casefold feature enabled.
387392

388-
================== ========================================
389-
Value Description
390-
================== ========================================
391-
perf (Default) Enforces a hash-only lookup.
392-
The linear search fallback is always
393-
disabled, ignoring the on-disk flag.
394-
compat Enables the linear search fallback for
395-
compatibility with directory entries
396-
created by older kernel that used a
397-
different case-folding algorithm.
398-
This mode ignores the on-disk flag.
399-
auto F2FS determines the mode based on the
400-
on-disk `SB_ENC_NO_COMPAT_FALLBACK_FL`
401-
flag.
402-
================== ========================================
393+
.. code-block:: none
394+
395+
================== ========================================
396+
Value Description
397+
================== ========================================
398+
perf (Default) Enforces a hash-only lookup.
399+
The linear search fallback is always
400+
disabled, ignoring the on-disk flag.
401+
compat Enables the linear search fallback for
402+
compatibility with directory entries
403+
created by older kernel that used a
404+
different case-folding algorithm.
405+
This mode ignores the on-disk flag.
406+
auto F2FS determines the mode based on the
407+
on-disk `SB_ENC_NO_COMPAT_FALLBACK_FL`
408+
flag.
409+
================== ========================================
403410
======================== ============================================================
404411

405412
Debugfs Entries

0 commit comments

Comments
 (0)