doc: refer the checkpatch.pl setup
Document that 'make checkpatch' requires downloading
the checkpatch.pl script from the linux tree.
Provide the instructions to download and configure
script for use.
Signed-off-by: J-Alves <joao.alves@arm.com>
Change-Id: I514757fdb851bed9acdac200b4cf0dd498245f27
diff --git a/docs/getting_started/prerequisites.rst b/docs/getting_started/prerequisites.rst
index f1c398d..40d574f 100644
--- a/docs/getting_started/prerequisites.rst
+++ b/docs/getting_started/prerequisites.rst
@@ -59,6 +59,18 @@
pip3 install fdt
+The file kokoro/static_checks.sh runs a series of static code checks into Hafnium's codebase.
+Hafnium follows the linux kernel coding guidelines. As such, the static code checks using the
+'checkpatch.pl' script from linux source tree. To setup and download 'checkpatch.pl':
+
+.. code:: shell
+ ./build/setup_checkpatch.sh
+
+Then test it works with:
+
+.. code:: shell
+ make checkpatch
+
Documentation
^^^^^^^^^^^^^