r177729 - Update docs after moving clang-format from clang-tools-extra to cfe.

Daniel Jasper djasper at google.com
Fri Mar 22 05:44:20 PDT 2013


Author: djasper
Date: Fri Mar 22 07:44:20 2013
New Revision: 177729

URL: http://llvm.org/viewvc/llvm-project?rev=177729&view=rev
Log:
Update docs after moving clang-format from clang-tools-extra to cfe.

Modified:
    cfe/trunk/docs/ClangFormat.rst

Modified: cfe/trunk/docs/ClangFormat.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/ClangFormat.rst?rev=177729&r1=177728&r2=177729&view=diff
==============================================================================
--- cfe/trunk/docs/ClangFormat.rst (original)
+++ cfe/trunk/docs/ClangFormat.rst Fri Mar 22 07:44:20 2013
@@ -10,9 +10,8 @@ standalone tool and editor integrations.
 Standalone Tool
 ===============
 
-:program:`clang-format` is part of the `clang/tools/extra` (see
-:doc:`ClangTools <ClangTools>`) repository and can be used to format
-C/C++/Obj-C code.
+:program:`clang-format` is located in `clang/tools/clang-format` and can be used
+to format C/C++/Obj-C code.
 
 .. code-block:: console
 
@@ -35,7 +34,7 @@ C/C++/Obj-C code.
     -length=<int>             - Format a range of this length, -1 for end of file.
     -offset=<int>             - Format a range starting at this file offset.
     -stats                    - Enable statistics output from program
-    -style=<string>           - Coding style, currently supports: LLVM, Google.
+    -style=<string>           - Coding style, currently supports: LLVM, Google, Chromium.
     -version                  - Display the version of this program
 
 
@@ -45,18 +44,18 @@ Vim Integration
 There is an integration for :program:`vim` which lets you run the
 :program:`clang-format` standalone tool on your current buffer, optionally
 selecting regions to reformat. The integration has the form of a `python`-file
-which can be found under `clang/tools/extra/clang-format/clang-format.py`.
+which can be found under `clang/tools/clang-format/clang-format.py`.
 
 This can be integrated by adding the following to your `.vimrc`:
 
 .. code-block:: vim
 
-  map <C-I> :pyf <path-to-this-file>/clang-format.py<CR>
-  imap <C-I> <ESC>:pyf <path-to-this-file>/clang-format.py<CR>i
+  map <C-K> :pyf <path-to-this-file>/clang-format.py<CR>
+  imap <C-K> <ESC>:pyf <path-to-this-file>/clang-format.py<CR>i
 
 The first line enables :program:`clang-format` for NORMAL and VISUAL mode, the
-second line adds support for INSERT mode. Change "C-I" to another binding if
-you need :program:`clang-format` on a different key (C-I stands for Ctrl+i).
+second line adds support for INSERT mode. Change "C-K" to another binding if
+you need :program:`clang-format` on a different key (C-K stands for Ctrl+k).
 
 With this integration you can press the bound key and clang-format will
 format the current line in NORMAL and INSERT mode or the selected region in
@@ -70,7 +69,7 @@ or save any files. To revert a formattin
 Script for patch reformatting
 =============================
 
-The python script `clang/tools/extra/clang-format-diff.py` parses the output of
+The python script `clang/tools/clang-format-diff.py` parses the output of
 a unified diff and reformats all contained lines with :program:`clang-format`.
 
 .. code-block:: console





More information about the cfe-commits mailing list