mirror of
https://github.com/capstone-engine/llvm-capstone.git
synced 2025-02-19 09:26:59 +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
86 lines
1.4 KiB
ReStructuredText
86 lines
1.4 KiB
ReStructuredText
.. Clang documentation master file, created by
|
|
sphinx-quickstart on Sun Dec 9 20:01:55 2012.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
.. title:: Welcome to Clang's documentation!
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
ReleaseNotes
|
|
|
|
Using Clang as a Compiler
|
|
=========================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
UsersManual
|
|
LanguageExtensions
|
|
AttributeReference
|
|
CrossCompilation
|
|
ThreadSafetyAnalysis
|
|
AddressSanitizer
|
|
ThreadSanitizer
|
|
MemorySanitizer
|
|
DataFlowSanitizer
|
|
LeakSanitizer
|
|
SanitizerCoverage
|
|
SanitizerSpecialCaseList
|
|
ControlFlowIntegrity
|
|
SafeStack
|
|
Modules
|
|
MSVCCompatibility
|
|
CommandGuide/index
|
|
FAQ
|
|
|
|
Using Clang as a Library
|
|
========================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Tooling
|
|
ExternalClangExamples
|
|
IntroductionToTheClangAST
|
|
LibTooling
|
|
LibFormat
|
|
ClangPlugins
|
|
RAVFrontendAction
|
|
LibASTMatchersTutorial
|
|
LibASTMatchers
|
|
HowToSetupToolingForLLVM
|
|
JSONCompilationDatabase
|
|
|
|
Using Clang Tools
|
|
=================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
ClangTools
|
|
ClangCheck
|
|
ClangFormat
|
|
ClangFormatStyleOptions
|
|
|
|
Design Documents
|
|
================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
InternalsManual
|
|
DriverInternals
|
|
PTHInternals
|
|
PCHInternals
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|