hanchenye-llvm-project/clang-tools-extra/docs
Kirill Bobyrev e5e7e153b5 [clang-rename] Merge rename-{at|all} & optimise.
Having both rename-at and rename-all both seems confusing and introduces
unneeded difficulties. After merging rename-at and rename-all maintaining main
function wrappers and custom help becomes redundant while CLI becomes less
confusing.

D24224 (which was the original patch causing buildbot failures) wasn't aware of
bugs caused by passing both -offset and -qualified-name. After D24224 was landed
it caused buildbot failures and therefor I just reverted it.

Two things that make this patch different from D24224 are:

* unittests/clang-rename was deleted, because it is unmaintained and doesn't do
much.
* Passing both `-offset` and `-qualified-name` isn't allowed anymore for the
sake of preventing bugs.

This patch is a trivial enhancement of accepted D24224 revision.

Tested with `ninja check-all`.

Differential Revision: https://reviews.llvm.org/D24567

llvm-svn: 281710
2016-09-16 08:45:19 +00:00
..
clang-tidy [clang-tidy] Add check 'misc-use-after-move' 2016-09-14 10:29:32 +00:00
CMakeLists.txt Add clang-tools-extra documentation to the CMake build. 2016-01-27 11:37:08 +00:00
Doxyfile [clang-tidy] Move clang-tidy docs to a separate directory. Create doc files for checks 2015-08-27 18:10:07 +00:00
ModularizeUsage.rst Added mechanism to modularize for doing a compilation precheck 2015-07-10 00:37:25 +00:00
README.txt
ReleaseNotes.rst [Release notes] Mention readability-container-size-empty improvements. 2016-09-14 17:41:51 +00:00
clang-modernize.rst Orphaning these RST files; each one is retained only for link backwards compatibility. 2015-12-28 19:59:15 +00:00
clang-rename.rst [clang-rename] Merge rename-{at|all} & optimise. 2016-09-16 08:45:19 +00:00
clang-tidy.rst [clang-tidy] Use relative URL for redirection. 2016-01-27 11:37:12 +00:00
conf.py docs/conf.py: update version to 4.0 2016-07-18 18:13:46 +00:00
cpp11-migrate.rst Orphaning these RST files; each one is retained only for link backwards compatibility. 2015-12-28 19:59:15 +00:00
doxygen-mainpage.dox [docs] Fix docs to work with doxygen 1.8.11 2016-03-03 10:45:59 +00:00
doxygen.cfg.in [clang-tidy] Fix doxygen errors. NFC. 2016-06-17 11:43:33 +00:00
include-fixer.rst [Documentation] Improve consistency. 2016-08-10 22:00:49 +00:00
index.rst [clang-rename] add documentation 2016-07-14 09:46:07 +00:00
make.bat
modularize.rst Fixing a sphinx warning. 2015-09-28 19:27:37 +00:00
pp-trace.rst fix some minor typos in the doc 2016-03-03 20:57:16 +00:00

README.txt

-------------------------------------------------------------
Documentation for the tools of clang-tools-extra repo project
-------------------------------------------------------------

Sphinx and doxygen documentation is generated by executing make.

Sphinx html files can be generated separately using make html.

Doxygen html files can also be generated using make doxygen.

The generated documentation will be placed in _build/html.