Skip to content

Commit ea11724

Browse files
committed
add guide for checkpatch config file
add setup guide for `.checkpatch.conf` file. Signed-off-by: Inho Oh <webispy@gmail.com>
1 parent 9fccc9a commit ea11724

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,31 @@ jobs:
7373
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
7474
```
7575

76+
### `checkpatch.pl` configuration
77+
78+
The `checkpatch.pl` tool supports a configuration file for setting options. Just create a `.checkpatch.conf` file in the top-level directory of your project and specify options in it.
79+
80+
https://docs.kernel.org/dev-tools/checkpatch.html#type-descriptions
81+
82+
#### Example for `.checkpatch.conf` file
83+
84+
```
85+
# This isn't actually a Linux kernel tree
86+
--no-tree
87+
88+
--ignore CONFIG_DESCRIPTION
89+
--ignore FILE_PATH_CHANGES
90+
--ignore GERRIT_CHANGE_ID
91+
--ignore GIT_COMMIT_ID
92+
--ignore NEW_TYPEDEFS
93+
--ignore SPDX_LICENSE_TAG
94+
--ignore SPACING
95+
--ignore CONST_STRUCT
96+
--ignore EMBEDDED_FUNCTION_NAME
97+
--exclude externals
98+
--exclude examples
99+
```
100+
76101
## References
77102
78103
### checkpatch tool

0 commit comments

Comments
 (0)