aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Jasper <djasper@google.com>2013-04-17 07:55:02 +0000
committerDaniel Jasper <djasper@google.com>2013-04-17 07:55:02 +0000
commita50b57862b99bdd7d056014f429a809647257c8b (patch)
treeb5e6068cf1bdd361f1b789b1fe5ab8973a4bdc73 /docs
parente68d9e08152bd246aa1d7da02a67efea81112707 (diff)
Small improvements to clang-format documentation and integration
scripts. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@179676 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/ClangFormat.rst19
1 files changed, 17 insertions, 2 deletions
diff --git a/docs/ClangFormat.rst b/docs/ClangFormat.rst
index 92d7fc319e..1b65c2542b 100644
--- a/docs/ClangFormat.rst
+++ b/docs/ClangFormat.rst
@@ -18,7 +18,6 @@ to format C/C++/Obj-C code.
$ clang-format --help
OVERVIEW: A tool to format C/C++/Obj-C code.
- Currently supports LLVM and Google style guides.
If no arguments are specified, it formats the code from standard input
and writes the result to the standard output.
If <file> is given, it reformats the file. If -i is specified together
@@ -66,6 +65,22 @@ It operates on the current, potentially unsaved buffer and does not create
or save any files. To revert a formatting, just undo.
+Emacs Integration
+=================
+
+Similar to the integration for :program:`vim`, there is an integration for
+:program:`emacs`. It can be found at `clang/tools/clang-format/clang-format.el`
+and used by adding this to your `.emacs`:
+
+.. code-block:: common-lisp
+
+ (load "<path-to-clang>/tools/clang-format/clang-format.el")
+ (global-set-key [C-M-tab] 'clang-format-region)
+
+This binds the function `clang-format-region` to C-M-tab, which then formats the
+current line or selected region.
+
+
Script for patch reformatting
=============================
@@ -81,7 +96,7 @@ a unified diff and reformats all contained lines with :program:`clang-format`.
optional arguments:
-h, --help show this help message and exit
-p P strip the smallest prefix containing P slashes
- -style STYLE formatting style to apply (LLVM, Google)
+ -style STYLE formatting style to apply (LLVM, Google, Chromium)
So to reformat all the lines in the latest :program:`git` commit, just do: