[clang] fee9480 - [clang-format] Copy help options to the doc directory.
via cfe-commits
cfe-commits at lists.llvm.org
Fri Mar 18 03:51:26 PDT 2022
Author: sstwcw
Date: 2022-03-18T10:51:36Z
New Revision: fee94803f59dbd1a5b39c51036f181246d7d2fe6
URL: https://github.com/llvm/llvm-project/commit/fee94803f59dbd1a5b39c51036f181246d7d2fe6
DIFF: https://github.com/llvm/llvm-project/commit/fee94803f59dbd1a5b39c51036f181246d7d2fe6.diff
LOG: [clang-format] Copy help options to the doc directory.
The options listed in ClangFormat.rst lag behind those output by the
-help command line option. Specifically, these are missing.
--files
--qualifier-alignment
Fixes #54418
Reviewed By: MyDeveloperDay, HazardyKnusperkeks
Differential Revision: https://reviews.llvm.org/D121890
Added:
Modified:
clang/docs/ClangFormat.rst
Removed:
################################################################################
diff --git a/clang/docs/ClangFormat.rst b/clang/docs/ClangFormat.rst
index 8c0273c8eb3c3..5fc9656a4756a 100644
--- a/clang/docs/ClangFormat.rst
+++ b/clang/docs/ClangFormat.rst
@@ -30,72 +30,69 @@ to format C/C++/Java/JavaScript/JSON/Objective-C/Protobuf/C# code.
Clang-format options:
- --Werror - If set, changes formatting warnings to errors
- --Wno-error=<value> - If set don't error out on the specified warning type.
- =unknown - If set, unknown format options are only warned about.
- This can be used to enable formatting, even if the
- configuration contains unknown (newer) options.
- Use with caution, as this might lead to dramatically
-
diff ering format depending on an option being
- supported or not.
- --assume-filename=<string> - Override filename used to determine the language.
- When reading from stdin, clang-format assumes this
- filename 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=file:<format_file_path> to load style
- configuration from a format file located at
- <format_file_path>. This path can be absolute or
- relative to the working directory.
- 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
+ --Wno-error=<value> - If set don't error out on the specified warning type.
+ =unknown - If set, unknown format options are only warned about.
+ This can be used to enable formatting, even if the
+ configuration contains unknown (newer) options.
+ Use with caution, as this might lead to dramatically
+
diff ering format depending on an option being
+ supported or not.
+ --assume-filename=<string> - Override filename used to determine the language.
+ When reading from stdin, clang-format assumes this
+ filename 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
+ --files=<string> - Provide a list of files to run clang-format
+ -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.
+ --qualifier-alignment=<string> - If set, overrides the qualifier alignment style determined by the QualifierAlignment style flag
+ --sort-includes - If set, overrides the include sorting behavior determined by the SortIncludes style flag
+ --style=<string> - Coding style, currently supports:
+ LLVM, GNU, Google, Chromium, Microsoft, 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=file:<format_file_path> to explicitly specify
+ the configuration file.
+ 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 more)
+ --version - Display the version of this program
When the desired code formatting style is
diff erent from the available options,
More information about the cfe-commits
mailing list