diff options
author | Andrew Wilkins <axwalk@gmail.com> | 2015-06-30 02:52:38 +0000 |
---|---|---|
committer | Andrew Wilkins <axwalk@gmail.com> | 2015-06-30 02:52:38 +0000 |
commit | 6238c6f09a8795b888ebf90d24adc169ebfa5242 (patch) | |
tree | c089e56a7396a2e59aa202a58982621ad62663e9 /clang/docs/index.rst | |
parent | a106faaf09091d6a769e8818c24691f9453bcdd5 (diff) | |
download | bcm5719-llvm-6238c6f09a8795b888ebf90d24adc169ebfa5242.tar.gz bcm5719-llvm-6238c6f09a8795b888ebf90d24adc169ebfa5242.zip |
Sphinx-based clang man pages
Summary:
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".
Reviewers: cmatthews, silvas
Subscribers: dim, gaeke, beanz, cfe-commits
Differential Revision: http://reviews.llvm.org/D10562
llvm-svn: 241037
Diffstat (limited to 'clang/docs/index.rst')
-rw-r--r-- | clang/docs/index.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/clang/docs/index.rst b/clang/docs/index.rst index dec2bc828c1..d50667d5669 100644 --- a/clang/docs/index.rst +++ b/clang/docs/index.rst @@ -32,6 +32,7 @@ Using Clang as a Compiler SafeStack Modules MSVCCompatibility + CommandGuide/index FAQ Using Clang as a Library |