michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: merge coding_style -> conventions.rst

Browse source 
This removes warning about duplicate symbol (of _coding_style, due to
the inclusion) plus also a very short file which can be very well
inside conventions.rst.

Change-Id: I7b8467a0a845225a4fe4356f012f60ab0ea202aa
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This commit is contained in:
Inaky Perez-Gonzalez 2016-06-13 13:58:06 -07:00 • committed by Anas Nashif
commit 4e10a23887
2 changed files with 39 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

41
doc/contribute/coding_style.rst
View file

@ -1,41 +0,0 @@
:orphan:
.. _coding_style:
Coding Style
************
Use this coding guideline to ensure that your development complies with
the project's style and naming conventions.
In general, follow the `Linux kernel coding style`_, with the following
exceptions:
* Add braces to every ``if`` and ``else`` body, even for single-line code
blocks. Use the :option:`--ignore BRACES` flag to make :program:`checkpatch`
stop complaining.
* Use hard tab stops. Set the tab width 8 spaces. Break lines at 80 characters.
If you are trying to align comments after declarations, use spaces instead of
tabs to align them.
* Use C89-style single line comments, :literal:`/* */`. The C99-style
single line comment, //, is not allowed.
* Use :literal:`/** */` for any comments that need to appear in the
documentation.
Checking for Conformity Using Checkpatch
========================================
The Linux kernel GPL-licensed tool :program:`checkpatch` is used to
check coding style conformity. :program:`Checkpatch` is available in the
scripts directory. To invoke it when committing code, edit your
:file:`.git/hooks/pre-commit` file to contain:
.. code-block:: bash
#!/bin/sh
set -e exec
exec git diff --cached | ${ZEPHYR_BASE}/scripts/checkpatch.pl - || true
.. _Linux kernel coding style: https://www.kernel.org/doc/Documentation/CodingStyle

40
doc/contribute/conventions.rst
View file

@ -163,4 +163,42 @@ components.
| -ENOSYS | Function is not implemented. | | -ENOSYS | Function is not implemented. |
+-----------------+------------------------------------------------+ +-----------------+------------------------------------------------+
.. include:: coding_style.rst .. _coding_style:
Coding Style
************
Use this coding guideline to ensure that your development complies with
the project's style and naming conventions.
In general, follow the `Linux kernel coding style`_, with the following
exceptions:
* Add braces to every ``if`` and ``else`` body, even for single-line code
blocks. Use the :option:`--ignore BRACES` flag to make :program:`checkpatch`
stop complaining.
* Use hard tab stops. Set the tab width 8 spaces. Break lines at 80 characters.
If you are trying to align comments after declarations, use spaces instead of
tabs to align them.
* Use C89-style single line comments, :literal:`/* */`. The C99-style
single line comment, //, is not allowed.
* Use :literal:`/** */` for any comments that need to appear in the
documentation.
Checking for Conformity Using Checkpatch
========================================
The Linux kernel GPL-licensed tool :program:`checkpatch` is used to
check coding style conformity. :program:`Checkpatch` is available in the
scripts directory. To invoke it when committing code, edit your
:file:`.git/hooks/pre-commit` file to contain:
.. code-block:: bash
#!/bin/sh
set -e exec
exec git diff --cached | ${ZEPHYR_BASE}/scripts/checkpatch.pl - || true
.. _Linux kernel coding style: https://www.kernel.org/doc/Documentation/CodingStyle