Doc: Create the Kernel Primer.
Creates the Kernel Primer, removes overview modules that are no longer needed and updates the master file to include the new part. Change-Id: I6d7f53f019089d502e763ecc1789fb152c90c465 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This commit is contained in:
parent
a13fddb7da
commit
a952569f02
|
@ -13,7 +13,7 @@
|
|||
:maxdepth: 1
|
||||
|
||||
quick_start/quick_start.rst
|
||||
zephyr_kernel
|
||||
kernel/kernel.rst
|
||||
zephyr_project
|
||||
|
||||
|
||||
|
|
|
@ -1,17 +1,26 @@
|
|||
Zephyr Kernel Objects
|
||||
######################
|
||||
.. _zephyr_kernel:
|
||||
|
||||
Use this information to understand how the different kernel objects of
|
||||
the Zephyr Kernel function. The purpose of this section is to help you
|
||||
understand the most important object of the operating system. In order
|
||||
to help you navigate through the content, we have divided the objects
|
||||
in :ref:`basicObjects`, :ref:`nanokernelObjects` and
|
||||
:ref:`microkernelObjects` objects.
|
||||
The Zephyr Kernel
|
||||
#################
|
||||
|
||||
We strongly recommend that you start with the :ref:`basicObjects` before
|
||||
moving on to the :ref:`nanokernelObjects` or the
|
||||
:ref:`microkernelObjects`. Additionally, we have included some
|
||||
:ref:`driverExamples` for better comprehension of the objects' function.
|
||||
The purpose of this section is to help you understand the operation of the kernel and its features.
|
||||
This section also provides detailed information regarding the microkernel and the nanokernel
|
||||
services. Finally, you can find the information regarding the kernel's drivers and networking
|
||||
capabilities.
|
||||
|
||||
This section does not replace the Application Program Interface
|
||||
documentation, rather, it offers additional information. The examples should provide
|
||||
you with enough insight to understand the functionality of the services but are not
|
||||
meant to replace the detailed in-code documentation.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
overview/overview.rst
|
||||
microkernel/microkernel.rst
|
||||
nanokernel/nanokernel.rst
|
||||
drivers/drivers.rst
|
||||
networking/networking.rst
|
||||
|
||||
.. rubric:: Abbreviations
|
||||
|
||||
|
@ -27,11 +36,4 @@ moving on to the :ref:`nanokernelObjects` or the
|
|||
| IDT | Interrupt Descriptor Table |
|
||||
+---------------+-------------------------------------------------------------------+
|
||||
| XIP | eXecute In Place |
|
||||
+---------------+-------------------------------------------------------------------+
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
contexts.rst
|
||||
microkernel.rst
|
||||
nanokernel.rst
|
||||
+---------------+-------------------------------------------------------------------+
|
|
@ -1,26 +0,0 @@
|
|||
.. _basicObjects:
|
||||
|
||||
Execution Contexts
|
||||
##################
|
||||
|
||||
Tasks, fibers and interrupt service routines serve as the basis of the
|
||||
operating system functionality. The purpose of this section is to
|
||||
describe how this execution contexts operate, their behavior and their
|
||||
implementation. Using this information you should be able to understand
|
||||
what each context is capable of, how it operates and where its limits
|
||||
are.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
fibers.rst
|
||||
interrupts.rst
|
||||
tasks.rst
|
|
@ -1,16 +0,0 @@
|
|||
.. _zephyr_kernel:
|
||||
|
||||
The Zephyr Kernel
|
||||
#################
|
||||
|
||||
This section contains the information about the kernel's code.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
architecture/architecture.rst
|
||||
object/object.rst
|
||||
net/network.rst
|
||||
platform/platform.rst
|
||||
doxygen/doxygen_output.rst
|
||||
development/development.rst
|
Loading…
Reference in a new issue