Commit 7af6fbdd authored by Mark Brown's avatar Mark Brown Committed by Jiri Kosina
Browse files

Documentation: livepatch: Convert to automatically generated contents 



Automatically generate the tables of contents for livepatch documentation
files that have tables of contents rather than open coding them so things
are a little easier to maintain.

Signed-off-by: default avatarMark Brown <broonie@kernel.org>
Acked-by: default avatarJosh Poimboeuf <jpoimboe@redhat.com>
Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
parent 0cd7d979

Documentation/livepatch/livepatch.rst

+1 −14
Original line number Diff line number Diff line
@@ -6,20 +6,7 @@ This document outlines basic information about kernel livepatching. 


.. Table of Contents:



    1. Motivation

    2. Kprobes, Ftrace, Livepatching

    3. Consistency model

    4. Livepatch module

       4.1. New functions

       4.2. Metadata

    5. Livepatch life-cycle

       5.1. Loading

       5.2. Enabling

       5.3. Replacing

       5.4. Disabling

       5.5. Removing

    6. Sysfs

    7. Limitations

.. contents:: :local:





1. Motivation

Documentation/livepatch/module-elf-format.rst

+2 −8
Original line number Diff line number Diff line
@@ -7,14 +7,8 @@ This document outlines the Elf format requirements that livepatch modules must f 


.. Table of Contents



   1. Background and motivation

   2. Livepatch modinfo field

   3. Livepatch relocation sections

      3.1 Livepatch relocation section format

   4. Livepatch symbols

      4.1 A livepatch module's symbol table

      4.2 Livepatch symbol format

   5. Symbol table and Elf section access

.. contents:: :local:





1. Background and motivation

============================