From 3875463b36326f6a45ae0b53f788506921867a77 Mon Sep 17 00:00:00 2001 From: Geoff Gustafson Date: Fri, 3 Jun 2016 14:48:27 -0700 Subject: [PATCH] doc: Fix typos and styling for clarity on coding conventions page Change-Id: Ifb8a75869ee3d9fa8cab33c146a1fe9bd1fa8f27 Signed-off-by: Geoff Gustafson --- doc/contribute/conventions.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/contribute/conventions.rst b/doc/contribute/conventions.rst index 0582a8119a6..cc047162093 100644 --- a/doc/contribute/conventions.rst +++ b/doc/contribute/conventions.rst @@ -88,7 +88,7 @@ In rare cases a few global symbols do not use the normal kernel prefixes; 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 example, ``bt\_`` for BlueTooth, or ``net\_`` for IP). This limits possible clashes with applications. Following this prefix convention with subsystems @@ -109,15 +109,20 @@ files should be included with: .. code-block:: c - #include . + #include 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 .. code-block:: c - #include becomes ambiguous, while + #include + +becomes ambiguous, while + +.. code-block:: c + #include is not. Not having :option:`-Iinclude/drivers` forces users to use the second