Cellular Network Infrastructure

h1. Linting

Patches submitted to [[Gerrit]] are automatically linted to ensure patches follow our [[coding standards]] and to catch common spelling errors. Jenkins runs @checkpatch.pl@ from the Linux kernel (with an Osmocom specific configuration) against the diff of the current patch.

h2. pre-commit hook

The linting script is very fast, it makes sense to configure it locally as pre-commit hook. Then it will run whenever attempting to @git commit@.

Go to the directory above your Osmocom sources, then run the following. Replace libosmocore with any checked out Osmocom project.

<pre>

$ git clone https://git.osmocom.org/osmo-ci

$ ln -sv $PWD/osmo-ci/lint/lint_diff.sh libosmocore/.git/hooks/pre-commit

</pre>

h2. Osmocom specific configuration

Find the Osmocom specific configuration in @osmo-ci/lint/checkpatch/checkpatch_osmo.sh@.

If you see the script generating errors with checks that don't apply for Osmocom code (see the ignores and excludes already in the script), please submit a patch against osmo-ci.git that disables this specific check.

h2. Testing

Run @osmo-ci/lint/lint_all.sh@ in a git repository to run the script against all files in that repository and to report the total amount of errors. It is also possible to run only a specific check of @checkpatch.pl@ by passing it as argument. For example:

<pre>

$ cd libosmocore

$ ../osmo-ci/lint/lint_all.sh CODE_INDENT

</pre>

h2. See also

* #5087