[Xen-devel] [PATCH 00/11] Convert a few docs/misc pages into man pages

[Cédric Bosdonnat <cbosdonnat@xxxxxxxx>]

As pointed out in Ian and Andrew's emails on my recent docs improvement
attempt, getting the documents from docs/misc referenced in man pages
as man pages would would make these pages more visible for users. This
would also not break the docs html INDEX.

This series adds ability to write markdown man pages. Be aware that
markdown man pages can't link to other man pages.

I also added some pages to man 7 (Misc) section.

Cédric Bosdonnat (11):
  docs: allow writing man pages in markdown
  docs: add rules for man 7 section
  docs: xl-network-configuration turns into a man
  docs: convert xl-disk-configuration into a man page
  docs: move vbd-interface from misc to man
  docs: move xl-numa-placement.markdown to man7
  docs: move vtpm from misc to man
  docs: convert vtpmmgr into a pod man page
  docs: convert misc/channel.txt into xen-pv-channel man page
  docs: move pci-device-reservations from misc to man
  docs: convert tscmode.txt into man page

 .gitignore                                         |   1 +
 docs/INDEX                                         |   5 -
 docs/Makefile                                      |  57 ++-
 docs/{misc/tscmode.txt => man/tscmode.pod.7}       | 109 +++--
 .../vbd-interface.markdown.7}                      |   0
 docs/{misc/vtpm.txt => man/vtpm.pod.7}             | 364 +++++++-------
 docs/{misc/vtpmmgr.txt => man/vtpmmgr.pod.7}       | 351 ++++++++------
 docs/man/xen-pci-device-reservations.pod.7         |  84 ++++
 .../channel.txt => man/xen-pv-channel.markdown.7}  |  20 +-
 docs/man/xl-disk-configuration.pod.5               | 529 +++++++++++++++++++++
 .../xl-network-configuration.markdown.5}           |   0
 .../xl-numa-placement.markdown.7}                  |   0
 docs/man/xl.cfg.pod.5.in                           |  21 +-
 docs/man/xl.pod.1.in                               |  11 +-
 docs/misc/pci-device-reservations.txt              |  58 ---
 docs/misc/xl-disk-configuration.txt                | 359 --------------
 16 files changed, 1162 insertions(+), 807 deletions(-)
 rename docs/{misc/tscmode.txt => man/tscmode.pod.7} (89%)
 rename docs/{misc/vbd-interface.txt => man/vbd-interface.markdown.7} (100%)
 rename docs/{misc/vtpm.txt => man/vtpm.pod.7} (57%)
 rename docs/{misc/vtpmmgr.txt => man/vtpmmgr.pod.7} (54%)
 create mode 100644 docs/man/xen-pci-device-reservations.pod.7
 rename docs/{misc/channel.txt => man/xen-pv-channel.markdown.7} (92%)
 create mode 100644 docs/man/xl-disk-configuration.pod.5
 rename docs/{misc/xl-network-configuration.markdown => 
man/xl-network-configuration.markdown.5} (100%)
 rename docs/{misc/xl-numa-placement.markdown => 
man/xl-numa-placement.markdown.7} (100%)
 delete mode 100644 docs/misc/pci-device-reservations.txt
 delete mode 100644 docs/misc/xl-disk-configuration.txt

-- 
2.11.0


_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
https://lists.xen.org/xen-devel