]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
docs: livepatch: move text out of code block
authorVincenzo MEZZELA <vincenzo.mezzela@suse.com>
Thu, 27 Feb 2025 16:39:29 +0000 (17:39 +0100)
committerPetr Mladek <pmladek@suse.com>
Tue, 4 Mar 2025 15:01:29 +0000 (16:01 +0100)
Part of the documentation text is included in the readelf output code
block. Hence, split the code block and move the affected text outside.

Signed-off-by: Vincenzo MEZZELA <vincenzo.mezzela@suse.com>
Acked-by: Miroslav Benes <mbenes@suse.cz>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20250227163929.141053-1-vincenzo.mezzela@suse.com
Signed-off-by: Petr Mladek <pmladek@suse.com>
Documentation/livepatch/module-elf-format.rst

index a03ed02ec57e219092b9b843fc44db6a9c5c375d..5d48778d4dfc2b8177a3fce6b0737d3b930b38c5 100644 (file)
@@ -217,16 +217,19 @@ livepatch relocation section refer to their respective symbols with their symbol
 indices, and the original symbol indices (and thus the symtab ordering) must be
 preserved in order for apply_relocate_add() to find the right symbol.
 
-For example, take this particular rela from a livepatch module:::
+For example, take this particular rela from a livepatch module::
 
   Relocation section '.klp.rela.btrfs.text.btrfs_feature_attr_show' at offset 0x2ba0 contains 4 entries:
       Offset             Info             Type               Symbol's Value  Symbol's Name + Addend
   000000000000001f  0000005e00000002 R_X86_64_PC32          0000000000000000 .klp.sym.vmlinux.printk,0 - 4
 
-  This rela refers to the symbol '.klp.sym.vmlinux.printk,0', and the symbol index is encoded
-  in 'Info'. Here its symbol index is 0x5e, which is 94 in decimal, which refers to the
-  symbol index 94.
-  And in this patch module's corresponding symbol table, symbol index 94 refers to that very symbol:
+This rela refers to the symbol '.klp.sym.vmlinux.printk,0', and the symbol
+index is encoded in 'Info'. Here its symbol index is 0x5e, which is 94 in
+decimal, which refers to the symbol index 94.
+
+And in this patch module's corresponding symbol table, symbol index 94 refers
+to that very symbol::
+
   [ snip ]
   94: 0000000000000000     0 NOTYPE  GLOBAL DEFAULT OS [0xff20] .klp.sym.vmlinux.printk,0
   [ snip ]