Re: [PATCH] docs: livepatch: move text out of code block

[Vincenzo Mezzela]

On 2/27/25 4:48 PM, Jonathan Corbet wrote:

Vincenzo MEZZELA <vincenzo.mezz...@suse.com> writes:

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.mezz...@suse.com>
---
  Documentation/livepatch/module-elf-format.rst | 17 ++++++++++++-----
  1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/Documentation/livepatch/module-elf-format.rst 
b/Documentation/livepatch/module-elf-format.rst
index a03ed02ec57e..eadcff224335 100644
--- a/Documentation/livepatch/module-elf-format.rst
+++ b/Documentation/livepatch/module-elf-format.rst
@@ -217,16 +217,23 @@ 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:
+
+::

The right fix here is to just delete the extra ":"

    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:
+
+::

You can put that extra colon here rather than introducing a separate
"::" line.

Hi,

You are right. I'll send an updated version.


Thanks for the feedback,

Vincenzo