diff mbox series

[2/3] btrfs-progs: fix doc build issue caused by confusion between BTRFS_ and target

Message ID 7012a74c15837c8efe1675bb38fe404556835537.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 
Text ending with `_` is treated as an anonymous hyperlink. Use an escape
character `\` to prevent this.

Making all in Documentation
    [SPHINX] man
btrfs-progs/Documentation/dev/On-disk-format.rst:32: ERROR: Unknown target name: "btrfs".

Signed-off-by: Anand Jain <anand.jain@oracle.com>
---
 Documentation/dev/On-disk-format.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/Documentation/dev/On-disk-format.rst b/Documentation/dev/On-disk-format.rst
index b3304032651b..39fdaf09b98b 100644
--- a/Documentation/dev/On-disk-format.rst
+++ b/Documentation/dev/On-disk-format.rst
@@ -30,7 +30,7 @@  also contains a logical reference to root nodes in the root and chunk trees,
 which can then be used to locate all the other trees and data stored.
 
 To avoid duplicated suffixes/prefixes, sometimes the macro name will have
-the "BTRFS_" prefix and "_OBJECTID" suffix removed.
+the "BTRFS\_" prefix and "_OBJECTID" suffix removed.
 
 E.g. "BTRFS_DEV_ITEMS_OBJECTID" (0x1) can be shown as "DEV_ITEMS" for short,
 this matches the output of "btrfs inspect-internal dump-tree".