]> asedeno.scripts.mit.edu Git - linux.git/commit
docs: kdump: convert docs to ReST and rename to *.rst
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Wed, 12 Jun 2019 17:52:49 +0000 (14:52 -0300)
committerJonathan Corbet <corbet@lwn.net>
Fri, 14 Jun 2019 20:21:24 +0000 (14:21 -0600)
commitd67297ad343ec02a88f947b45526c92d2870aed3
tree28ff575112250a804d5e6d9737f0c5709e57a885
parentcd238effefa28fac177e51dcf5e9d1a8b59c3c6b
docs: kdump: convert docs to ReST and rename to *.rst

Convert kdump documentation to ReST and add it to the
user faced manual, as the documents are mainly focused on
sysadmins that would be enabling kdump.

Note: the vmcoreinfo.rst has one very long title on one of its
sub-sections:

PG_lru|PG_private|PG_swapcache|PG_swapbacked|PG_slab|PG_hwpoision|PG_head_mask|PAGE_BUDDY_MAPCOUNT_VALUE(~PG_buddy)|PAGE_OFFLINE_MAPCOUNT_VALUE(~PG_offline)

I opted to break this one, into two entries with the same content,
in order to make it easier to display after being parsed in html and PDF.

The conversion is actually:
  - add blank lines and identation in order to identify paragraphs;
  - fix tables markups;
  - add some lists markups;
  - mark literal blocks;
  - 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: Jonathan Corbet <corbet@lwn.net>
12 files changed:
Documentation/admin-guide/bug-hunting.rst
Documentation/admin-guide/kernel-parameters.txt
Documentation/kdump/index.rst [new file with mode: 0644]
Documentation/kdump/kdump.rst [moved from Documentation/kdump/kdump.txt with 91% similarity]
Documentation/kdump/vmcoreinfo.rst [moved from Documentation/kdump/vmcoreinfo.txt with 95% similarity]
Documentation/powerpc/firmware-assisted-dump.txt
Documentation/translations/zh_CN/oops-tracing.txt
Documentation/watchdog/hpwdt.txt
arch/arm/Kconfig
arch/arm64/Kconfig
arch/sh/Kconfig
arch/x86/Kconfig