maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/clang/docs
History
Andrew Wilkins 6238c6f09a 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
 		2015-06-30 02:52:38 +00:00
..
CommandGuide Sphinx-based clang man pages 2015-06-30 02:52:38 +00:00
analyzer Update the copyright credits -- Happy new year 2014! 2014-01-01 08:27:31 +00:00
tools Sphinx-based clang man pages 2015-06-30 02:52:38 +00:00
AddressSanitizer.rst [docs] Several updates to the Address Sanitizer webpage. 2015-06-25 23:36:44 +00:00
AttributeReference.rst Adding a title to appease the sphinx build bot. 2015-06-23 17:31:30 +00:00
AutomaticReferenceCounting.rst Allow (Object *)kMyGlobalCFObj casts without bridging 2015-02-25 20:09:06 +00:00
Block-ABI-Apple.rst Converted Block-ABI-Apple.txt => Block-ABI-Apple.rst. 2013-01-07 22:24:45 +00:00
Block-ABI-Apple.txt Converted Block-ABI-Apple.txt => Block-ABI-Apple.rst. 2013-01-07 22:24:45 +00:00
BlockLanguageSpec.rst Documentation: use monospaced font in BlockLanguageSpec, and fix a link to this 2012-12-20 20:51:59 +00:00
CMakeLists.txt Sphinx-based clang man pages 2015-06-30 02:52:38 +00:00
ClangCheck.rst Add documentation for clang-format. 2013-01-09 21:49:28 +00:00
ClangFormat.rst docs: remove double carriage-return 2014-11-02 21:27:52 +00:00
ClangFormatStyleOptions.rst clang-format: Add option to break after definition return type for top-level functions only 2015-06-29 15:30:42 +00:00
ClangPlugins.rst Remove buggy example code from the documentation 2014-01-26 05:08:07 +00:00
ClangTools.rst Document removed flags in release notes 2014-03-21 07:25:01 +00:00
ControlFlowIntegrity.rst [CFI] Require -flto instead of implying it. 2015-06-19 19:57:46 +00:00
ControlFlowIntegrityDesign.rst docs: Document byte arrays. 2015-03-12 00:30:41 +00:00
CrossCompilation.rst Fix typo in cross-compilation docs: "-fpu" -> "-mfpu" 2015-06-03 10:11:42 +00:00
DataFlowSanitizer.rst Add support for -fsanitize-blacklist and default blacklists for DFSan. 2013-08-14 18:54:18 +00:00
DataFlowSanitizerDesign.rst DataFlowSanitizer: Add a design doc paragraph on checking ABI consistency. 2013-08-22 20:08:20 +00:00
DriverArchitecture.png
…
DriverInternals.rst Correct DriverInternals.rst: ccc-print-options is gone. 2015-06-02 22:06:32 +00:00
ExternalClangExamples.rst ExternalClangExamples: add a link to ToyClangPlugin 2014-03-07 09:06:12 +00:00
FAQ.rst Documentation: fix typo: stdard -> stdarg 2013-02-07 14:48:33 +00:00
HowToSetupToolingForLLVM.rst Fix spelling error and remove the part about CMake having experimental Ninja support since 2.8.9 has been released some time ago. 2013-01-11 07:23:53 +00:00
InternalsManual.rst Made considerable updates to the documentation explaining how to add a new attribute to clang. Cleans up some of the existing wording, as well as adding new information and better explanations. 2015-05-13 18:06:48 +00:00
IntroductionToTheClangAST.rst Suggest people use -Xclang not -cc1 when passing options to the frontend. 2013-10-08 19:50:01 +00:00
JSONCompilationDatabase.rst Documentation: fix escaping in JSON example 2013-01-30 17:58:39 +00:00
LanguageExtensions.rst Protection against stack-based memory corruption errors using SafeStack: Clang command line option and function attribute 2015-06-15 21:08:13 +00:00
LeakSanitizer.rst [docs] Several updates to the Address Sanitizer webpage. 2015-06-25 23:36:44 +00:00
LibASTMatchers.rst docs: Fix up HTML links to proper reST links. 2013-01-02 13:07:47 +00:00
LibASTMatchersReference.html Add translationUnitDecl matcher. 2015-02-10 14:46:45 +00:00
LibASTMatchersTutorial.rst Fix typo in tutorial. 2015-06-02 22:40:27 +00:00
LibFormat.rst Add documentation for clang-format. 2013-01-09 21:49:28 +00:00
LibTooling.rst Update documentation to match recent API change. newFrontendActionFactory now returns a unique_ptr. 2014-05-01 20:04:39 +00:00
MSVCCompatibility.rst Fix some glitches in the MSVCCompatibility document 2015-05-07 07:48:16 +00:00
Makefile Sphinx-based clang man pages 2015-06-30 02:52:38 +00:00
Makefile.sphinx docs: Copy Block-ABI-Apple.txt to output. 2013-01-07 21:46:35 +00:00
MemorySanitizer.rst [msan] Change track-origins default mode from 1 to 2. 2015-02-26 15:59:30 +00:00
Modules.rst Fix "the the" in comments/documentation/etc. 2015-06-19 01:52:53 +00:00
ObjectiveCLiterals.rst Fix typo. NFC. 2015-06-27 19:04:55 +00:00
PCHInternals.rst Revert "Wrap clang module files in a Mach-O, ELF, or COFF container." 2015-02-25 02:44:04 +00:00
PCHLayout.graffle
…
PCHLayout.png
…
PTHInternals.rst PTHInternals.rst: PCH is now a thing, update docs to reflect it 2014-07-07 14:02:39 +00:00
RAVFrontendAction.rst Update the documentation for API change to CreateASTConsumer the rest of the way. 2014-10-22 23:57:14 +00:00
README.txt Add docs/README.txt to point to llvm/docs/README.txt. 2013-01-02 23:25:41 +00:00
ReleaseNotes.rst Fixing an RST issue to silence a sphinx warning. 2015-05-26 19:56:13 +00:00
SafeStack.rst docs: Fix bad link in SafeStack.rst. 2015-06-25 21:02:17 +00:00
SanitizerCoverage.rst Update docs for SanitizerCoverage. 2015-05-07 23:04:19 +00:00
SanitizerSpecialCaseList.rst Clean up language and grammar. 2014-05-20 17:10:39 +00:00
ThreadSafetyAnalysis.rst Updating the documentation to include an operator! for negative capability support. 2015-05-22 13:36:48 +00:00
ThreadSanitizer.rst [docs] Recommend to use CMake for building sanitizers. 2015-02-18 22:26:20 +00:00
Tooling.rst docs: "clang tools" are not a different interface. 2013-01-08 04:42:09 +00:00
UsersManual.rst [CFI] Require -flto instead of implying it. 2015-06-19 19:57:46 +00:00
conf.py Sphinx-based clang man pages 2015-06-30 02:52:38 +00:00
doxygen.cfg.in [docs] Update the doxygen configuration file. 2015-03-12 17:27:53 +00:00
doxygen.intro
…
index.rst Sphinx-based clang man pages 2015-06-30 02:52:38 +00:00
make.bat docs: Initial Sphinx setup for Clang. 2012-12-12 23:02:30 +00:00

README.txt 

See llvm/docs/README.txt