maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/clang-tools-extra/docs/index.rst

48 lines
1.3 KiB
ReStructuredText
Raw Normal View History

Initial docs directory Adding a new docs directory, with files auto-generated by sphinx-quickstart, for user documentation for the various tools in the clang-tools-extra repository. Author: Jack Yang <jack.yang@intel.com> Reviewers: gribozavr, silvas llvm-svn: 175118
2013-02-14 09:34:59 +08:00
.. Extra Clang Tools documentation master file, created by
sphinx-quickstart on Wed Feb 13 10:00:18 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. title:: Welcome to Extra Clang Tools's documentation!
Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267
2013-03-01 00:46:40 +08:00
Introduction
============
Welcome to clang-tools-exta project which contains extra tools built using Clang's tooling API's
Initial docs directory Adding a new docs directory, with files auto-generated by sphinx-quickstart, for user documentation for the various tools in the clang-tools-extra repository. Author: Jack Yang <jack.yang@intel.com> Reviewers: gribozavr, silvas llvm-svn: 175118
2013-02-14 09:34:59 +08:00
Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267
2013-03-01 00:46:40 +08:00
Contents
========
Initial docs directory Adding a new docs directory, with files auto-generated by sphinx-quickstart, for user documentation for the various tools in the clang-tools-extra repository. Author: Jack Yang <jack.yang@intel.com> Reviewers: gribozavr, silvas llvm-svn: 175118
2013-02-14 09:34:59 +08:00
.. toctree::
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046
2013-02-26 04:37:03 +08:00
:maxdepth: 1
Rename cpp11-migrate to clang-modernize. There is no reason to expect this tool to be limited to C++11, it seems very likely to be of on-going interest. It seems likely to be useful for modernizing even as new libraries come out in TSes and other formats than a complete standard. Fundamentally, we need something a bit more general. After some discussion on the list, going with 'clang-modernize'. I've tried to do a reasonably comprehensive job of fixing up the names, but I may still have missed some. Feel free to poke me if you spot any fallout here. Things I've tried reasonably hard to find and fix: - cpp11-migrate -> clang-modernize - Migrator -> Modernizer - Clean up the introductory documentation that was C++11 specific. I'll also point out that this tool continues to delight me. =] Also, a huge thanks to those who have so carefully, thoroughly documented the tool. The docs here are simply phenomenal. Every tool should be this well documented. I hope I have updated the documentation reasonably well, but I'm not very good at documentation, so review much appreciated. llvm-svn: 189960
2013-09-05 01:35:07 +08:00
clang-modernize
Adding documentation for clang-tidy. Summary: Contains a short user's manual and some instructions on writing clang-tidy checks. Reviewers: klimek, djasper Reviewed By: klimek CC: cfe-commits Differential Revision: http://llvm-reviews.chandlerc.com/D2880 llvm-svn: 202164
2014-02-26 00:46:13 +08:00
clang-tidy
Added modularize documentation. llvm-svn: 191091
2013-09-20 22:40:52 +08:00
modularize
Initial checkin of new module-map-checker tool. llvm-svn: 198693
2014-01-07 23:22:08 +08:00
module-map-checker
pp-trace user documentation - beginnings llvm-svn: 193841
2013-11-01 08:38:04 +08:00
pp-trace
Initial docs directory Adding a new docs directory, with files auto-generated by sphinx-quickstart, for user documentation for the various tools in the clang-tools-extra repository. Author: Jack Yang <jack.yang@intel.com> Reviewers: gribozavr, silvas llvm-svn: 175118
2013-02-14 09:34:59 +08:00
Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267
2013-03-01 00:46:40 +08:00
Doxygen Documentation
=====================
[docs] Clarify wording. "This documentation" could be construed as the entire c-t-e docs (despite being under a doxygen heading; people read "locally" sometimes), which gives a bad impression. llvm-svn: 176849
2013-03-12 10:40:05 +08:00
The Doxygen documentation describes the **internal** software that makes up the
tools of clang-tools-extra, not the **external** use of these tools. The
Doxygen documentation contains no instructions about how to use the tools,
only the APIs that make up the software. For usage instructions, please see
the user's guide or reference manual for each tool.
Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267
2013-03-01 00:46:40 +08:00
* `Doxygen documentation`_
Point doxygen link to somthing useful. llvm-svn: 190607
2013-09-12 23:26:44 +08:00
.. _`Doxygen documentation`: doxygen/annotated.html
Add doxygen support for the tools in clang-tools-extra Patch by Ariel Bernal. llvm-svn: 176267
2013-03-01 00:46:40 +08:00
.. note::
This documentation is generated directly from the source code with doxygen.
Since the tools of clang-tools-extra are constantly under active development,
what you're about to read is out of date!
Initial docs directory Adding a new docs directory, with files auto-generated by sphinx-quickstart, for user documentation for the various tools in the clang-tools-extra repository. Author: Jack Yang <jack.yang@intel.com> Reviewers: gribozavr, silvas llvm-svn: 175118
2013-02-14 09:34:59 +08:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`