[PATCH] D135115: [clang-format] update --files help description

[Owen Pan via Phabricator via cfe-commits]

Herald added a subscriber: wangpc.
Herald added a reviewer: rymiel.
Herald added a comment.

NOTE: Clang-Format Team Automated Review Comment

It looks like your clang-format review does not contain any unit tests, please try to ensure all code changes have a unit test (unless this is an `NFC` or refactoring, adding documentation etc..)

Add your unit tests in `clang/unittests/Format` and you can build with `ninja FormatTests`.  We recommend using the `verifyFormat(xxx)` format of unit tests rather than `EXPECT_EQ` as this will ensure you change is tolerant to random whitespace changes (see FormatTest.cpp as an example)

For situations where your change is altering the TokenAnnotator.cpp which can happen if you are trying to improve the annotation phase to ensure we are correctly identifying the type of a token, please add a token annotator test in `TokenAnnotatorTest.cpp`



================
Comment at: clang/docs/ClangFormat.rst:29
 
-  USAGE: clang-format [options] [<file> ...]
+  USAGE: clang-format [options] [@<file>] [<file> ...]
 
----------------
We should not modify the file directly. See below.


================
Comment at: clang/docs/ClangFormat.rst:72-73
                                      Used only with --dry-run or -n
-    --files=<string>               - Provide a list of files to run clang-format
+    --files=<filename>             - A file containing a list of files to process, one
+                                     per line.
     -i                             - Inplace edit <file>s, if specified.
----------------
It should be edited in `ClangFormat.cpp` as this file is generated by `dump_format_help.py`.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D135115/new/

https://reviews.llvm.org/D135115