Skip to content

Commit b94cca5

Browse files
authored
Merge pull request InsightSoftwareConsortium#5999 from hjmjohnson/common-code-pitfals-md
DOC: Add compiler-cautions.md — compiler-specific pitfalls from 10 years of COMP: commits
2 parents 360c9be + 03bd3da commit b94cca5

File tree

4 files changed

+565
-3
lines changed

4 files changed

+565
-3
lines changed

.clang-tidy

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
# % clang-tidy --version (clang-tidy-new-cast↓1↑7|⚑5✔)
1010
# Homebrew LLVM version 20.1.6 # <- Version of clang-tidy used to create this file
1111
---
12-
Checks: 'clang-diagnostic-*,clang-analyzer-*,*'
12+
Checks: 'clang-diagnostic-*,clang-analyzer-*,*,-llvmlibc-*,-modernize-use-trailing-return-type,-readability-redundant-member-init'
1313
WarningsAsErrors: ''
1414
HeaderFileExtensions:
1515
- ''
@@ -433,7 +433,7 @@ CheckOptions:
433433
readability-function-size.VariableThreshold: none
434434
readability-identifier-length.IgnoredExceptionVariableNames: '^[e]$'
435435
readability-identifier-length.IgnoredLoopCounterNames: '^[ijk_]$'
436-
readability-identifier-length.IgnoredParameterNames: '^[n]$'
436+
readability-identifier-length.IgnoredParameterNames: '^[ijknxyzrgbav]$'
437437
readability-identifier-length.IgnoredVariableNames: ''
438438
readability-identifier-length.MinimumExceptionNameLength: '2'
439439
readability-identifier-length.MinimumLoopCounterNameLength: '2'

AGENTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ Load only what your task requires:
1515
| Writing or running tests | [./Documentation/AI/testing.md](./Documentation/AI/testing.md) |
1616
| Code style, naming conventions | [./Documentation/AI/style.md](./Documentation/AI/style.md) |
1717
| Writing ITK C++ classes, CMake build configuration, and Python wrapping configuration | [./Documentation/AI/conventions.md](./Documentation/AI/conventions.md) |
18-
| Creating a git commit | [./Documentation/AI/git-commits.md](./Documentation/AI/git-commits.md) |
18+
| Creating a git commit with C++ changes | [./Documentation/AI/git-commits.md](./Documentation/AI/git-commits.md), [./Documentation/AI/compiler-cautions.md](./Documentation/AI/compiler-cautions.md), [./Documentation/AI/building.md](./Documentation/AI/building.md), [./Documentation/AI/testing.md](./Documentation/AI/testing.md) |
1919
| Opening or updating a pull request | [./Documentation/AI/pull-requests.md](./Documentation/AI/pull-requests.md) |
20+
| Avoiding compiler-specific pitfalls and refactoring hazards | [./Documentation/AI/compiler-cautions.md](./Documentation/AI/compiler-cautions.md) |
2021

2122
## Critical Pitfalls
2223

0 commit comments

Comments
 (0)