[PATCH] Sphinx-based clang man pages

Andrew Wilkins axwalk at gmail.com
Thu Jun 18 22:01:20 PDT 2015


Hi silvas, cmatthews,

This diff introduces .rst files, Sphinx config, and a CMake target
for building clang man pages. This will deprecate the existing .pod-
based man page, and will integrate nicely with CMake. This diff does
not remove the existing man page; that will be done in a follow-up
once packagers have had a chance to react to the change.

For now, only clang(1) has been done; others can be added over time
by dropping additional files into the docs/CommandGuide directory.
The index page for CommandGuide has been copied from LLVM's
docs/CommandGuide.

The man page itself is mostly the same, with a few minor cosmetic
changes. The only major change is the SYNOPSIS section. I was unable
to get .rst/Sphinx produce the same style as in the existing man page.
Instead, I changed it to match the LLVM tools' relatively simple style.

To build the man pages, use the "docs-clang-man" target if building
with CMake. Otherwise, use "make -f Makefile.sphinx man".

http://reviews.llvm.org/D10562

Files:
  docs/CMakeLists.txt
  docs/CommandGuide/
  docs/CommandGuide/clang.rst
  docs/CommandGuide/index.rst
  docs/conf.py
  docs/index.rst

EMAIL PREFERENCES
  http://reviews.llvm.org/settings/panel/emailpreferences/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: D10562.28005.patch
Type: text/x-patch
Size: 18799 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20150619/80b571a9/attachment.bin>


More information about the cfe-commits mailing list