[clang-format] Copy help options to the doc directory.

[sstwcw]

Summary

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

[sstwcw]

If anyone's wondering why all the lines changed. The --qualifier-alignment is too long so all the descriptions are moved to the right.

[curdeius]

clang/docs/ClangFormat.rst

76

Shouldn't long descriptions like this one be split into multiple lines and aligned with -?
Did you do it by hand or with some script?

[sstwcw]

clang/docs/ClangFormat.rst

76

It was not split in the -help output. I copied the output from a terminal by hand. If you run clang-format -help from the latest git build in an 80-column terminal you will see that output is all over the place. The options that were broken into lines have hard line breaks lin clang/tools/clang-format/ClangFormat.cpp. But now with the --qualifier-alignment option being too wide even those got pushed over 80 columns.

[MyDeveloperDay]

1. Please log a github issue showing us what you are fixing.
2. Please add the main clang-formatter developers as reviewers and not the clang-format project (I think we see it but I like to see the individual reviewers so I know there opinion)
3. How about you change this so it autogenerates the rst so its never out of date.

[sstwcw]

The issue is #54418.

Actually I don't know who I should add as reviewers. The patches for clang-format don't always seem to have the same reviewers. Who are the main developers and how do you decide who you add each time?

I give up making the doc generated. It would require either integrating into the build process or writing a parser script like for the style options. Besides, that file is not entirely generated.

[owenpan]

In D121890#3389171, @sstwcw wrote:

The issue is #54418.

Actually I don't know who I should add as reviewers. The patches for clang-format don't always seem to have the same reviewers. Who are the main developers and how do you decide who you add each time?

We have been adding @MyDeveloperDay @curdeius @HazardyKnusperkeks as reviewers to your patches. For JavaScript, you should add @krasimir too.

[MyDeveloperDay]

In D121890#3389171, @sstwcw wrote:

The issue is #54418.

Actually I don't know who I should add as reviewers. The patches for clang-format don't always seem to have the same reviewers. Who are the main developers and how do you decide who you add each time?

I give up making the doc generated. It would require either integrating into the build process or writing a parser script like for the style options. Besides, that file is not entirely generated.

ok neither is ClangFormatStyleOptions.rts, but also the doc/tools/dump_format_style.py is also something thats not part of the build, but just a tool we can run to ensure the Format.h and ClangFormatStryleOptions.rst stay in lock step.

So actually I think that's a good task for someone to do, but its not necessary to do it here, but actually I think I'd prefer to see that than having to keep this the same by hand. I clearly missed that step. (so I appreciate you adding it)

clang/docs/ClangFormat.rst

.. code-block:: console
   result is written to the standard output.
 
   USAGE: clang-format [options] [<file> ...]
 
   OPTIONS:
 
   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.
+    --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
                                        differing format depending on an option being
                                        supported or not.
-    --assume-filename=<string> - Override filename used to determine the language.
+    --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
+    --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.
+    --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-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).
+    --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=<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.
+    -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.
+    --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 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=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
+    --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 different from the available options,
 the style can be customized using the ``-style="{key: value, ...}"`` option or
 by putting your style configuration in the ``.clang-format`` or ``_clang-format``
 file in your project's directory and using ``clang-format -style=file``.
 
 An easy way to create the ``.clang-format`` file is: