michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Fix syntax in "Coding Style Guidelines".

Browse source 
corrected syntax of some inline code references

Change-Id: Id4deaefd655447b4e01665f6029d6ba92606da1f
Signed-off-by: Leona Cook <leonax.cook@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This commit is contained in:
Rodrigo Caballero 2015-10-19 16:27:55 -05:00 • committed by Anas Nashif
commit d36ca1b76d
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/collaboration/code/coding_style.rst
View file

@ -9,8 +9,8 @@ the project's style and naming conventions.
In general, follow the `Linux kernel coding style`_, with the following In general, follow the `Linux kernel coding style`_, with the following
exceptions: exceptions:
* Add braces to every if and else body, even if it is a single line. * Add braces to every ``if`` and ``else`` body, even for single-line code
Use the :option:`--ignore BRACES` flag to make :program:`checkpatch` blocks. Use the :option:`--ignore BRACES` flag to make :program:`checkpatch`
stop complaining. stop complaining.
* Use hard tab stops. Set the tab width to either 4 or 8 spaces. Train * Use hard tab stops. Set the tab width to either 4 or 8 spaces. Train
:program:`checkpatch` to only warn when lines are over 100 :program:`checkpatch` to only warn when lines are over 100
@ -25,10 +25,10 @@ exceptions:
Checking for Conformity Using Checkpatch Checking for Conformity Using Checkpatch
**************************************** ****************************************
The Linux kernel GPL-licensed tool, :program:`checkpatch` is used to The Linux kernel GPL-licensed tool :program:`checkpatch` is used to
check the conformity to the coding style. The tool is available in the check coding style conformity. :program:`Checkpatch` is available in the
scripts directory. To invoke :program:`checkpatch` when you commit scripts directory. To invoke it when committing code, edit your
code, edit your :file:`.git/hooks/pre-commit` file to contain: :file:`.git/hooks/pre-commit` file to contain:
.. code-block:: bash .. code-block:: bash