gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-12-04 00:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove checkpatch, since it's tuned for C not C++ (#1250)

Browse Source 
Co-authored-by: Eldred Habert <eldredhabert0@gmail.com>
This commit is contained in:
Rangi
2023-11-22 13:26:08 -05:00
committed by GitHub
parent 46e29de66f
commit a218622d73
6 changed files with 5 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.rst
View File

@@ -74,22 +74,10 @@ copyright and the reference to the MIT License.
new warning (but it may be possible to remove some warning checks if it makes
the code much easier).
5. Follow the Linux kernel coding style, which can be found in the file
``Documentation/process/coding-style.rst`` in the Linux kernel repository.
Note that the coding style isn't written in stone, if there is a good reason
to deviate from it, it should be fine.
5. Format your changes according to ``clang-format``, which will reformat the
coding style according to our standards defined in ``.clang-format``.
6. Download the files ``checkpatch.pl``, ``const_structs.checkpatch`` and
``spelling.txt`` from the folder ``scripts`` in the Linux kernel repository.
6. Create a pull request against the branch ``master``.
7. To use ``checkpatch.pl`` you can use ``make checkpatch``, which will check
the coding style of all patches between the current one and the upstream
code. By default, the Makefile expects the script (and associate files) to be
located in ``../linux/scripts/``, but you can place them anywhere you like as
long as you specify it when executing the command:
``make checkpatch CHECKPATCH=../path/to/folder``.
8. Create a pull request against the branch ``master``.
9. Be prepared to get some comments about your code and to modify it. Tip: Use
7. Be prepared to get some comments about your code and to modify it. Tip: Use
``git rebase -i origin/master`` to modify chains of commits.