* [PATCH v4] docs: f2fs: wrap ASCII tables in literal blocks to fix LaTeX build
@ 2025-11-16 10:26 Masaharu Noguchi
2025-11-17 2:39 ` Akira Yokosawa
0 siblings, 1 reply; 2+ messages in thread
From: Masaharu Noguchi @ 2025-11-16 10:26 UTC (permalink / raw)
To: jaegeuk, chao
Cc: corbet, linux-f2fs-devel, linux-doc, linux-kernel, bagasdotme,
akiyks, nogunix
Sphinx LaTeX builder fails on nested tables in f2fs.rst, producing:
“Markup is unsupported in LaTeX: longtable does not support nesting a table.”
Wrap the affected ASCII tables in literal code blocks so Sphinx renders them
verbatim. This avoids nested longtables and fixes the LaTeX build on Sphinx 8.2.x.
Changes in v4:
- Rebased on 62242ac51061
- Cleaned up Changelog placement (move version history above '---')
- Verified `make htmldocs` and `make pdfdocs` build fine
Changes in v3:
- Replace TABs inside ASCII tables with spaces
Changes in v2:
- Wrap nested ASCII tables in literal blocks and fix missing blank lines
Acked-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
Signed-off-by: Masaharu Noguchi <nogunix@gmail.com>
Link: https://www.spinics.net/lists/kernel/msg5921848.html
Link: https://www.spinics.net/lists/kernel/msg5918264.html
Link: https://www.spinics.net/lists/kernel/msg5875662.html
---
Documentation/filesystems/f2fs.rst | 131 +++++++++++++++--------------
1 file changed, 69 insertions(+), 62 deletions(-)
diff --git a/Documentation/filesystems/f2fs.rst b/Documentation/filesystems/f2fs.rst
index a8d02fe5be83..cb90d1ae82d0 100644
--- a/Documentation/filesystems/f2fs.rst
+++ b/Documentation/filesystems/f2fs.rst
@@ -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
--
2.51.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH v4] docs: f2fs: wrap ASCII tables in literal blocks to fix LaTeX build
2025-11-16 10:26 [PATCH v4] docs: f2fs: wrap ASCII tables in literal blocks to fix LaTeX build Masaharu Noguchi
@ 2025-11-17 2:39 ` Akira Yokosawa
0 siblings, 0 replies; 2+ messages in thread
From: Akira Yokosawa @ 2025-11-17 2:39 UTC (permalink / raw)
To: Masaharu Noguchi
Cc: corbet, linux-f2fs-devel, linux-doc, linux-kernel, bagasdotme,
jaegeuk, chao
On Sun, 16 Nov 2025 19:26:44 +0900, Masaharu Noguchi wrote:
> Sphinx LaTeX builder fails on nested tables in f2fs.rst, producing:
>
> “Markup is unsupported in LaTeX: longtable does not support nesting a table.”
>
> Wrap the affected ASCII tables in literal code blocks so Sphinx renders them
> verbatim. This avoids nested longtables and fixes the LaTeX build on Sphinx 8.2.x.
>
> Changes in v4:
> - Rebased on 62242ac51061
> - Cleaned up Changelog placement (move version history above '---')
This is not what I asked by saying:
These background and change history should go out of the Changelog area.
Changelog ends at '---'. See:
https://www.kernel.org/doc/html/latest/process/submitting-patches.html#commentary
> - Verified `make htmldocs` and `make pdfdocs` build fine
>
> Changes in v3:
> - Replace TABs inside ASCII tables with spaces
>
> Changes in v2:
> - Wrap nested ASCII tables in literal blocks and fix missing blank lines
>
> Acked-by: Bagas Sanjaya <bagasdotme@gmail.com>
> Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
> Signed-off-by: Masaharu Noguchi <nogunix@gmail.com>
>
> Link: https://www.spinics.net/lists/kernel/msg5921848.html
> Link: https://www.spinics.net/lists/kernel/msg5918264.html
> Link: https://www.spinics.net/lists/kernel/msg5875662.html
> ---
> Documentation/filesystems/f2fs.rst | 131 +++++++++++++++--------------
> 1 file changed, 69 insertions(+), 62 deletions(-)
./scripts/checkpatch.pl emits the following:
------------------------------------------------------------------------
WARNING: Prefer a maximum 75 chars per line (possible unwrapped commit description?)
#26:
“Markup is unsupported in LaTeX: longtable does not support nesting a table.”
ERROR: Please use git commit description style 'commit <12+ chars of sha1> ("<title line>")' - ie: 'commit 62242ac51061 ("Documentation: f2fs: Reword title")'
#32:
- Rebased on 62242ac51061
WARNING: Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html
#46:
Link: https://www.spinics.net/lists/kernel/msg5921848.html
WARNING: Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html
#47:
Link: https://www.spinics.net/lists/kernel/msg5918264.html
WARNING: Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html
#48:
Link: https://www.spinics.net/lists/kernel/msg5875662.html
------------------------------------------------------------------------
Also, please apply your patch on your own before submitting it and
see the Changelog looks good to you.
Thanks, Akira
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2025-11-17 2:39 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-11-16 10:26 [PATCH v4] docs: f2fs: wrap ASCII tables in literal blocks to fix LaTeX build Masaharu Noguchi
2025-11-17 2:39 ` Akira Yokosawa
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).