forked from OSchip/llvm-project
clang-format: refresh the list of options
This commit is contained in:
Sylvestre Ledru
parent
99e2cba219
commit
3a3255a223
|
|
@ -30,54 +30,61 @@ to format C/C++/Java/JavaScript/Objective-C/Protobuf/C# code.
|
|||
|
||||
Clang-format options:
|
||||
|
||||
-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}"
|
||||
-verbose - If set, shows the list of processed files
|
||||
--Werror - If set, changes formatting warnings to errors
|
||||
--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
|
||||
--dry-run - If set, do not actually make the formatting changes
|
||||
--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.
|
||||
--ferror-limit=<uint> - Set the maximum number of clang-format errors to
|
||||
emit before stopping (0 = no limit). Used only
|
||||
with --dry-run or -n
|
||||
-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.
|
||||
-n - Alias for --dry-run
|
||||
--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 - If set, overrides the include sorting behavior
|
||||
determined by the SortIncludes style flag
|
||||
--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}"
|
||||
--verbose - If set, shows the list of processed files
|
||||
|
||||
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
|
||||
--help - Display available options (--help-hidden for more)
|
||||
--help-list - Display list of available options (--help-list-hidden for moOAre)
|
||||
--version - Display the version of this program
|
||||
|
||||
|
||||
When the desired code formatting style is different from the available options,
|
||||
|
|
|
|||
Loading…
Reference in New Issue