[all-commits] [llvm/llvm-project] 270691: [clang-tidy][doc] Improve clang-tidy documentation

Carlos Galvez via All-commits all-commits at lists.llvm.org
Thu Feb 9 04:20:58 PST 2023

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 2706919f91977f3859ad625d4fb624fb04857e4f
  Author: Carlos Galvez <carlosgalvezp at gmail.com>
  Date:   2023-02-09 (Thu, 09 Feb 2023)

  Changed paths:
    M clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
    M clang-tools-extra/docs/clang-tidy/index.rst

  Log Message:
  [clang-tidy][doc] Improve clang-tidy documentation

- 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 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 enables documenting upcoming global clang-tidy
configuration options.

Differential Revision: https://reviews.llvm.org/D141144

More information about the All-commits mailing list