From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pf1-f178.google.com (mail-pf1-f178.google.com [209.85.210.178]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 611783246FF for ; Tue, 11 Nov 2025 13:04:00 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.178 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1762866242; cv=none; b=F4BtVm2e2jZ9mgJNKczrwscP3aPMFGDPiqyqW1BKor8X3RYlPWFZi8tCJ8BDvQRCKEHVz8YU5V7RSZvK6l8jNep/Pf3s+r0FtxgxbC+cK0TVG9NVHG9iaylcT9meXz15FwbKYprUU3dHPEmYmtnh1R0b5LhfJdHpBef5F1ZKBQk= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1762866242; c=relaxed/simple; bh=usfAPbPnDwiWzpmUk70Fe8p4bCbppbDN/yF4Q24vmEQ=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=Bxh5Mw4vv0+pjPS0fD636zDE0716QJn32XOazPBngjAvbXkPLzdYN/vrGsoGLNKM+5K1JbduH+1IyLuXKmCH4VSRS7lIswZbcS11CeDR4ILjNhMVw3Czuqg0/mJxaxYSnbORntZ6c+eNRHKEoMzuD2oQvFn9DTxoz9wTpJmhc6A= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=lLBwYwpq; arc=none smtp.client-ip=209.85.210.178 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="lLBwYwpq" Received: by mail-pf1-f178.google.com with SMTP id d2e1a72fcca58-7a432101882so249737b3a.3 for ; Tue, 11 Nov 2025 05:04:00 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1762866239; x=1763471039; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=6ozXRud7hnbH/C6N6bIIB2OSxH4nIfZC/nZQgtGIV7s=; b=lLBwYwpqjN2jCu1S93DRaWqBUYgPgDxR3OBiJ2nplQZIvCAOLzErZaBSstYQAZ1UXn jfdaLZPUNEDbXZLPh2bLcw0KVdvVnoZUDc8CUxPP5ycxEaKKVJ2C4+rkCnTmEIt7+mCS 5aV5dKfBnz0oLvK+SPFTdEOhzX8GMb82360S2c6QZ7VzhVwqrnfJxyB/SyT1SVQep8lq rK7x94pu6YiMkm3dYh1dUlgi4YbfZTStLBNcBd6AxA35YYv98E1d3JWlZA/80jkhO0Aw bUrMRhRABDHt2PVYPt1Huw0hMnQEqdrjGDME9+a2RY6KjErZpInr7XzcZw16sOyNfSCr 7kPQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1762866239; x=1763471039; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=6ozXRud7hnbH/C6N6bIIB2OSxH4nIfZC/nZQgtGIV7s=; b=stBOyLEgz1nsvl5l9btno0xYwMlmJvFM5S1iDFnSC9gijXInOF9UrXQOsJ4Jz2M1Lf r6wZ/pQCNbkuKHIFrvTpyXidULwhd4WYXBD7UHtv3UW7fvrNWN6IVggD4PdzbW+dap0m SItK0NQlWNudQfxBYgiOI3jSEj45tbDkVuADOXiLe2THdqaLwgUNwU2iY5WvgTYPjDhb cwwA49Zee6GOj7EYdzNG0jphLkcbgllodfA44OdQx4wl+iG0I25mk6rPXpS4Ka8iCdLb tffmTsY8MiuixaxXU05LqY9ongK42RFN35pabmkqf6hbcCYmN6Wsg1hTRponCjotsLmz XSbQ== X-Forwarded-Encrypted: i=1; AJvYcCVUFMYpbAyDlCpa7L//0CDYpy2V/f8b6U9SRuFaU9FDFG1KpISiL5k+QsExxLY/JTSzH6PtSO6qEeU=@vger.kernel.org X-Gm-Message-State: AOJu0YxvquLnZu5mCGwyymTIPehurL6szqaJU7fJ2TiQa4ESdbJu/7AM mg8ZMXirKLFXTwAC6Pa7oBJ9uAJYcxvEDiN/VAsx5I0aXmRGP67jNinY X-Gm-Gg: ASbGncuSv6a+i4z+zz58XrrSkdb9o0510lX6ZlDLOHGHs22pEMAIL/cYv541kH1VENQ tzL4WYs2IR8KoXSARHNeUzkUVxDPWgCQDH1T5yKZgZx81M1GQzbK4WfKE9kfiukSn+wmmMP/g6T o1bv1bMgJwAhOa8OUqHnf37ZxJ38A9w410icWCztybzUXu6K37mNlT76IJCURyalFO07dGawCe8 ZIdyBnaVVJyKyjNXyIMaKjZ+K8teZq5gRLg2QNJLk5LeSAI/CeBgPanO0DUkgS2zo1ZR3RjWx3I MyP/GsrN/v1Ec9rOTSxEjr7CBYo/yuUrpp6Bqe1hY3tv1Yb4f/paKTydyiMqId05JRsQjEyk0LS HJfBlalBXvMsXTnMSR0la3c9exp2YVPEadTBNs9VZTdzf/fNbycj7GhQcml3GCWUN6U6N+4lhLt vcWmmVxSKPznkkGqUH5g== X-Google-Smtp-Source: AGHT+IHu4EywhajIUey4lbULY1rrvTzR5HGvXc4GreqR0sPeWXBldY1/v7wftHXonsc2QxGK9vnrZg== X-Received: by 2002:a05:6a00:4fcb:b0:77f:1a6a:e72b with SMTP id d2e1a72fcca58-7b226e825d4mr7474236b3a.5.1762866239288; Tue, 11 Nov 2025 05:03:59 -0800 (PST) Received: from elitemini.flets-east.jp ([2400:4050:d860:9700:75bf:9e2e:8ac9:3001]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-7b0ccb5a517sm15010286b3a.57.2025.11.11.05.03.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 11 Nov 2025 05:03:58 -0800 (PST) From: Masaharu Noguchi To: jaegeuk@kernel.org, chao@kernel.org Cc: corbet@lwn.net, linux-f2fs-devel@lists.sourceforge.net, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, akiyks@gmail.com, bagasdotme@gmail.com, nogunix@gmail.com Subject: [PATCH v3] Documentation: f2fs: wrap tables in literal code blocks Date: Tue, 11 Nov 2025 22:00:39 +0900 Message-ID: <20251111130349.3856302-1-nogunix@gmail.com> X-Mailer: git-send-email 2.51.1 Precedence: bulk X-Mailing-List: linux-doc@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Hi Akira and Bagas, As suggested, I replaced TABs inside the ASCII tables with white spaces for better readability. No other content changes were made. Thanks for your reviews and acks. Best regards, Masaharu Noguchi --- Sphinx LaTeX builder fails with the following error when it tries to turn the ASCII tables in f2fs.rst into nested longtables: Markup is unsupported in LaTeX: filesystems/f2fs:: longtable does not support nesting a table. Wrap the tables in literal code blocks so that Sphinx renders them as verbatim text instead. This prevents the LaTeX builder from attempting unsupported table nesting and fixes the pdfdocs build. Akira Yokosawa pointed out that the in-development Sphinx 8.3 latex builder already handles these nested tables. I still want to fix the current documentation because Sphinx 8.3 is not released yet, and the LaTeX build on the stable 8.2.x series (which also requires "docutils<0.22" for now) remains broken without this change. Link: https://lore.kernel.org/lkml/20251011172415.114599-1-nogunix@gmail.com/ Changes in v2: - wrap the compression level table in a literal block and add the missing blank lines so docutils no longer warns about malformed tables - consistently use ``.. code-block:: none`` for the other ASCII tables that previously triggered the LaTeX error Changes in v3: - Replace TABs inside ASCII tables with white spaces for readability - Keep Reviewed-by and Acked-by tags as the technical content remains unchanged Acked-by: Bagas Sanjaya Reviewed-by: Akira Yokosawa Signed-off-by: Masaharu Noguchi --- Documentation/filesystems/f2fs.rst | 115 +++++++++++++++-------------- 1 file changed, 61 insertions(+), 54 deletions(-) diff --git a/Documentation/filesystems/f2fs.rst b/Documentation/filesystems/f2fs.rst index a8d02fe5be83..1de0bc83d76e 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. + .. 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 + 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 + auto F2FS determines the mode based on the on-disk `SB_ENC_NO_COMPAT_FALLBACK_FL` flag. - ================== ======================================== + ================== ======================================== ======================== ============================================================ Debugfs Entries -- 2.51.1 From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.sourceforge.net (lists.sourceforge.net [216.105.38.7]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 39D5BCCFA18 for ; Tue, 11 Nov 2025 13:04:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.sourceforge.net; s=beta; h=Content-Transfer-Encoding:Content-Type:Cc: List-Subscribe:List-Help:List-Post:List-Archive:List-Unsubscribe:List-Id: Subject:MIME-Version:Message-ID:Date:To:From:Sender:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Owner; bh=+3acAQo0ikwtZbKPmpUO6adTlCW78UMW4ayFtcHpokY=; b=U5yIeSCH+B/MajJRy9gUNKcMNP HrmnKao5Lf6nYEHPBv8JcMgqP0Fy68qEQsRts+RtVNim6HXLFTPfQEeSKWPU7vphdpdkjyNFSgdpS 21vj1rC78VKfjCO6pTKg6S1JhKEVuHU5/YCI8y+/PaDB6NS+2ur/PFHl6A+mg9tk1YQ0=; Received: from [127.0.0.1] (helo=sfs-ml-2.v29.lw.sourceforge.com) by sfs-ml-2.v29.lw.sourceforge.com with esmtp (Exim 4.95) (envelope-from ) id 1vIo2Y-0000Kq-03; Tue, 11 Nov 2025 13:04:06 +0000 Received: from [172.30.29.66] (helo=mx.sourceforge.net) by sfs-ml-2.v29.lw.sourceforge.com with esmtps (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1vIo2X-0000Kf-24 for linux-f2fs-devel@lists.sourceforge.net; Tue, 11 Nov 2025 13:04:06 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; h=Content-Transfer-Encoding:MIME-Version:Message-ID: Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=6ozXRud7hnbH/C6N6bIIB2OSxH4nIfZC/nZQgtGIV7s=; b=kgz0DAyEgSUADNruvxLgbl5xkB oNoOT3CHOU5Pl2iXTUDnf26IwcQ/cagWD7Bg2+9pUcrduvPU0ok3EsjGdN3ImMY4PJVsycneyz61l OdZcyr8Nmprn7UhAaBseQ7UHZEsujcOye6yA3EzO2+i6KHkQq5yDSwraZogx0GKFrKs0=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=Content-Transfer-Encoding:MIME-Version:Message-ID:Date:Subject:Cc:To:From :Sender:Reply-To:Content-Type:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To: References:List-Id:List-Help:List-Unsubscribe:List-Subscribe:List-Post: List-Owner:List-Archive; bh=6ozXRud7hnbH/C6N6bIIB2OSxH4nIfZC/nZQgtGIV7s=; b=f JxmDdU0nk29nEGG4wjGjTs+AOtcDmsZEjzWmKtVuUUF7hzwaDs7BsOccFMPoZQU/40ttPIKvIWcOK we/EeHTUM9KePBsHC/ZWTcOogz3kN0gL6RABW2t2Dkg8ICv6w8xw1YgimHIQbNxv1xgvFLgZbwm3v adK/dppJCEgOmWcs=; Received: from mail-pf1-f169.google.com ([209.85.210.169]) by sfi-mx-2.v28.lw.sourceforge.com with esmtps (TLS1.2:ECDHE-RSA-AES128-GCM-SHA256:128) (Exim 4.95) id 1vIo2X-0006z6-6k for linux-f2fs-devel@lists.sourceforge.net; Tue, 11 Nov 2025 13:04:05 +0000 Received: by mail-pf1-f169.google.com with SMTP id d2e1a72fcca58-7aee3b3a7faso244028b3a.0 for ; Tue, 11 Nov 2025 05:04:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1762866239; x=1763471039; darn=lists.sourceforge.net; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=6ozXRud7hnbH/C6N6bIIB2OSxH4nIfZC/nZQgtGIV7s=; b=MDzZmFK96sqhgFY8hAnahSau+UyzCjdbMtu9Frck3TH8YiT0+wxWa5Yo7n7TT/1krJ HAVX2iyjGpIjpr639DcTiEENRvMCJ/bKLj0fNd0x/S7i4Sr9mc6LB0oWR3wu0JQCH8xX FP4FM0ttzGmFNdLPoikgDqHmkYCyJkM6dL0Ny+NyVQYsNfnhERPHCOAhdak1rly7mufV epiCg0ebIsDzwSRfBnnRZY9X1u+jXjGwUJg4Tli1K7tfFoeF8odJFPkw7ehhvYHfZFgj BgGrJ59EDfW38Y9OXNXuHK8LnSfmnqMlAhxB+RB4FRccczaheMEbsO+ySYR9U89C5PlB A0Vg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1762866239; x=1763471039; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=6ozXRud7hnbH/C6N6bIIB2OSxH4nIfZC/nZQgtGIV7s=; b=H2E991Wz9MkDwR4XUVTCWKiWhdgzIYFVU7a+dQ1jxX/LpXycak81FzDZSY05OkJuOs V3JY9hKN3wRKsF5h2C+cmExJLQb5apvt9LN0zU3FxiOSYXpB6bSU3zYMWM1v1w/MXSz7 M8qkCzx2JZcIsYuwz0TLNgf85+9byCQnlXoNJCuCp9LIpB1R1NNUbcyYo5FEC+ULDNvG 0hbOVRZruF4s6uNJWp5DoTGk3XCIiVIEVy6T2+uASMnjkDfrCfcpwxKhogTQNuIhN1cj FP+YNYUxaKeSEaMmvqcjcJYPsRIZI2vFNvJch1dlsX7gqe8DW85xH23MYRLR0idB/8+L vo6g== X-Forwarded-Encrypted: i=1; AJvYcCVprye8ayLZx4hj3+vLXUjwsDJghTAKVS6gf4RGjHhuIvXuT/MSX76fynJtfplIVL7ISl+VSpEPl8WhDrxfwpIc@lists.sourceforge.net X-Gm-Message-State: AOJu0Yz4SkHOO87QwgdjascnRiedatEfLAoqSa29pNJKBoJn6zEprmym RhiBrNDvI751zpG1UIUjIbXVAsZOUoeZyUAv8Xcp10Aj4JtaF/L2wMjo X-Gm-Gg: ASbGncsJTqpK13VGMKpJ7aVALFeZ58NMEYVeMo7KKJ5KqhLReWY6dNkuZeFEVlmJRWr UKSM3cehWOcrhAtYw2o1HGojxHJidFrvkPATLtlbq+at5NIEM2lFRcb3Jw/IMeZtPwd1B8REo/c OOErOmAdM6dzhGqVBXWN8h3o1S5D9FS3vWjl7+JiuyLyk4rBnDQiL+3V6CWaAPEeBIgFU90wCH5 qB24GgL7conksKwJrsaH3FBfM77hL/FXEIFMN6qi8A4iSarcRatuLGEFbzWOk0zg6SXYNW8XkVn /I61J3nx7F6+fBqfAbq/ovCyEEwk4nLv+hy3tE6QPVuHzn6ihs6+hgSVH/xl+b+br26yDRNdLpS sthhyhmo4H/hn76rrqc5VyXEZ+yfLAvQjUqadFrYO0F4Ng1R5plKlbfXeKbe6SagnVLnGfW1dx6 y+nRSgOtvGWT8apLXgYA== X-Google-Smtp-Source: AGHT+IHu4EywhajIUey4lbULY1rrvTzR5HGvXc4GreqR0sPeWXBldY1/v7wftHXonsc2QxGK9vnrZg== X-Received: by 2002:a05:6a00:4fcb:b0:77f:1a6a:e72b with SMTP id d2e1a72fcca58-7b226e825d4mr7474236b3a.5.1762866239288; Tue, 11 Nov 2025 05:03:59 -0800 (PST) Received: from elitemini.flets-east.jp ([2400:4050:d860:9700:75bf:9e2e:8ac9:3001]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-7b0ccb5a517sm15010286b3a.57.2025.11.11.05.03.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 11 Nov 2025 05:03:58 -0800 (PST) From: Masaharu Noguchi To: jaegeuk@kernel.org, chao@kernel.org Date: Tue, 11 Nov 2025 22:00:39 +0900 Message-ID: <20251111130349.3856302-1-nogunix@gmail.com> X-Mailer: git-send-email 2.51.1 MIME-Version: 1.0 X-Headers-End: 1vIo2X-0006z6-6k Subject: [f2fs-dev] [PATCH v3] Documentation: f2fs: wrap tables in literal code blocks X-BeenThere: linux-f2fs-devel@lists.sourceforge.net X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: corbet@lwn.net, nogunix@gmail.com, linux-doc@vger.kernel.org, akiyks@gmail.com, linux-kernel@vger.kernel.org, linux-f2fs-devel@lists.sourceforge.net, bagasdotme@gmail.com Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-f2fs-devel-bounces@lists.sourceforge.net Hi Akira and Bagas, As suggested, I replaced TABs inside the ASCII tables with white spaces for better readability. No other content changes were made. Thanks for your reviews and acks. Best regards, Masaharu Noguchi --- Sphinx LaTeX builder fails with the following error when it tries to turn the ASCII tables in f2fs.rst into nested longtables: Markup is unsupported in LaTeX: filesystems/f2fs:: longtable does not support nesting a table. Wrap the tables in literal code blocks so that Sphinx renders them as verbatim text instead. This prevents the LaTeX builder from attempting unsupported table nesting and fixes the pdfdocs build. Akira Yokosawa pointed out that the in-development Sphinx 8.3 latex builder already handles these nested tables. I still want to fix the current documentation because Sphinx 8.3 is not released yet, and the LaTeX build on the stable 8.2.x series (which also requires "docutils<0.22" for now) remains broken without this change. Link: https://lore.kernel.org/lkml/20251011172415.114599-1-nogunix@gmail.com/ Changes in v2: - wrap the compression level table in a literal block and add the missing blank lines so docutils no longer warns about malformed tables - consistently use ``.. code-block:: none`` for the other ASCII tables that previously triggered the LaTeX error Changes in v3: - Replace TABs inside ASCII tables with white spaces for readability - Keep Reviewed-by and Acked-by tags as the technical content remains unchanged Acked-by: Bagas Sanjaya Reviewed-by: Akira Yokosawa Signed-off-by: Masaharu Noguchi --- Documentation/filesystems/f2fs.rst | 115 +++++++++++++++-------------- 1 file changed, 61 insertions(+), 54 deletions(-) diff --git a/Documentation/filesystems/f2fs.rst b/Documentation/filesystems/f2fs.rst index a8d02fe5be83..1de0bc83d76e 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. + .. 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 + 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 + auto F2FS determines the mode based on the on-disk `SB_ENC_NO_COMPAT_FALLBACK_FL` flag. - ================== ======================================== + ================== ======================================== ======================== ============================================================ Debugfs Entries -- 2.51.1 _______________________________________________ Linux-f2fs-devel mailing list Linux-f2fs-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel