diff mbox series

[1/3] btrfs-progs: fix doc compile error in CHANGES file

Message ID e4fda6ed6633a59f6a8424c93c1b4a1362acfa28.1731998908.git.anand.jain@oracle.com (mailing list archive)
State New
Headers show
Series btrfs-progs: fix documentation build errors | expand

Commit Message

Anand Jain Nov. 19, 2024, 6:56 a.m. UTC
On python3-sphinx 7.2.6. and python3-sphinx_rtd_theme 2.0.0 there are
build errors.

Making all in Documentation
    [SPHINX] man
../CHANGES:26: ERROR: Unexpected indentation.
../CHANGES:29: WARNING: Block quote ends without a blank line; unexpected unindent.
../CHANGES:204: ERROR: Unexpected indentation.
../CHANGES:205: WARNING: Block quote ends without a blank line; unexpected unindent.

Fix them by adjusting the indentation in the CHANGES file. The sublist
should be indented two spaces further than the main list.

Signed-off-by: Anand Jain <anand.jain@oracle.com>
---
 CHANGES                             | 22 +++++-----
 Documentation/Kernel-by-version.rst | 68 ++++++++++++++---------------
 2 files changed, 45 insertions(+), 45 deletions(-)
diff mbox series

Patch

diff --git a/CHANGES b/CHANGES
index e2eed4b4390d..d7f326c450e1 100644
--- a/CHANGES
+++ b/CHANGES
@@ -22,10 +22,10 @@  btrfs-progs-6.11 (2024-09-17)
 btrfs-progs-6.10 (2024-07-30)
 -----------------------------
    * inspect:
-     * list-chunks: new command to print information about chunks (i.e.
-       the physical chunks as stored on devices), sortable; requires root as
-       it's using SEARCH_TREE ioctl
-     * tree-stats:
+      * list-chunks: new command to print information about chunks (i.e.
+        the physical chunks as stored on devices), sortable; requires root as
+        it's using SEARCH_TREE ioctl
+      * tree-stats:
         * new option -t to print only the given tree
         * add long options for size units
    * filesystem df: with increased verbosity print per-type information from sysfs
@@ -199,13 +199,13 @@  btrfs-progs-6.6 (2023-11-03)
      future)
    * dump-tree: output sequence number for inline refs
    * fixes:
-     * fi resize: fallback to lowest devid when 1 does not exist, previously the
-       command would fail with "No such device"
-     * fi usage: fix "devices 0 != 1" message and broken output on multi-device
-       filesystem
-     * open files in non-blocking mode when reading fsid, this could hang when
-       trying to open fifo files or some special character devices, was observed
-       with 'prop set/get'
+      * fi resize: fallback to lowest devid when 1 does not exist, previously the
+        command would fail with "No such device"
+      * fi usage: fix "devices 0 != 1" message and broken output on multi-device
+        filesystem
+      * open files in non-blocking mode when reading fsid, this could hang when
+        trying to open fifo files or some special character devices, was observed
+        with 'prop set/get'
    * experimental:
       * mkfs: parametric zone size for emulated zoned mode
    * other:
diff --git a/Documentation/Kernel-by-version.rst b/Documentation/Kernel-by-version.rst
index c76a9c040115..d1adc3ee6ebf 100644
--- a/Documentation/Kernel-by-version.rst
+++ b/Documentation/Kernel-by-version.rst
@@ -512,20 +512,20 @@  Pull requests:
 Core changes:
 
 -  convert extent buffers to folios:
-   - direct API conversion where possible
-   - performance can drop by a few percent on metadata heavy
-     workloads, the folio sizes are not constant and the calculations
-     add up in the item helpers
-   - both regular and subpage modes
-   - data cannot be converted yet, we need to port that to iomap and
-     there are some other generic changes required
+    - direct API conversion where possible
+    - performance can drop by a few percent on metadata heavy
+      workloads, the folio sizes are not constant and the calculations
+      add up in the item helpers
+    - both regular and subpage modes
+    - data cannot be converted yet, we need to port that to iomap and
+      there are some other generic changes required
 
 -  convert mount to the new API, should not be user visible:
-   - options deprecated long time ago have been removed: inode_cache,
-     recovery
-   - the new logic that splits mount to two phases slightly changes
-     timing of device scanning for multi-device filesystems
-   - LSM options will now work (like for selinux)
+    - options deprecated long time ago have been removed: inode_cache,
+      recovery
+    - the new logic that splits mount to two phases slightly changes
+      timing of device scanning for multi-device filesystems
+    - LSM options will now work (like for selinux)
 
 - convert delayed nodes radix tree to xarray, preserving the
   preload-like logic that still allows to allocate with GFP_NOFS
@@ -576,9 +576,9 @@  Performance improvements:
   delayed allocation bits, applies to several common workload types
 
 - features under CONFIG_BTRFS_DEBUG:
-  - sysfs knob for setting the how checksums are calculated when submitting IO,
-    inline or offloaded to a thread, this affects latency and throughput on some
-    block group profiles
+   - sysfs knob for setting the how checksums are calculated when submitting IO,
+     inline or offloaded to a thread, this affects latency and throughput on some
+     block group profiles
 
 Notable fixes:
 
@@ -644,29 +644,29 @@  Pull requests:
 User visible features:
 
 - dynamic block group reclaim:
-  - tunable framework to avoid situations where eager data allocations prevent
-    creating new metadata chunks due to lack of unallocated space
-  - reuse sysfs knob bg_reclaim_threshold (otherwise used only in zoned mode)
-    for a fixed value threshold
-  - new on/off sysfs knob "dynamic_reclaim" calculating the value based on
-    heuristics, aiming to keep spare working space for relocating chunks but
-    not to needlessly relocate partially utilized block groups or reclaim newly
-    allocated ones
-  - stats are exported in sysfs per block group type, files "reclaim_*"
-  - this may increase IO load at unexpected times but the corner case of no
-    allocatable block groups is known to be worse
+   - tunable framework to avoid situations where eager data allocations prevent
+     creating new metadata chunks due to lack of unallocated space
+   - reuse sysfs knob bg_reclaim_threshold (otherwise used only in zoned mode)
+     for a fixed value threshold
+   - new on/off sysfs knob "dynamic_reclaim" calculating the value based on
+     heuristics, aiming to keep spare working space for relocating chunks but
+     not to needlessly relocate partially utilized block groups or reclaim newly
+     allocated ones
+   - stats are exported in sysfs per block group type, files "reclaim_*"
+   - this may increase IO load at unexpected times but the corner case of no
+     allocatable block groups is known to be worse
 
 - automatically remove qgroup of deleted subvolumes:
-  - adjust qgroup removal conditions, make sure all related subvolume data are
-    already removed, or return EBUSY, also take into account setting of sysfs
-    drop_subtree_threshold
-  - also works in squota mode
+   - adjust qgroup removal conditions, make sure all related subvolume data are
+     already removed, or return EBUSY, also take into account setting of sysfs
+     drop_subtree_threshold
+   - also works in squota mode
 
 -  mount option updates: new modes of 'rescue=' that allow to mount images
-   (read-only) that could have been partially converted by user space tools
-  - ignoremetacsums  - invalid metadata checksums are ignored
-  - ignoresuperflags - super block flags that track conversion in progress
-                       (like UUID or checksums)
+    (read-only) that could have been partially converted by user space tools
+     - ignoremetacsums  - invalid metadata checksums are ignored
+     - ignoresuperflags - super block flags that track conversion in progress
+                          (like UUID or checksums)
 
 Other notable changes or fixes: