summaryrefslogtreecommitdiffstats
path: root/clang/docs/ClangTools.rst
diff options
context:
space:
mode:
authorDaniel Jasper <djasper@google.com>2013-01-09 21:49:28 +0000
committerDaniel Jasper <djasper@google.com>2013-01-09 21:49:28 +0000
commit85a77c16095d08542cc880bb386a42d7e06a7c1e (patch)
tree7bb7ba50e17605824ddc55c73c5c904000675b61 /clang/docs/ClangTools.rst
parentd8ffe75ad155bb261cf64665d35118dc54a0c56d (diff)
downloadbcm5719-llvm-85a77c16095d08542cc880bb386a42d7e06a7c1e.tar.gz
bcm5719-llvm-85a77c16095d08542cc880bb386a42d7e06a7c1e.zip
Add documentation for clang-format.
This adds documentation for both LibFormat as well as the standalone tools and integrations built on top of it. It slightly restructures the ClangTools documentation. llvm-svn: 172004
Diffstat (limited to 'clang/docs/ClangTools.rst')
-rw-r--r--clang/docs/ClangTools.rst35
1 files changed, 23 insertions, 12 deletions
diff --git a/clang/docs/ClangTools.rst b/clang/docs/ClangTools.rst
index 3839e703dba..8d5f10000c4 100644
--- a/clang/docs/ClangTools.rst
+++ b/clang/docs/ClangTools.rst
@@ -1,9 +1,9 @@
-===========
-Clang Tools
-===========
+========
+Overview
+========
Clang Tools are standalone command line (and potentially GUI) tools
-design for use by C++ developers who are already using and enjoying
+designed for use by C++ developers who are already using and enjoying
Clang as their compiler. These tools provide developer-oriented
functionality such as fast syntax checking, automatic formatting,
refactoring, etc.
@@ -73,14 +73,25 @@ tools that very specifically compliment, and allow use and testing of
``clang-check``
---------------
-This tool combines the LibTooling framework for running a Clang tool
-with the basic Clang diagnostics by syntax checking specific files in a
-fast, command line interface. It can also accept flags to re-display the
-diagnostics in different formats with different flags, suitable for use
-driving an IDE or editor. Furthermore, it can be used in fixit-mode to
-directly apply fixit-hints offered by clang.
-
-FIXME: Link to user-oriented clang-check documentation.
+:doc:`ClangCheck` combines the LibTooling framework for running a
+Clang tool with the basic Clang diagnostics by syntax checking specific files
+in a fast, command line interface. It can also accept flags to re-display the
+diagnostics in different formats with different flags, suitable for use driving
+an IDE or editor. Furthermore, it can be used in fixit-mode to directly apply
+fixit-hints offered by clang. See :doc:`HowToSetupToolingForLLVM` for
+instructions on how to setup and used `clang-check`.
+
+``clang-format``
+~~~~~~~~~~~~~~~~
+
+Clang-format is both a :doc:`library <LibFormat>` and a :doc:`stand-alone tool
+<ClangFormat>` with the goal of automatically reformatting C++ sources files
+according to configurable style guides. To do so, clang-format users Clang's
+Lexer to transform an input file into a token stream and then changes all the
+whitespace around those tokens. The goal is for clang-format to both serve
+both as a user tool (ideally with powerful IDE integrations) and part of other
+refactoring tools, e.g. to do a reformatting of all the lines changed during a
+renaming.
Extra Clang Tools
=================
OpenPOWER on IntegriCloud