diff options
author | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2019-05-03 17:30:23 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2019-05-08 01:05:49 +0300 |
commit | 89e33ea73295327f22fd1594f97cc70a5381b74a (patch) | |
tree | 0649aed30d60714ad87042cfca18ce047a21c8cc /tools/objtool/Documentation | |
parent | 894ee5ff83335659da5fc4a4b1f41fa246f32d1a (diff) | |
download | linux-89e33ea73295327f22fd1594f97cc70a5381b74a.tar.xz |
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>
Diffstat (limited to 'tools/objtool/Documentation')
-rw-r--r-- | tools/objtool/Documentation/stack-validation.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/tools/objtool/Documentation/stack-validation.txt b/tools/objtool/Documentation/stack-validation.txt index 3995735a878f..8df526c80b65 100644 --- a/tools/objtool/Documentation/stack-validation.txt +++ b/tools/objtool/Documentation/stack-validation.txt @@ -111,7 +111,7 @@ c) Higher live patching compatibility rate be detectable). Objtool makes that possible. For more details, see the livepatch documentation in the Linux kernel - source tree at Documentation/livepatch/livepatch.txt. + source tree at Documentation/livepatch/livepatch.rst. Rules ----- |