michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add device_ namespace to the naming code conventions

Browse source 
Change-Id: I3404a675a965ed196721f3cf825780c607ed2d40
Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
This commit is contained in:
Benjamin Walsh 2016-01-26 16:47:37 -05:00 • committed by Anas Nashif
commit a740cd96a9
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/collaboration/code/naming_conventions.rst
View file

@ -28,6 +28,9 @@ to the Namespace`_ for details.
+-------------------+---------------------------------------------------------+ +-------------------+---------------------------------------------------------+
| atomic\_ | Denotes an atomic operation (e.g. atomic_inc). | | atomic\_ | Denotes an atomic operation (e.g. atomic_inc). |
+-------------------+---------------------------------------------------------+ +-------------------+---------------------------------------------------------+
| device\_ | Denotes an API relating to devices and their |
| | initialization |
+-------------------+---------------------------------------------------------+
| fiber\_ | Denotes an operation invoked by a fiber; typically a | | fiber\_ | Denotes an operation invoked by a fiber; typically a |
| | microkernel operation (e.g. fiber_event_send). | | | microkernel operation (e.g. fiber_event_send). |
+-------------------+---------------------------------------------------------+ +-------------------+---------------------------------------------------------+
@ -113,4 +116,4 @@ and :option:`-Iinclude` for your compile, then any code using
#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
form which is more explicit. form which is more explicit.