Removed the word "file" after all the MDEF to avoid redundancy
Edited single line under overview folder in order to
gramatically correct the use of "file".
Change-Id: Ie785aa8c620f095fcd4171ef4efd2d056d6fa04b
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Corrected formatting to produce cleaner HTML output.
Change-Id: I7f2f655498829ed7fd8c468e1d6d7d04d595f181
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
Corrected minor grammar issues related to platform config description
Change-Id: I6960366ae088957dbff588adabc01adb15385066
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
Adds the correct use of Doxygen grouping
for in-code documentation.
Change-Id: I25d2e9259e27808da8a032f91dfeff4711bc1f4b
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
Remove the hard dependencies on EXPERIMENTAL symbol. Mark all the
symbols the relied on EXPERIMENTAL as EXPERIMENTAL in their prompt
Change-Id: I2779b0ed0776b3d510a8e2e44b35b83d7ad2377c
Signed-off-by: Dirk Brandewie <dirk.j.brandewie@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
The inconsistent and extended use of |codename| and |project| has been
corrected.
A sentence had to be changed dramatically to keep clarity.
Change-Id: I1e18a8c40298a46af002ddb226bb16ea0b508414
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Updated the SDK location in quick start documentation to the new Zephyr SDK 0.6
hosted in 01.org.
Change-Id: I8a362a27076b81fc867756497fc2cae5b360f4c5
Signed-off-by: Javier B Perez Hernandez <javier.b.perez.hernandez@linux.intel.com>
Corrected some punctuation characters to improve readability.
Change-Id: I44930a8a314f9fa5f3da216df3c7d2262c9cb1ef
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
Format code blocks inside the main list, otherwise every block of code
breaks the list.
Change-Id: I6d48a0a3f8a3fedc832ebd9523eef52ea730b218
Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
Removed steps are not needed since Galileo grub from SPI loads grub
from SD card directly and user gets confused with unneeded
instructions.
Change-Id: I65aa114b808e0ac8dc8e6c3eb62ba4a51e2dbf2a
Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
When line is split the html output does not format list correctly.
Change-Id: I942529d134ec6afc65ae11400a2702d5d7051cbd
Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
Use low case directories for grub and kernel and align them inside
list.
Change-Id: If701dc3520f823dd184e70f410141a8a2349edd3
Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
The current list is broken with output like below:
...
:file:` microkernel.elf` to the $SDCARD/kernel folder
...
Change-Id: I977f8365a2da9d25e34f39fb31407a31dd062f61
Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
Instead of loading all indexed doxygen symbols in one page, we
use the defined groups to load the API documentation in the specific
sections and reduce the trash coming from doxygen to just what we
need.
Change-Id: I030e3de33e8cc26871f95cd45a50af0cae1bb942
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Some functions are behind ifdefs, so defining those to allow
indexing and displaying in the documentation.
Change-Id: Id48dcc59b0793e0788f44ebd7c172f0bf3253ed2
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
toc tree.
In order to gerrit include the recommended practices
guidelines it need to appear in the toc tree.
Change-Id: Ib985fa2238bfd03e780dce2fda4242997f43eb06
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
Grammar updates.
Corrected formatting to produce cleaner HTML output
Document structure is updated to reflect the current changes
within the entire documentation project.
Change-Id: Icc389ddec16ddfa40ecbbb5871af44563374415c
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
Changes made to streamline using Gerrit recommended practices.
Changes included edits to grammar, punctuation, spelling,
word usage across multiple files.
Signed-off-by: steveballard123 <stephen.r.ballard@intel.com>
Change-Id: I286eb508abe10bb2ca0dd1b070fe7887fd5020e6
Rewrote and edited for clarity, punctuation, grammar, word usage.
Signed-off-by: Steve Ballard <stephen.r.ballard@intel.com>
Change-Id: I0332be9152312047a39067e7d610a563352abb1b
Revises and supplements information on concepts.
Change-Id: I7dd9dd2e99cd5d975cc0f617b076dcf13c414fd0
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
also add a readme saying files here are auto-generated.
Change-Id: Id33056192d8020c6cddcd12f406d15384db374ac
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Revises microkernel object sections to make it clear that objects
are referenced by name. (e.g. MY_TASK) Also adds text to make it
clear that task groups are named entities.
Change-Id: I3480f3526293dae7a0bab2006250c97334e04dfb
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
The platform configurations micro_ti_lm3s6965_defconfig and
nano_ti_lm3s6965_defconfig are obsolete. The correct names
are micro_basic_cortex_m3_defconfig and nano_basic_cortex_m3_defconfig
respectively.
Change-Id: I0642008355a1abc70bc89db5202dab8266af4542
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
The term "generic pc" is obsolete and has been supplanted by "ia32" and
"basic_xxx" as appropriate.
Change-Id: I7064eead81d526e2df89a7ccbfe1879f2e402f41
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Adds a note to the mutex documentation indicating that the priority
inheritance algorithm caps the raising of the priority at PRIORITY_CEILING.
Change-Id: Ie87efe83e3fa0fc8ba55e584692f8de44347eb1a
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Corrects the description of the priority inheritance algorithm used by mutexes.
It also draws attention to one of its short-comings.
Change-Id: I5aba6221fb9e9ed78e3bfe6509ca3d6e13743e71
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Adds in a couple of pieces of useful information which improve
alignment between task documentation and fiber documentation.
Change-Id: I04b65aa6d125842205de3dd6a65dbe2b8e6853d6
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Provides additional details about the use of fibers, following
the standard format now being used for kernel services.
Change-Id: Iee5cca7af213259f1dec53d75b729388fcf93bf8
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Fixes the following error when generating the apps_microkernel documentation.
.../apps_microkernel.rst:57:ERROR: Error in "code-block" directive:
unknown option: "lineos".
The option was supposed to be "linenos". The generated HTML document now
properly displays the sample MDEF file contents.
Change-Id: I510f2783ff656e980e222ffc6dc213e8dd45d136
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
This patch is based on some code contributed by Dirk Brandewie.
This is a generic data structure for queuing data in a FIFO ring
buffer. Any given data enqueued is annotated with an app-specific
type identifier, and small integral value. Use of a data pointer
is optional if the necessary information can be conveyed in the
annotations. We want all the metadata to fit in a single DWORD.
The ring buffer always contains at least one free dword in the
buffer to correctly distinguish between full and empty queues.
Concurrency control is almost nonexistent; depending on usage,
apps may want to introduce the usage of semaphores and/or mutexes
to preserve the integrity of the ring buffer or provide notifications
when data is available.
Change-Id: I860262d2afc96db4476d4c695a92f7da355ab732
Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
Renames the document to better reflect its true nature -- it is
a reference guide that provides information about existing platform
configurations, not a "how to" that provides information about
creating a new platform configuration.
Re-orders the platform configuration entries so that they appear
in alphabetical order, and moves the links to the individual
platform configuration sections to the end. This allows a reader
to use the table to identify a platform configuration of interest,
then click on the link that follows to obtain more details.
Note: It would be ideal if the link to a specific platform configuration
section could be embedded in the associated table entry, but the :ref:
tag doesn't seem to allow this.
Change-Id: I8865dcb54b8abd92658e00c3d7d17dcead4442ac
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
The "introduction" section adds no value, and has already been
pruned from all of the other platform configuration guides.
Change-Id: I13bfd39d4806b3dd213a0d3f9023fd41e415db2a
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Adds in a label that can be used to reference the nanokernel semaphore
documentation, similar to what's available for other nanokernel services.
Change-Id: Ic97852e85b41a9e6e778dde820b98ea5be5f06f1
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
The file is already included globally in conf.py
Change-Id: If1b37936a6f5654e1e0397314389985997d85b73
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Also move about_zephyr back to main page and remove duplicated
examples for nano kernel.
Change-Id: Icbc899ce5688d853a59dfc5c8d50f34048ed212b
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit fixes all warnings about cross-references and file names. It
addresses all mark-up issues. Only the warnings regarding Doxygen
objects and files that are intentionally not added to a toctree are left
unhandled.
Change-Id: I5d840522ea0bade4f183e447745244aecf893c94
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Changes the names and file structure for all code relevant collaboration
content. Updates the cross-references and figures where applicable.
Content was changed as little as possible.
Change-Id: If26499b12d7f49443167114e85d31709c01f5758
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The master files are changed to reflect the new structure. This
structure is identical to the proposed structure.
Change-Id: Ic8e205d84f8a0b7f60fad621073c95af11008cb8
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Rodrigo Caballero