Commit Graph

8 Commits

Author SHA1 Message Date
Rodrigo Caballero 0452ab7463 doc: Fix warnings shown when building the documentation.
Fixes broken labels and the following warnings:

/home/nashif/Viper/forto-collab/doc/about_zephyr.rst:1: WARNING:
malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/apps_code_dev.rst:26:
WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/apps_code_dev.rst:73:
WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/apps_code_dev.rst:90:
WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_common_procedures.rst:24:
WARNING: Enumerated list ends without a blank line; unexpected unindent.
/home/nashif/Viper/forto-collab/doc/application/
apps_common_procedures.rst:12: ERROR: Unknown target name:
"set_environment_variables".
/home/nashif/Viper/forto-collab/doc/application/apps_kernel_conf.rst:26:
WARNING: Block quote ends without a blank line; unexpected unindent.
/home/nashif/Viper/forto-collab/doc/application/apps_kernel_conf.rst:75:
WARNING: Malformed :option: u'CONF_FILE =', does not contain option
marker - or -- or /
/home/nashif/Viper/forto-collab/doc/application/
apps_kernel_conf.rst:109: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application
/apps_kernel_conf.rst:172: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_kernel_conf.rst:208: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_object_conf.rst:24: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_object_conf.rst:76: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_object_conf.rst:89: WARNING: Include file
u'/home/nashif/Viper/forto-collab/samples/microkernel/apps/
philosophers/proj.mdef' not found or reading it failed
/home/nashif/Viper/forto-collab/doc/collaboration/code/doxygen/
defines.rst:65: WARNING: Line spec '42-47': no lines pulled from include
file u'/home/nashif/Viper/forto-collab/samples/microkernel/apps/
philosophers/src/phil.h'
/home/nashif/Viper/forto-collab/doc/collaboration/code/doxygen/
functions.rst:13: ERROR: Unknown interpreted text role "code:c".
/home/nashif/Viper/forto-collab/doc/collaboration/code/doxygen/
functions.rst:13: ERROR: Unknown interpreted text role "code:c".
/home/nashif/Viper/forto-collab/doc/collaboration/code/
gerrit_practices.rst:53: WARNING: Title underline too short.

Change-Id: I41cb0ee3edb401b0f8e9ecab1819278f0465343d
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:36 -05:00
Rodrigo Caballero c1c1ffe7f7 doc: Change API tables to lists in the Kernel Primer.
The tables in the Kernel Primer are changed to lists. Making it easier
to update them. Other minor changes were done to ensure consitency.
The :c: and :cpp: markup has been fixed. When the documentation for a
call exists, then it is linked.

Change-Id: I8f389a0a0ca7c5fe904c0a1fa520e2e499f1001b
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:29 -05:00
Allan Stephens 8d85985d87 doc: Enhance section on nanokernel FIFO objects
Provides additional details about the use of nanokernel FIFOs,
following the standard format now being used for kernel object types.

Change-Id: Ic6828c1730d160f79ae51ebf004d6af2e7adb7af
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-02-05 20:15:32 -05:00
Peter Mitsis 3d2f48b68f doc: Add missing Usage section title
Change-Id: I2533bd7f16ad1e3ba44f9c0c282067dc82d33c26
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:32 -05:00
Peter Mitsis d4dd9842e6 doc: remove extra closing brace in code example
Change-Id: I0286800966a0e3f41874db9ccf1c31afedd76d1e
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:32 -05:00
Peter Mitsis a4266bdf3a doc: Add nanokernel FIFO code samples
Adds examples showing how to ...
 1. initialize a nanokernel FIFO
 2. write to a nanokernel FIFO
 3. read from a nanokernel FIFO with a timeout

Change-Id: I6dbe741c2439a80e663f31372b11ef85b9e5b503
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:28 -05:00
Benjamin Walsh b981326ae9 microkernel: remove last remnants of 'process' from text
There is no concept of a "process" in the system, so remove last
mentions of that concept from free-form text (doc, comments, macro
parameter names).

Change-Id: Ic1b73371c448ed93b0db46bc9bb412d1e1dbc8bd
Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
2016-02-05 20:15:27 -05:00
Allan Stephens 8fe4f41ce6 doc: Updates to nanokernel data passing services
Partitions services into a separate file for each service. Updates
API tables to incorporate missing APIs.

Change-Id: Ia08b52b4865967beda02851cfe4a7d5ca4e8f596
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-02-05 20:15:20 -05:00