michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Improve accessibility of microkernel and nanokernel info

Browse source 
Removes an unnecessary level of headings in the microkernel and
nanokernel sections of the Zephyr kernel documentation, providing
users with direct access to the major service areas of the
microkernel and nanokernel from the main kernel web page. Also
greatly reduces the introductory text for these 2 sections,
since users can now easily find out what the various subsections
provide by simply clicking on them.

Change-Id: Ibc5858daad49cfb6567dfad285b7a1d5a755d149
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
This commit is contained in:
Allan Stephens 2015-08-11 12:32:28 -04:00 • committed by Anas Nashif
commit 10ba8f7e6e
2 changed files with 6 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

19
doc/kernel/microkernel/microkernel.rst
View file

@ -3,22 +3,9 @@
Microkernel Services
####################
Section Scope
*************
This section provides an overview of the most important microkernel
services, and their operation.
Each service contains a definition, a function description, and a table
of :abbr:`APIs (Application Program Interfaces)` including the context that may
call them. This section does not replace the Application Program Interface
documentation but rather complements it. The examples should provide
you with enough insight to understand the functionality but are not
meant to replace the detailed in-code documentation. Please refer to the API documentation for
further details regarding each object's functionality.
Services Documentation
*********************
This section describes the various services provided by the microkernel.
These services are available in microkernel applications, but not
nanokernel applications.
.. toctree::
:maxdepth: 1

17
doc/kernel/nanokernel/nanokernel.rst
View file

@ -3,20 +3,9 @@
Nanokernel Services
###################
Section Scope
*************
This section provides an overview of the most important nanokernel
services. The information contained here is an aid to better understand
how the kernel operates at the nanokernel level.
Document Format
***************
Each service is broken off to its own section, containing a definition, a
functional description, the service initialization syntax, and a table
of APIs with the context which may call them. Please refer to the API documentation for further
details regarding the functionality of each service.
This section describes the various services provided by the nanokernel.
These services are available in both microkernel applications and
nanokernel applications.
.. toctree::
:maxdepth: 1