diff options
| author | Dimitry Andric <dim@FreeBSD.org> | 2015-12-30 11:49:41 +0000 | 
|---|---|---|
| committer | Dimitry Andric <dim@FreeBSD.org> | 2015-12-30 11:49:41 +0000 | 
| commit | 45b533945f0851ec234ca846e1af5ee1e4df0b6e (patch) | |
| tree | 0a5b74c0b9ca73aded34df95c91fcaf3815230d8 /docs/ClangFormat.rst | |
| parent | 7e86edd64bfae4e324224452e4ea879b3371a4bd (diff) | |
Vendor import of clang trunk r256633:vendor/clang/clang-trunk-r256633
Diffstat (limited to 'docs/ClangFormat.rst')
| -rw-r--r-- | docs/ClangFormat.rst | 87 | 
1 files changed, 48 insertions, 39 deletions
| diff --git a/docs/ClangFormat.rst b/docs/ClangFormat.rst index 45ea32717995..b4968ef1036f 100644 --- a/docs/ClangFormat.rst +++ b/docs/ClangFormat.rst @@ -16,7 +16,7 @@ to format C/C++/Obj-C code.  .. code-block:: console    $ clang-format -help -  OVERVIEW: A tool to format C/C++/Obj-C code. +  OVERVIEW: A tool to format C/C++/Java/JavaScript/Objective-C/Protobuf code.    If no arguments are specified, it formats the code from standard input    and writes the result to the standard output. @@ -30,44 +30,53 @@ to format C/C++/Obj-C code.    Clang-format options: -    -cursor=<uint>           - The position of the cursor when invoking -                               clang-format from an editor integration -    -dump-config             - Dump configuration options to stdout and exit. -                               Can be used with -style option. -    -i                       - Inplace edit <file>s, if specified. -    -length=<uint>           - Format a range of this length (in bytes). -                               Multiple ranges can be formatted by specifying -                               several -offset and -length pairs. -                               When only a single -offset is specified without -                               -length, clang-format will format up to the end -                               of the file. -                               Can only be used with one input file. -    -lines=<string>          - <start line>:<end line> - format a range of -                               lines (both 1-based). -                               Multiple ranges can be formatted by specifying -                               several -lines arguments. -                               Can't be used with -offset and -length. -                               Can only be used with one input file. -    -offset=<uint>           - Format a range starting at this byte offset. -                               Multiple ranges can be formatted by specifying -                               several -offset and -length pairs. -                               Can only be used with one input file. -    -output-replacements-xml - Output replacements as XML. -    -style=<string>          - Coding style, currently supports: -                                 LLVM, Google, Chromium, Mozilla, WebKit. -                               Use -style=file to load style configuration from -                               .clang-format file located in one of the parent -                               directories of the source file (or current -                               directory for stdin). -                               Use -style="{key: value, ...}" to set specific -                               parameters, e.g.: -                                 -style="{BasedOnStyle: llvm, IndentWidth: 8}" - -  General options: - -    -help                    - Display available options (-help-hidden for more) -    -help-list               - Display list of available options (-help-list-hidden for more) -    -version                 - Display the version of this program +    -assume-filename=<string> - When reading from stdin, clang-format assumes this +                                filename to look for a style config file (with +                                -style=file) and to determine the language. +    -cursor=<uint>            - The position of the cursor when invoking +                                clang-format from an editor integration +    -dump-config              - Dump configuration options to stdout and exit. +                                Can be used with -style option. +    -fallback-style=<string>  - The name of the predefined style used as a +                                fallback in case clang-format is invoked with +                                -style=file, but can not find the .clang-format +                                file to use. +                                Use -fallback-style=none to skip formatting. +    -i                        - Inplace edit <file>s, if specified. +    -length=<uint>            - Format a range of this length (in bytes). +                                Multiple ranges can be formatted by specifying +                                several -offset and -length pairs. +                                When only a single -offset is specified without +                                -length, clang-format will format up to the end +                                of the file. +                                Can only be used with one input file. +    -lines=<string>           - <start line>:<end line> - format a range of +                                lines (both 1-based). +                                Multiple ranges can be formatted by specifying +                                several -lines arguments. +                                Can't be used with -offset and -length. +                                Can only be used with one input file. +    -offset=<uint>            - Format a range starting at this byte offset. +                                Multiple ranges can be formatted by specifying +                                several -offset and -length pairs. +                                Can only be used with one input file. +    -output-replacements-xml  - Output replacements as XML. +    -sort-includes            - Sort touched include lines +    -style=<string>           - Coding style, currently supports: +                                  LLVM, Google, Chromium, Mozilla, WebKit. +                                Use -style=file to load style configuration from +                                .clang-format file located in one of the parent +                                directories of the source file (or current +                                directory for stdin). +                                Use -style="{key: value, ...}" to set specific +                                parameters, e.g.: +                                  -style="{BasedOnStyle: llvm, IndentWidth: 8}" + +  Generic Options: + +    -help                     - Display available options (-help-hidden for more) +    -help-list                - Display list of available options (-help-list-hidden for more) +    -version                  - Display the version of this program  When the desired code formatting style is different from the available options, | 
