This is an archive of the discontinued LLVM Phabricator instance.

Differential D103842

NFC: .clang-tidy: Inherit configs from parents to improve maintainability
ClosedPublic

Authored by dblaikie on Jun 7 2021, 2:10 PM.

Details

Reviewers
hokein
aaron.ballman
jyknight
mehdi_amini
kuhnel
Commits
rGc5d56fec502f: NFC: .clang-tidy: Inherit configs from parents to improve maintainability
Summary

In the interests of disabling misc-no-recursion across LLVM (this seems
like a stylistic choice that is not consistent with LLVM's
style/development approach) this NFC preliminary change adjusts all the
.clang-tidy files to inherit from their parents as much as possible.

This change specifically preserves all the quirks of the current configs
in order to make it easier to review as NFC.

I validatad the change is NFC as follows:

for X in cat ../files.txt;
do

mkdir -p ../tmp/$(dirname $X)
touch $(dirname $X)/blaikie.cpp
clang-tidy -dump-config $(dirname $X)/blaikie.cpp > ../tmp/$(dirname $X)/after
rm $(dirname $X)/blaikie.cpp

done

(similarly for the "before" state, without this patch applied)

for X in cat ../files.txt;
do

echo $X
diff \
  ../tmp/$(dirname $X)/before \
  <(cat ../tmp/$(dirname $X)/after \
    | sed -e "s/,readability-identifier-naming\(.*\),-readability-identifier-naming/\1/" \
    | sed -e "s/,-llvm-include-order\(.*\),llvm-include-order/\1/" \
    | sed -e "s/,-misc-no-recursion\(.*\),misc-no-recursion/\1/" \
    | sed -e "s/,-clang-diagnostic-\*\(.*\),clang-diagnostic-\*/\1/")

done

(using sed to strip some add/remove pairs to reduce the diff and make it easier to read)

The resulting report is:

.clang-tidy
clang/.clang-tidy
2c2
< Checks:          'clang-diagnostic-*,clang-analyzer-*,-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,-readability-identifier-naming,-misc-no-recursion'
---
> Checks:          'clang-diagnostic-*,clang-analyzer-*,-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,-misc-no-recursion'
compiler-rt/.clang-tidy
2c2
< Checks:          'clang-diagnostic-*,clang-analyzer-*,-*,clang-diagnostic-*,llvm-*,-llvm-header-guard,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes'
---
> Checks:          'clang-diagnostic-*,clang-analyzer-*,-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,-llvm-header-guard'
flang/.clang-tidy
2c2
< Checks:          'clang-diagnostic-*,clang-analyzer-*,-*,llvm-*,-llvm-include-order,misc-*,-misc-no-recursion,-misc-unused-parameters,-misc-non-private-member-variables-in-classes'
---
> Checks:          'clang-diagnostic-*,clang-analyzer-*,-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,-llvm-include-order,-misc-no-recursion'
flang/include/flang/Lower/.clang-tidy
flang/include/flang/Optimizer/.clang-tidy
flang/lib/Lower/.clang-tidy
flang/lib/Optimizer/.clang-tidy
lld/.clang-tidy
lldb/.clang-tidy
llvm/tools/split-file/.clang-tidy
mlir/.clang-tidy

The clang/.clang-tidy change is a no-op, disabling an option that was never enabled.
The compiler-rt and flang changes are no-op reorderings of the same flags.

