https://github.com/carlosgalvezp created
https://github.com/llvm/llvm-project/pull/154806
Currently it's hard to find the "general" options, since they are listed in the
middle of the "specific" options. Split them into two categories so they are
easier to find.
This can help in adding a potential new general option in a follow-up patch.
>From 7eafa991917bdaaf32bc361784a9c5dd6c1339ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Carlos=20G=C3=A1lvez?= <carlos.gal...@zenseact.com>
Date: Thu, 21 Aug 2025 17:49:33 +0000
Subject: [PATCH] [clang-tidy][doc] Improve option docs for
readability-identifier-naming
Currently it's hard to find the "general" options, since they are
listed in the middle of the "specific" options. Split them into two
categories so they are easier to find.
This can help in adding a potential new general option in a follow-up
patch.
---
clang-tools-extra/docs/ReleaseNotes.rst | 3 ++-
.../checks/readability/identifier-naming.rst | 23 ++++++++++++++-----
2 files changed, 19 insertions(+), 7 deletions(-)
diff --git a/clang-tools-extra/docs/ReleaseNotes.rst
b/clang-tools-extra/docs/ReleaseNotes.rst
index 388979d9577ba..383286eb0c5a3 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -215,7 +215,8 @@ Changes in existing checks
- Improved :doc:`readability-identifier-naming
<clang-tidy/checks/readability/identifier-naming>` check by ignoring
- declarations in system headers.
+ declarations in system headers. The documentation is also improved to
+ differentiate the general options from the specific ones.
- Improved :doc:`readability-qualified-auto
<clang-tidy/checks/readability/qualified-auto>` check by adding the option
diff --git
a/clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.rst
b/clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.rst
index 8a54687a25704..0e031a15dea90 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.rst
@@ -43,14 +43,21 @@ The options and their corresponding values are:
- ``LowerCase`` - example: ``int i_Variable``
- ``CamelCase`` - example: ``int IVariable``
-Options
--------
+Options summary
+---------------
-The following options are described below:
+The available options are summarized below:
+
+**General options**
- - :option:`AbstractClassCase`, :option:`AbstractClassPrefix`,
:option:`AbstractClassSuffix`, :option:`AbstractClassIgnoredRegexp`,
:option:`AbstractClassHungarianPrefix`
- :option:`AggressiveDependentMemberLookup`
- :option:`CheckAnonFieldInParent`
+ - :option:`GetConfigPerFile`
+ - :option:`IgnoreMainLikeFunctions`
+
+**Specific options**
+
+ - :option:`AbstractClassCase`, :option:`AbstractClassPrefix`,
:option:`AbstractClassSuffix`, :option:`AbstractClassIgnoredRegexp`,
:option:`AbstractClassHungarianPrefix`
- :option:`ClassCase`, :option:`ClassPrefix`, :option:`ClassSuffix`,
:option:`ClassIgnoredRegexp`, :option:`ClassHungarianPrefix`
- :option:`ClassConstantCase`, :option:`ClassConstantPrefix`,
:option:`ClassConstantSuffix`, :option:`ClassConstantIgnoredRegexp`,
:option:`ClassConstantHungarianPrefix`
- :option:`ClassMemberCase`, :option:`ClassMemberPrefix`,
:option:`ClassMemberSuffix`, :option:`ClassMemberIgnoredRegexp`,
:option:`ClassMemberHungarianPrefix`
@@ -66,13 +73,11 @@ The following options are described below:
- :option:`EnumCase`, :option:`EnumPrefix`, :option:`EnumSuffix`,
:option:`EnumIgnoredRegexp`
- :option:`EnumConstantCase`, :option:`EnumConstantPrefix`,
:option:`EnumConstantSuffix`, :option:`EnumConstantIgnoredRegexp`,
:option:`EnumConstantHungarianPrefix`
- :option:`FunctionCase`, :option:`FunctionPrefix`, :option:`FunctionSuffix`,
:option:`FunctionIgnoredRegexp`
- - :option:`GetConfigPerFile`
- :option:`GlobalConstantCase`, :option:`GlobalConstantPrefix`,
:option:`GlobalConstantSuffix`, :option:`GlobalConstantIgnoredRegexp`,
:option:`GlobalConstantHungarianPrefix`
- :option:`GlobalConstantPointerCase`, :option:`GlobalConstantPointerPrefix`,
:option:`GlobalConstantPointerSuffix`,
:option:`GlobalConstantPointerIgnoredRegexp`,
:option:`GlobalConstantPointerHungarianPrefix`
- :option:`GlobalFunctionCase`, :option:`GlobalFunctionPrefix`,
:option:`GlobalFunctionSuffix`, :option:`GlobalFunctionIgnoredRegexp`
- :option:`GlobalPointerCase`, :option:`GlobalPointerPrefix`,
:option:`GlobalPointerSuffix`, :option:`GlobalPointerIgnoredRegexp`,
:option:`GlobalPointerHungarianPrefix`
- :option:`GlobalVariableCase`, :option:`GlobalVariablePrefix`,
:option:`GlobalVariableSuffix`, :option:`GlobalVariableIgnoredRegexp`,
:option:`GlobalVariableHungarianPrefix`
- - :option:`IgnoreMainLikeFunctions`
- :option:`InlineNamespaceCase`, :option:`InlineNamespacePrefix`,
:option:`InlineNamespaceSuffix`, :option:`InlineNamespaceIgnoredRegexp`
- :option:`LocalConstantCase`, :option:`LocalConstantPrefix`,
:option:`LocalConstantSuffix`, :option:`LocalConstantIgnoredRegexp`,
:option:`LocalConstantHungarianPrefix`
- :option:`LocalConstantPointerCase`, :option:`LocalConstantPointerPrefix`,
:option:`LocalConstantPointerSuffix`,
:option:`LocalConstantPointerIgnoredRegexp`,
:option:`LocalConstantPointerHungarianPrefix`
@@ -105,6 +110,12 @@ The following options are described below:
- :option:`VariableCase`, :option:`VariablePrefix`, :option:`VariableSuffix`,
:option:`VariableIgnoredRegexp`, :option:`VariableHungarianPrefix`
- :option:`VirtualMethodCase`, :option:`VirtualMethodPrefix`,
:option:`VirtualMethodSuffix`, :option:`VirtualMethodIgnoredRegexp`
+
+Options description
+-------------------
+
+A detailed description of each option is presented below:
+
.. option:: AbstractClassCase
When defined, the check will ensure abstract class names conform to the
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
