michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: integrate about_zephyr -> index to remove warnings

Browse source 
Warnings about duplicate label (_about_zephyr) crept up because of the
way the about_zephyr document was included in the index. This is a
short document, makes sense to have it as part of the index.rst; it
removes clutter from the directory as well as the warning.

Change-Id: Ifdc3a93fb4316be4aef685257d14749769443b41
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This commit is contained in:
Inaky Perez-Gonzalez 2016-06-13 14:44:55 -07:00 • committed by Anas Nashif
commit 32970f1382
2 changed files with 65 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

67
doc/about_zephyr.rst
View file

@ -1,67 +0,0 @@
:orphan:
.. _about_zephyr:
Introduction to the Zephyr Project
##################################
The Zephyr Kernel is a small-footprint kernel designed for use on
resource-constrained systems: from simple embedded environmental
sensors and LED wearables to sophisticated smart watches and IoT
wireless gateways.
It is designed to be supported by multiple architectures, including
ARM Cortex-M, Intel x86, and ARC. The full list of supported platforms
can be found :ref:`here <board>`.
Licensing
*********
The Zephyr project associated with the kernel makes it available
to users and developers under the Apache License, version 2.0.
Distinguishing Features
***********************
The Zephyr Kernel offers a number of features that distinguish it from other
small-footprint OSes:
#. **Single address-space OS**. Combines application-specific code
with a custom kernel to create a monolithic image that gets loaded
and executed on a system's hardware. Both the application code and
kernel code execute in a single shared address space.
#. **Highly configurable**. Allows an application to incorporate *only*
the capabilities it needs as it needs them, and to specify their
quantity and size.
#. **Resources defined at compile-time**. Requires all system resources
be defined at compilation time, which reduces code size and
increases performance.
#. **Minimal error checking**. Provides minimal run-time error checking
to reduce code size and increase performance. An optional error-checking
infrastructure is provided to assist in debugging during application
development.
#. **Extensive suite of services** Offers a number of familiar services
for development:
* *Multi-threading Services* for both priority-based, non-preemptive
fibers and priority-based, preemptive tasks with optional round robin
time-slicing.
* *Interrupt Services* for both compile-time and run-time registration
of interrupt handlers.
* *Inter-thread Synchronization Services* for binary semaphores,
counting semaphores, and mutex semaphores.
* *Inter-thread Data Passing Services* for basic message queues, enhanced
message queues, and byte streams.
* *Memory Allocation Services* for dynamic allocation and freeing of
fixed-size or variable-size memory blocks.
* *Power Management Services* such as tickless idle and an advanced idling
infrastructure.

66
doc/index.rst
View file

@ -41,7 +41,71 @@ Sections
You can find further information on the `Zephyr Project Wiki`_.
.. include:: about_zephyr.rst
.. _about_zephyr:
Introduction to the Zephyr Project
##################################
The Zephyr Kernel is a small-footprint kernel designed for use on
resource-constrained systems: from simple embedded environmental
sensors and LED wearables to sophisticated smart watches and IoT
wireless gateways.
It is designed to be supported by multiple architectures, including
ARM Cortex-M, Intel x86, and ARC. The full list of supported platforms
can be found :ref:`here <board>`.
Licensing
*********
The Zephyr project associated with the kernel makes it available
to users and developers under the Apache License, version 2.0.
Distinguishing Features
***********************
The Zephyr Kernel offers a number of features that distinguish it from other
small-footprint OSes:
#. **Single address-space OS**. Combines application-specific code
with a custom kernel to create a monolithic image that gets loaded
and executed on a system's hardware. Both the application code and
kernel code execute in a single shared address space.
#. **Highly configurable**. Allows an application to incorporate *only*
the capabilities it needs as it needs them, and to specify their
quantity and size.
#. **Resources defined at compile-time**. Requires all system resources
be defined at compilation time, which reduces code size and
increases performance.
#. **Minimal error checking**. Provides minimal run-time error checking
to reduce code size and increase performance. An optional error-checking
infrastructure is provided to assist in debugging during application
development.
#. **Extensive suite of services** Offers a number of familiar services
for development:
* *Multi-threading Services* for both priority-based, non-preemptive
fibers and priority-based, preemptive tasks with optional round robin
time-slicing.
* *Interrupt Services* for both compile-time and run-time registration
of interrupt handlers.
* *Inter-thread Synchronization Services* for binary semaphores,
counting semaphores, and mutex semaphores.
* *Inter-thread Data Passing Services* for basic message queues, enhanced
message queues, and byte streams.
* *Memory Allocation Services* for dynamic allocation and freeing of
fixed-size or variable-size memory blocks.
* *Power Management Services* such as tickless idle and an advanced idling
infrastructure.
Indices and Tables
******************