Enhances description for event definition. Adds examples of event
use. Enhances descriptions in event API table.
Note: Enhancement of the initial part of this document is left
for future commits.
Change-Id: Ic754daacecbcb2b0ddc6b3a59d0a3b88d622662f
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Enhances description for semaphore definition. Adds examples of
semaphore use. Fills in gaps in the semaphore API table.
Note: Enhancement of the initial part of this document is left
for future commits.
Change-Id: I45a1326e564f20db2beed0c761584804ad61b053
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
The contents are split in two: Zephyr Kernel and Zephyr Project. Under
Zephyr Kernel is all the content directly about the code base. Under
Zephyr Project is all the content about the development of the kernel
and of applications. Only the Doxygen document needed to be split. The
output of the in-code comments was placed under the Zephyr Kernel while
all the Doxygen guidelines and the extraction process information were
placed under the Zephyr Project.
Change-Id: I4f7b674d19449968e976b63f40bcaa9737cc0ecb
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
ISR documentation changed to incorporate new ISR functionality.
Change-Id: I35a95dab9f4fd407ff297f55faa1e3ebbefc8064
Signed-off-by: Carol Lee <carol.lee@windriver.com>
This text was originally used to illustrate the layout that would
be used for all microkernel object documentation, but it's no
longer needed since enough files have been converted to make
the approach self-evident.
Change-Id: I2646f7e7c0e541dd5930c13b2319aa85205a8111
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
If set, 'make qemu' will direct its console output to a named pipe and
disable the interactive monitor. Intended for use with the new sanity
check system which will parallelize test execution.
Change-Id: I902f77c02ed3f210891ff13147afea890e64d9c1
Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
Fixes the tables of the APIs so that they are displayed properly on the
HTML output.
Change-Id: I616def73e84d5b0ec51e5bc3fa0ce3673e9af344
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Removes the generic_pc and generic_pc_pentium4 platform configuration files
as Zephyr will not support them.
Change-Id: Iffa917d8e31702e6280eca3cbc9cdaf3f8ed9c98
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Removed "most important microkernel objects" and changed to
"microkerel objects are" and listed all the microkernel objects.
Change-Id: I18c63952085cc91f6d86045a86a5ea3b59982ee2
Signed-off-by: Carol Lee <carol.lee@windriver.com>
Split the contents of microkernel.rst into several files. Each file
contains only the information of a specific object type. Labels have
been added to accomodate cross-references to each object type. Changed
the tables that did not comply with a 100 character line length.
Change-Id: I983bc76a89b1cf01442de53737de4f76a5262264
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The overview modules need to be updated after changing the file names.
The main overview module was not renamed. Therefore, no changes are
needed outside of the object folder.
Change-Id: I34590db3a680b2182aa86544820572a657b8e1ae
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The object documentation files need to be renamed before they can be
split and restructured.
Change-Id: Ia3262885b801ed02b231ab14c6d4c0f4e2424cae
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Also scan for .S files, not .s. All .s files have been renamed to
.S.
Change-Id: I73f8fccc0a3be950d47020e86cc6d24ee1ad37c4
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This wasn't being used anywhere and seems to be a legcy of old sanity tests.
By removing this x86 is no longer a special case.
Change-Id: I78c668a7d9e6bc7c7f60d91712c4c21c0121b7e2
Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
Includes the procedure and updates all needed cross-references. The
procedure will include examples of MDEF, Makefiles and .conf files.
Change-Id: If5b3e88843a9257036265668765e3ad012818ae9
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
General information regarding the development of microkernel
applications is included. A step by step process is included but
still in development. Cross-references are added and updated as needed.
Change-Id: Ib7442883016c92c660d03d806009a0bd1932fce7
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The license guidelines list which code licenses are acceptable and what
licenses can be problematic. It also includes the IANAL disclaimer. The
collaboration.rst was changed to include the new content.
Change-Id: I92081a13575453c68b2492129126be4b4cee9766
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Adds new Quark platform configuration documentation to support the Galileo board.
Change-Id: I00ccc01ee75dbd54721d2d36583e9c7626e237d8
Signed-off-by: Carol Lee <carol.lee@windriver.com>
Adds infrastructure for platform configuration guides,
starting with the fsl_frdm_k64f platform configuration.
Incorporates inline sphynx tags except :guilabel:
which does not bold gui labels, a feature needed
for scanning a procedure for key info.
Change-Id: I4f5154dae896449fb709842501c69d8757deca3e
Signed-off-by: Carol Lee <carol.lee@windriver.com>
Added a asterisk in front of every line of the comments to fully comply
with the Javadoc style. Updated all cross-references to comply with the
new style. Added a note indicating explicitly that enums are to be
documented just as structs.
Change-Id: If017e14e3e478ec28befb5c1fcae92090f91c32e
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Additional information regarding the microkernel is provided. Earlier
content was edited and some phrasing was improved in the introduction.
Change-Id: Ic940688d1b68dd410b0f2efecc73a7eff45fe6aa
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Added and updated cross-references. Made changes in content to increase
clarity based on feedback. Performed minor spelling, grammar and style
corrections.
Change-Id: I66c1920fd743a9b7f7a2b5313504c97bb7879afb
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Changed PIPE get APIs description to Get data off pipe instead of put data on.
Change-Id: If68b1f15541de1acd43df80cbd9799bb902fda0d
Signed-off-by: Javier B Perez Hernandez <javier.b.perez.hernandez@linux.intel.com>
Add a new theme inherited from sphinxdocs to allow zephyr
specific customisations and improvements.
Initially, it adds css style for guilabel and makes that
appear bold in html output.
Change-Id: I2c80b3be4d06ab73907d2f117ea84c847c0ddf7f
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Changes the start tag of the comments from /*! to /** in order to comply
with the Javadoc commenting style.
Change-Id: Ie6c46f47ee0a7dd6be9788830620dd1c7ee51159
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The architectural overview of the OS contains the general information
regarding the nanokernel, the microkernel, the driver model and the
application model.
Change-Id: I5a16f3f5ec5023239a772d3e559bd761795c27d4
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Memory Map text and examples added to current Objects documentation.
Code-block type changed from console to c and syntax error with file
tag.
Change-Id: Ib350425b3512e0d19d3e6a4c66ca73120a622a97
Signed-off-by: Carol Lee <carol.lee@windriver.com>
The documentation master file index.rst is changed to include the
documentation style guide.
Change-Id: I5074968d5e1be754c38f599a5220bf9596abd828
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The guidelines contain how to tag content using the ReST markup employed
by Sphinx. Only the project specific rules are supplied. The general
syntax is provided by the Sphinx documentation. Examples and templates
are provided to make creating documentation easier.
Change-Id: If97e1f01de5d4f3de4cad82b7b35279a199433bf
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The style guidelines are mandatory patterns of writing designed to ease
the creation of documentation for the Zephyr project. All authors, which
includes the developers, must adhere to the style guide.
More detailed information, including examples, will be added shortly.
Change-Id: I198e5fe90b279560a60c028260b1fc8c972d322a
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The guidelines include information regarding: lists, modular writing,
notices, parallelism and simple English.
Also includes the capitalization, punctuation and spelling conventions
for the project.
Change-Id: I754f492db41dc5cc2432d03441b0526603b043e6
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Add basic Bluetooth documentation with sample.
Change-Id: I46077c8ee7e0ef464cda2374056fe061caaaee8b
Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
Now spells out the name of the associated microkernel object in full.
Also renames file containing FIFO code to correspond to the associated
public include file (microkernel/fifo.h).
Change-Id: I47f7a2ca01e0feff8f499acda0000fe475e7ee5a
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Now spells out the name of the associated microkernel object in full.
Change-Id: Iee532e9fbbcafbf9ba44c91de0894b7181285e8e
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Makes name more consistent with other CPU_CORTEX_M* options.
Change-Id: I65968cb300207ba0de6231d9a67f2720be77b6ba
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Adds a description for the mutex object, which is currently
undocumented. This text uses an enhanced structure that presents
the material in a more user-friendly manner.
Change-Id: I986be388b4943064d0449c2194de786fbad84863
Signed-off-by: Carol Lee <carol.lee@windriver.com>
This commit sends a draft of the topics that will be included
as a section for Kbuild documentation.
It also includes content for the Kconfig Structure section.
The intention of this draft is to start gathering comments on
the content sent and the initial menu of topics.
Change-Id: I11f62b015ef0fc722f5e0a089ec83cb0a08b3889
Signed-off-by: Juan Manuel Cruz <juan.m.cruz.alcaraz@linux.intel.com>
