Skip to content
  • Mauro Carvalho Chehab's avatar
    docs: kdump: convert docs to ReST and rename to *.rst · d67297ad
    Mauro Carvalho Chehab authored
    
    
    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: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
    Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
    d67297ad