llvm-project/clang-tools-extra/docs/clang-tidy
Nathan James fbf611ed2a
[clang-tidy] Extend spelling for CheckOptions
The current way to specify CheckOptions is pretty verbose and unintuitive.
Given that the options are a dictionary it makes much more sense to treat them as such in the config files.
Example:
```
CheckOptions: {SomeCheck.Option: true, SomeCheck.OtherOption: 'ignore'}
# Or
CheckOptions:
  SomeCheck.Option: true
  SomeCheck.OtherOption: 'ignore'
```

This change will still handle the old syntax with no issue, ensuring we don't screw up users current config files.

The only observable differences are support for the new syntax and `-dump=config` will emit using the new syntax.

Reviewed By: aaron.ballman

Differential Revision: https://reviews.llvm.org/D128337
2022-06-23 19:59:31 +01:00
..
checks Fix sphinx build for clang-tools-extra 2022-06-23 07:22:00 -04:00
Contributing.rst [clang-tidy] Extend spelling for CheckOptions 2022-06-23 19:59:31 +01:00
Integrations.rst [Branch-Rename] Fix some links 2021-02-01 16:43:21 +05:30
index.rst [clang-tidy] Extend spelling for CheckOptions 2022-06-23 19:59:31 +01:00