[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation

[Carlos Galvez via Phabricator via cfe-commits]

carlosgalvezp created this revision.
Herald added subscribers: arphaman, xazax.hun.
Herald added a reviewer: njames93.
Herald added a project: All.
carlosgalvezp requested review of this revision.
Herald added a project: clang-tools-extra.
Herald added a subscriber: cfe-commits.

- Specify that the .clang-tidy file is in YAML format.
- Document the options that may be used in the .clang-tidy file,
- Add missing documentation for existing options (User).
- Fix output example of --dump-config (incorrect format of CheckOptions).
- Fix spurious newline after the dash that comes after every command-line option. This was inconsistent with single-line descriptions, which lacked a newline. The description is now aligned with the dash and the corresponding command-line option, more visually pleasing.

This will enable documenting upcoming global clang-tidy
configuration options.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D141144

Files:
  clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
  clang-tools-extra/docs/clang-tidy/index.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D141144.486911.patch
Type: text/x-patch
Size: 28146 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20230106/a5a6ae14/attachment-0001.bin>