08 May, 2019
2 commits
-
Make the structure of "Livepatch module Elf format" document similar
to the main "Livepatch" document.Also make the structure of "(Un)patching Callbacks" document similar
to the "Shadow Variables" document.It fixes the most visible inconsistencies of the documentation
generated from the ReST format.Signed-off-by: Petr Mladek
Acked-by: Joe Lawrence
Acked-by: Josh Poimboeuf
Acked-by: Miroslav Benes
Reviewed-by: Mauro Carvalho Chehab
Reviewed-by: Kamalesh Babulal
Signed-off-by: Jonathan Corbet -
Convert livepatch documentation to ReST format. The changes
are mostly trivial, as the documents are already on a good
shape. Just a few markup changes are needed for Sphinx to
properly parse the docs.The conversion is actually:
- add blank lines and identation in order to identify paragraphs;
- fix tables markups;
- add some lists markups;
- mark literal blocks;
- The in-file TOC becomes a comment, in order to skip it from the
output, as Sphinx already generates an index there.
- adjust title markups.At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Petr Mladek
Acked-by: Miroslav Benes
Acked-by: Josh Poimboeuf
Acked-by: Joe Lawrence
Reviewed-by: Kamalesh Babulal
Signed-off-by: Jonathan Corbet