(side note, the .clang-tidy file in parallel-libs is broken and crashes
clang-tidy because it uses "lowerCase" as the style instead of "lower_case" -
so I'll deal with that separately)

Diff Detail

Event Timeline

dblaikie created this revision.Jun 7 2021, 2:10 PM
Herald added subscribers: dcaballe, cota, teijeong and 15 others. · View Herald TranscriptJun 7 2021, 2:10 PM
dblaikie requested review of this revision.Jun 7 2021, 2:10 PM
Herald added projects: Restricted Project, Restricted Project, Restricted Project, Restricted Project, Restricted Project. · View Herald TranscriptJun 7 2021, 2:10 PM
Herald added subscribers: llvm-commits, lldb-commits, Restricted Project and 4 others. · View Herald Transcript
Harbormaster completed remote builds in B108071: Diff 350412.Jun 7 2021, 2:51 PM
Herald added a subscriber: JDevlieghere. · View Herald TranscriptJun 7 2021, 2:51 PM
mehdi_amini accepted this revision.Jun 7 2021, 9:27 PM
This revision is now accepted and ready to land.Jun 7 2021, 9:27 PM
aaron.ballman accepted this revision.Jun 8 2021, 3:59 AM

LGTM, thank you!

Closed by commit rGc5d56fec502f: NFC: .clang-tidy: Inherit configs from parents to improve maintainability (authored by dblaikie). · Explain WhyJun 8 2021, 8:26 AM
This revision was automatically updated to reflect the committed changes.
dblaikie added a commit: rGc5d56fec502f: NFC: .clang-tidy: Inherit configs from parents to improve maintainability.

Revision Contents

PathSize
clang/
23 lines
compiler-rt/
4 lines
flang/
3 lines
include/
flang/
Lower/
14 lines
Optimizer/
14 lines
lib/
Lower/
14 lines
Optimizer/
14 lines
lld/
13 lines
lldb/
4 lines
llvm/
20 lines
tools/
split-file/
13 lines
mlir/
13 lines

Diff 350608

clang/.clang-tidy

Checks: '-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,-readability-identifier-naming,-misc-no-recursion'
# Note that the readability-identifier-naming check is disabled, there are too # Note that the readability-identifier-naming check is disabled, there are too
# many violations in the codebase and they create too much noise in clang-tidy # many violations in the codebase and they create too much noise in clang-tidy
# results. # results.
# Naming settings are kept for documentation purposes and allowing to run the Checks: '-readability-identifier-naming,-misc-no-recursion'
# check if the users would override this file, e.g. via a command-line arg. InheritParentConfig: true
CheckOptions:
- key: readability-identifier-naming.ClassCase
value: CamelCase
- key: readability-identifier-naming.EnumCase
value: CamelCase
- key: readability-identifier-naming.FunctionCase
value: camelBack
- key: readability-identifier-naming.MemberCase
value: CamelCase
- key: readability-identifier-naming.ParameterCase
value: CamelCase
- key: readability-identifier-naming.UnionCase
value: CamelCase
- key: readability-identifier-naming.VariableCase
value: CamelCase
- key: readability-identifier-naming.IgnoreMainLikeFunctions
value: 1

compiler-rt/.clang-tidy

# Checks enabled in the top-level .clang-tidy minus readability-identifier-naming and llvm-header-guard. Checks: '-readability-identifier-naming,-llvm-header-guard'
Checks: '-*,clang-diagnostic-*,llvm-*,-llvm-header-guard,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes' InheritParentConfig: true

flang/.clang-tidy

Checks: '-*,llvm-*,-llvm-include-order,misc-*,-misc-no-recursion,-misc-unused-parameters,-misc-non-private-member-variables-in-classes' Checks: '-llvm-include-order,-readability-identifier-naming,-misc-no-recursion,-clang-diagnostic-*'
InheritParentConfig: true

flang/include/flang/Lower/.clang-tidy

# Almost identical to the top-level .clang-tidy, except that {Member,Parameter,Variable}Case use camelBack. Checks: 'readability-identifier-naming,llvm-include-order,misc-no-recursion,clang-diagnostic-*'
Checks: '-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,readability-identifier-naming' InheritParentConfig: true
CheckOptions: CheckOptions:
- key: readability-identifier-naming.ClassCase
value: CamelCase
- key: readability-identifier-naming.EnumCase
value: CamelCase
- key: readability-identifier-naming.FunctionCase
value: camelBack
- key: readability-identifier-naming.MemberCase - key: readability-identifier-naming.MemberCase
value: camelBack value: camelBack
- key: readability-identifier-naming.ParameterCase - key: readability-identifier-naming.ParameterCase
value: camelBack value: camelBack
- key: readability-identifier-naming.UnionCase
value: CamelCase
- key: readability-identifier-naming.VariableCase - key: readability-identifier-naming.VariableCase
value: camelBack value: camelBack
- key: readability-identifier-naming.IgnoreMainLikeFunctions
value: 1

flang/include/flang/Optimizer/.clang-tidy

# Almost identical to the top-level .clang-tidy, except that {Member,Parameter,Variable}Case use camelBack. Checks: 'readability-identifier-naming,llvm-include-order,misc-no-recursion,clang-diagnostic-*'
Checks: '-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,readability-identifier-naming' InheritParentConfig: true
CheckOptions: CheckOptions:
- key: readability-identifier-naming.ClassCase
value: CamelCase
- key: readability-identifier-naming.EnumCase
value: CamelCase
- key: readability-identifier-naming.FunctionCase
value: camelBack
- key: readability-identifier-naming.MemberCase - key: readability-identifier-naming.MemberCase
value: camelBack value: camelBack
- key: readability-identifier-naming.ParameterCase - key: readability-identifier-naming.ParameterCase
value: camelBack value: camelBack
- key: readability-identifier-naming.UnionCase
value: CamelCase
- key: readability-identifier-naming.VariableCase - key: readability-identifier-naming.VariableCase
value: camelBack value: camelBack
- key: readability-identifier-naming.IgnoreMainLikeFunctions
value: 1

flang/lib/Lower/.clang-tidy

# Almost identical to the top-level .clang-tidy, except that {Member,Parameter,Variable}Case use camelBack. Checks: 'readability-identifier-naming,llvm-include-order,misc-no-recursion,clang-diagnostic-*'
Checks: '-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,readability-identifier-naming' InheritParentConfig: true
CheckOptions: CheckOptions:
- key: readability-identifier-naming.ClassCase
value: CamelCase
- key: readability-identifier-naming.EnumCase
value: CamelCase
- key: readability-identifier-naming.FunctionCase
value: camelBack
- key: readability-identifier-naming.MemberCase - key: readability-identifier-naming.MemberCase
value: camelBack value: camelBack
- key: readability-identifier-naming.ParameterCase - key: readability-identifier-naming.ParameterCase
value: camelBack value: camelBack
- key: readability-identifier-naming.UnionCase
value: CamelCase
- key: readability-identifier-naming.VariableCase - key: readability-identifier-naming.VariableCase
value: camelBack value: camelBack
- key: readability-identifier-naming.IgnoreMainLikeFunctions
value: 1

flang/lib/Optimizer/.clang-tidy

# Almost identical to the top-level .clang-tidy, except that {Member,Parameter,Variable}Case use camelBack. Checks: 'readability-identifier-naming,llvm-include-order,misc-no-recursion,clang-diagnostic-*'
Checks: '-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,readability-identifier-naming' InheritParentConfig: true
CheckOptions: CheckOptions:
- key: readability-identifier-naming.ClassCase
value: CamelCase
- key: readability-identifier-naming.EnumCase
value: CamelCase
- key: readability-identifier-naming.FunctionCase
value: camelBack
- key: readability-identifier-naming.MemberCase - key: readability-identifier-naming.MemberCase
value: camelBack value: camelBack
- key: readability-identifier-naming.ParameterCase - key: readability-identifier-naming.ParameterCase
value: camelBack value: camelBack
- key: readability-identifier-naming.UnionCase
value: CamelCase
- key: readability-identifier-naming.VariableCase - key: readability-identifier-naming.VariableCase
value: camelBack value: camelBack
- key: readability-identifier-naming.IgnoreMainLikeFunctions
value: 1

lld/.clang-tidy

# Almost identical to the top-level .clang-tidy, except that {Member,Parameter,Variable}Case use camelBack. InheritParentConfig: true
Checks: '-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,readability-identifier-naming'
CheckOptions: CheckOptions:
- key: readability-identifier-naming.ClassCase
value: CamelCase
- key: readability-identifier-naming.EnumCase
value: CamelCase
- key: readability-identifier-naming.FunctionCase
value: camelBack
- key: readability-identifier-naming.MemberCase - key: readability-identifier-naming.MemberCase
value: camelBack value: camelBack
- key: readability-identifier-naming.ParameterCase - key: readability-identifier-naming.ParameterCase
value: camelBack value: camelBack
- key: readability-identifier-naming.UnionCase
value: CamelCase
- key: readability-identifier-naming.VariableCase - key: readability-identifier-naming.VariableCase
value: camelBack value: camelBack
- key: readability-identifier-naming.IgnoreMainLikeFunctions
value: 1

lldb/.clang-tidy

# Checks enabled in the top-level .clang-tidy minus readability-identifier-naming Checks: '-readability-identifier-naming'
Checks: '-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes' InheritParentConfig: true

llvm/.clang-tidy

Checks: '-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,readability-identifier-naming' InheritParentConfig: true
CheckOptions:
- key: readability-identifier-naming.ClassCase
value: CamelCase
- key: readability-identifier-naming.EnumCase
value: CamelCase
- key: readability-identifier-naming.FunctionCase
value: camelBack
- key: readability-identifier-naming.MemberCase
value: CamelCase
- key: readability-identifier-naming.ParameterCase
value: CamelCase
- key: readability-identifier-naming.UnionCase
value: CamelCase
- key: readability-identifier-naming.VariableCase
value: CamelCase
- key: readability-identifier-naming.IgnoreMainLikeFunctions
value: 1

llvm/tools/split-file/.clang-tidy

# Almost identical to the top-level .clang-tidy, except that {Member,Parameter,Variable}Case use camelBack. InheritParentConfig: true
Checks: '-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,readability-identifier-naming'
CheckOptions: CheckOptions:
- key: readability-identifier-naming.ClassCase
value: CamelCase
- key: readability-identifier-naming.EnumCase
value: CamelCase
- key: readability-identifier-naming.FunctionCase
value: camelBack
- key: readability-identifier-naming.MemberCase - key: readability-identifier-naming.MemberCase
value: camelBack value: camelBack
- key: readability-identifier-naming.ParameterCase - key: readability-identifier-naming.ParameterCase
value: camelBack value: camelBack
- key: readability-identifier-naming.UnionCase
value: CamelCase
- key: readability-identifier-naming.VariableCase - key: readability-identifier-naming.VariableCase
value: camelBack value: camelBack
- key: readability-identifier-naming.IgnoreMainLikeFunctions
value: 1

mlir/.clang-tidy

# Almost identical to the top-level .clang-tidy, except that {Member,Parameter,Variable}Case use camelBack. InheritParentConfig: true
Checks: '-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,readability-identifier-naming'
CheckOptions: CheckOptions:
- key: readability-identifier-naming.ClassCase
value: CamelCase
- key: readability-identifier-naming.EnumCase
value: CamelCase
- key: readability-identifier-naming.FunctionCase
value: camelBack
- key: readability-identifier-naming.MemberCase - key: readability-identifier-naming.MemberCase
value: camelBack value: camelBack
- key: readability-identifier-naming.ParameterCase - key: readability-identifier-naming.ParameterCase
value: camelBack value: camelBack
- key: readability-identifier-naming.UnionCase
value: CamelCase
- key: readability-identifier-naming.VariableCase - key: readability-identifier-naming.VariableCase
value: camelBack value: camelBack
- key: readability-identifier-naming.IgnoreMainLikeFunctions
value: 1