OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/kernel/kernel.rst

33 lines
1.4 KiB
ReStructuredText
Raw Normal View History

doc: Overhaul of Zephyr Kernel Primer overview section A complete rewrite of the Overview section. The revised text provides a more logical and comprehensive introduction to the main concepts and capabilities of Zephyr, without providing an excessive level of detail. (Those details should be provided by the remaining sections of the Kernel Primer.) This rewrite has also resulted in some small changes to the About Zephyr and other Kernel Primer sections. Change-Id: Idd4d5e0f0aabaaee8cd43d12563018ba4d8f7417 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2015-08-13 03:46:55 +08:00
.. _zephyr_primer:
Add Object Documentation Adds the basic kernel objects' documentation describing the function of tasks, fiber and interrupt service routines. Adds the nanokernel objects' docuementation describing the function of the most important nanokernel objects. Adds the microkernel objects' documentation describing the function of the most important microkernel objects. Changes the index.rst file to include the Object Documentation. Change-Id: Ib35d973cc3575a7ecc32c4ab175e05cb298e3306 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-20 23:51:50 +08:00
doc: Overhaul of Zephyr Kernel Primer overview section A complete rewrite of the Overview section. The revised text provides a more logical and comprehensive introduction to the main concepts and capabilities of Zephyr, without providing an excessive level of detail. (Those details should be provided by the remaining sections of the Kernel Primer.) This rewrite has also resulted in some small changes to the About Zephyr and other Kernel Primer sections. Change-Id: Idd4d5e0f0aabaaee8cd43d12563018ba4d8f7417 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2015-08-13 03:46:55 +08:00
Zephyr Kernel Primer
####################
Add Object Documentation Adds the basic kernel objects' documentation describing the function of tasks, fiber and interrupt service routines. Adds the nanokernel objects' docuementation describing the function of the most important nanokernel objects. Adds the microkernel objects' documentation describing the function of the most important microkernel objects. Changes the index.rst file to include the Object Documentation. Change-Id: Ib35d973cc3575a7ecc32c4ab175e05cb298e3306 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-20 23:51:50 +08:00
doc: Overhaul of Zephyr Kernel Primer overview section A complete rewrite of the Overview section. The revised text provides a more logical and comprehensive introduction to the main concepts and capabilities of Zephyr, without providing an excessive level of detail. (Those details should be provided by the remaining sections of the Kernel Primer.) This rewrite has also resulted in some small changes to the About Zephyr and other Kernel Primer sections. Change-Id: Idd4d5e0f0aabaaee8cd43d12563018ba4d8f7417 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2015-08-13 03:46:55 +08:00
This section describes the major features of the Zephyr kernel
and how to use them.
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>
2015-08-08 02:28:19 +08:00
.. toctree::
:maxdepth: 2
overview/overview.rst
doc: Add information about kernel clocks Describes clocks available for use. Adds examples of direct clock use. Provides API tables. Change-Id: Icca8e1c8e75eed29c91f1387aed682dfdefdadb1 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2015-08-10 22:23:54 +08:00
common/common.rst
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>
2015-08-08 02:28:19 +08:00
microkernel/microkernel.rst
nanokernel/nanokernel.rst
networking/networking.rst
Add Object Documentation Adds the basic kernel objects' documentation describing the function of tasks, fiber and interrupt service routines. Adds the nanokernel objects' docuementation describing the function of the most important nanokernel objects. Adds the microkernel objects' documentation describing the function of the most important microkernel objects. Changes the index.rst file to include the Object Documentation. Change-Id: Ib35d973cc3575a7ecc32c4ab175e05cb298e3306 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-20 23:51:50 +08:00
.. rubric:: Abbreviations
+---------------+-------------------------------------------------------------------+
| Abbreviations | Definition |
+===============+===================================================================+
| API | Application Program Interface: typically a defined set |
| | of routines and protocols for building software inputs and output |
| | mechanisms. |
+---------------+-------------------------------------------------------------------+
| ISR | Interrupt Service Routine |
+---------------+-------------------------------------------------------------------+
| IDT | Interrupt Descriptor Table |
+---------------+-------------------------------------------------------------------+
| XIP | eXecute In Place |
doc: Add information about kernel clocks Describes clocks available for use. Adds examples of direct clock use. Provides API tables. Change-Id: Icca8e1c8e75eed29c91f1387aed682dfdefdadb1 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2015-08-10 22:23:54 +08:00
+---------------+-------------------------------------------------------------------+