proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-07-09 11:05:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #13801 from LabNConsulting/chopps/latest-checkpatch

Browse Source 
Import latest checkpatch.pl from linux
This commit is contained in:
Jafar Al-Gharaibeh 2023-06-20 10:41:01 -05:00 committed by GitHub
commit 2be9ce6cd8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 3002 additions and 569 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1249
doc/developer/checkpatch.rst Normal file
View File

File diff suppressed because it is too large Load Diff

1
doc/developer/subdir.am
View File

@ -27,6 +27,7 @@ dev_RSTFILES = \
doc/developer/building-libunwind-note.rst \
doc/developer/building-libyang.rst \
doc/developer/building.rst \
doc/developer/checkpatch.rst \
doc/developer/cli.rst \
doc/developer/conf.py \
doc/developer/cross-compiling.rst \

21
doc/developer/workflow.rst
View File

@ -868,14 +868,17 @@ clang-format
https://clang.llvm.org/docs/ClangFormat.html
checkpatch.sh
checkpatch.pl
In the Linux kernel source tree there is a Perl script used to check
incoming patches for style errors. FRR uses an adapted version of this
script for the same purpose. It can be found at
:file:`tools/checkpatch.sh`. This script takes a git-formatted diff or
patch file, applies it to a clean FRR tree, and inspects the result to catch
potential style errors. Running this script on your patches before
submission is highly recommended. The CI system runs this script as well and
will comment on the PR with the results if style errors are found.
incoming patches for style errors. FRR uses a shell script front end and an
adapted version of the perl script for the same purpose. These scripts can
be found at :file:`tools/checkpatch.sh` and :file:`tools/checkpatch.pl`.
This script takes a git-formatted diff or patch file, applies it to a clean
FRR tree, and inspects the result to catch potential style errors. Running
this script on your patches before submission is highly recommended. The CI
system runs this script as well and will comment on the PR with the results
if style errors are found.
It is run like this::
@ -916,6 +919,10 @@ checkpatch.sh
If the script finds one or more WARNINGs it will exit with 1. If it finds
one or more ERRORs it will exit with 2.
For convenience the Linux documentation for the :file:`tools/checkpatch.pl`
script has been included unmodified (i.e., it has not been updated to
reflect local changes) :doc:`here <checkpatch>`
Please remember that while FRR provides these tools for your convenience,
responsibility for properly formatting your code ultimately lies on the

2154
tools/checkpatch.pl
View File

File diff suppressed because it is too large Load Diff