mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-29 20:46:06 +00:00
6238c6f09a
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
18 lines
509 B
ReStructuredText
18 lines
509 B
ReStructuredText
Clang "man" pages
|
|
-----------------
|
|
|
|
The following documents are command descriptions for all of the Clang tools.
|
|
These pages describe how to use the Clang commands and what their options are.
|
|
Note that these pages do not describe all of the options available for all
|
|
tools. To get a complete listing, pass the ``--help`` (general options) or
|
|
``--help-hidden`` (general and debugging options) arguments to the tool you are
|
|
interested in.
|
|
|
|
Basic Commands
|
|
~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
clang
|