llvm-project/clang-tools-extra
Paul Hoad b16e288c7d [clang-tidy] add options documentation to readability-identifier-naming checker
Summary:
The documentation for this clang-checker did not explain what the options are. But this checkers only works with at least some options defined.

To discover the options, you have to read the source code. This shouldn't be necessary for users who just have access to the clang-tidy binary.

This revision, explains the options and gives an example.

Patch by MyDeveloperDay.

Reviewers: JonasToth, Eugene.Zelenko

Reviewed By: JonasToth

Subscribers: xazax.hun, Eugene.Zelenko

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

llvm-svn: 351261
2019-01-15 22:06:49 +00:00
..
change-namespace Add explicit dependency on clangSerialization after rC348911 2018-12-12 08:25:16 +00:00
clang-apply-replacements Deduplicate replacements from diagnostics. 2018-09-25 08:24:07 +00:00
clang-doc [clang-doc] Switch to default to all-TUs executor 2018-10-26 19:11:34 +00:00
clang-move Add explicit dependency on clangSerialization after rC348911 2018-12-12 08:25:16 +00:00
clang-query Remove unnecessary include. 2019-01-10 04:53:10 +00:00
clang-reorder-fields Add explicit dependency on clangSerialization after rC348911 2018-12-12 08:25:16 +00:00
clang-tidy [clang-tidy] update FunctionSizeCheck for D56444 2019-01-14 10:40:41 +00:00
clang-tidy-vs Update copyright year to 2018. 2018-06-18 12:22:17 +00:00
clangd Update year in license files 2019-01-15 15:10:32 +00:00
docs [clang-tidy] add options documentation to readability-identifier-naming checker 2019-01-15 22:06:49 +00:00
include-fixer clang-include-fixer.el: support remote files 2018-12-14 13:56:05 +00:00
modularize Add explicit dependency on clangSerialization after rC348911 2018-12-12 08:25:16 +00:00
pp-trace Add explicit dependency on clangSerialization after rC348911 2018-12-12 08:25:16 +00:00
test Revert "Update clang-tools-extra for r350891 from Clang." 2019-01-15 17:20:04 +00:00
tool-template Port getLocStart -> getBeginLoc 2018-08-09 22:42:26 +00:00
unittests [clangd] Fix updated file detection logic in indexing 2019-01-15 09:03:33 +00:00
.arcconfig [clang-tools-extra] Set up .arcconfig to point to new Diffusion CTE repository 2017-11-27 15:58:25 +00:00
.gitignore
CMakeLists.txt [clang-tidy] Build it even without static analyzer 2018-10-01 20:24:22 +00:00
CODE_OWNERS.TXT Remove myself as owner of clang-query. 2018-11-15 22:02:10 +00:00
LICENSE.TXT Update year in license files 2019-01-15 15:10:32 +00:00
README.txt

README.txt

//===----------------------------------------------------------------------===//
// Clang Tools repository
//===----------------------------------------------------------------------===//

Welcome to the repository of extra Clang Tools.  This repository holds tools
that are developed as part of the LLVM compiler infrastructure project and the
Clang frontend.  These tools are kept in a separate "extra" repository to
allow lighter weight checkouts of the core Clang codebase.

This repository is only intended to be checked out inside of a full LLVM+Clang
tree, and in the 'tools/extra' subdirectory of the Clang checkout.

All discussion regarding Clang, Clang-based tools, and code in this repository
should be held using the standard Clang mailing lists:
  http://lists.llvm.org/mailman/listinfo/cfe-dev

Code review for this tree should take place on the standard Clang patch and
commit lists:
  http://lists.llvm.org/mailman/listinfo/cfe-commits

If you find a bug in these tools, please file it in the LLVM bug tracker:
  http://llvm.org/bugs/