OSDN Git Service

docs: livepatch: convert docs to ReST and rename to *.rst
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Fri, 3 May 2019 14:30:23 +0000 (16:30 +0200)
committerJonathan Corbet <corbet@lwn.net>
Tue, 7 May 2019 22:05:49 +0000 (16:05 -0600)
commit89e33ea73295327f22fd1594f97cc70a5381b74a
tree0649aed30d60714ad87042cfca18ce047a21c8cc
parent894ee5ff83335659da5fc4a4b1f41fa246f32d1a
docs: livepatch: convert docs to ReST and rename to *.rst

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 <mchehab+samsung@kernel.org>
Signed-off-by: Petr Mladek <pmladek@suse.com>
Acked-by: Miroslav Benes <mbenes@suse.cz>
Acked-by: Josh Poimboeuf <jpoimboe@redhat.com>
Acked-by: Joe Lawrence <joe.lawrence@redhat.com>
Reviewed-by: Kamalesh Babulal <kamalesh@linux.vnet.ibm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/ABI/testing/sysfs-kernel-livepatch
Documentation/livepatch/callbacks.rst [moved from Documentation/livepatch/callbacks.txt with 94% similarity]
Documentation/livepatch/cumulative-patches.rst [moved from Documentation/livepatch/cumulative-patches.txt with 89% similarity]
Documentation/livepatch/index.rst [new file with mode: 0644]
Documentation/livepatch/livepatch.rst [moved from Documentation/livepatch/livepatch.txt with 93% similarity]
Documentation/livepatch/module-elf-format.rst [moved from Documentation/livepatch/module-elf-format.txt with 68% similarity]
Documentation/livepatch/shadow-vars.rst [moved from Documentation/livepatch/shadow-vars.txt with 87% similarity]
tools/objtool/Documentation/stack-validation.txt