michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Fix typos and styling for clarity on coding conventions page

Browse source 
Change-Id: Ifb8a75869ee3d9fa8cab33c146a1fe9bd1fa8f27
Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
This commit is contained in:
Geoff Gustafson 2016-06-03 14:48:27 -07:00
commit 3875463b36
1 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/contribute/conventions.rst
View file

@ -88,7 +88,7 @@ In rare cases a few global symbols do not use the normal kernel prefixes;
Subsystem Naming Conventions Subsystem Naming Conventions
============================ ============================
Generally, any sub-system can define its own naming conventions for symbols. Generally, any subsystem can define its own naming conventions for symbols.
However, these should be implemented with their own namespace prefix (for However, these should be implemented with their own namespace prefix (for
example, ``bt\_`` for BlueTooth, or ``net\_`` for IP). This limits possible example, ``bt\_`` for BlueTooth, or ``net\_`` for IP). This limits possible
clashes with applications. Following this prefix convention with subsystems clashes with applications. Following this prefix convention with subsystems
@ -109,15 +109,20 @@ files should be included with:
.. code-block:: c .. code-block:: c
#include <subdirectory/header.h>. #include <subdirectory/header.h>
For example, if you have two files, :file:`include/pci.h` and For example, if you have two files, :file:`include/pci.h` and
:file:`include/drvers/pci.h`, and have set both :option:`-Iinclude/drivers` :file:`include/drivers/pci.h`, and have set both :option:`-Iinclude/drivers`
and :option:`-Iinclude` for your compile, then any code using and :option:`-Iinclude` for your compile, then any code using
.. code-block:: c .. code-block:: c
#include <pci.h> becomes ambiguous, while #include <pci.h>
becomes ambiguous, while
.. code-block:: c
#include <drivers/pci.h> #include <drivers/pci.h>
is not. Not having :option:`-Iinclude/drivers` forces users to use the second is not. Not having :option:`-Iinclude/drivers` forces users to use the second