Commit Graph

323 Commits

Author SHA1 Message Date
Dmitriy Korovkin a4f6a32169 doc: Add flags to irq_connect(), IRQ_CONNECT_STATIC() and task_irq_alloc()
Change-Id: I671208ac3b1e9f6c26917e86c99337ff195ae2d4
Signed-off-by: Dmitriy Korovkin <dmitriy.korovkin@windriver.com>
2016-02-05 20:24:44 -05:00
Anas Nashif 833fb90087 doc: fix parameters to IRQ_CONFIG
Change-Id: I5c3e22ad2311faf76ada79a61eac7ccac5864334
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:43 -05:00
Peter Mitsis 111323fc90 doc: Fix typo in nanokernel semaphore APIs
Change-Id: If3206b3113b7a47efc520887f53b3299e8da2404
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:24:43 -05:00
Allan Stephens 7ed2678916 doc: Remove documentation for microkernel command packet sets
Update semaphore documentation to remove mention of command
packet sets, which no longer exist.

Change-Id: I19303f7f497b7d8299723d01c91ae4f4513162f0
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-02-05 20:24:42 -05:00
Yonattan Louise 5563290d36 Add group definition to event logger.
Add the tags required by doxygen for defining the group of the
kernel event logger.

Change-Id: I96ec6b6604da5a541ce8041e6fa3c324a03ff698
Signed-off-by: Yonattan Louise <yonattan.a.louise.mendoza@intel.com>
2016-02-05 20:24:41 -05:00
Anas Nashif 5401ded10b Zephyr 0.6.0
Bump release in makefile and documentation.

Change-Id: I395e3a1caa304f00be5343160b2a62829a66ad46
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:37 -05:00
Allan Stephens 6fe1e2357f doc: Fix typo in description of microkernel semaphores
Change-Id: Iaa5e511aa0ca901fcf2f57f49dd4816898fada37
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-02-05 20:24:36 -05:00
Allan Stephens 935a809cc6 doc: Add documentation for using private events
This reflects the changes made in commit df6be15aa5...

Change-Id: Ibe1bc167390268c0e335a0b4060a600ef55d1add
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-02-05 20:24:36 -05:00
Allan Stephens a891c045a7 doc: Add section on floating point services to Kernel Primer
Change-Id: Ic96385595740796e6bb28425cacd05a1285a89bb
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-02-05 20:24:36 -05:00
Rodrigo Caballero 8f1e55044b doc: Fix headings of the API documentation.
Removes the Auto-generated text from the main heading. Changes the headings
to the consistent hierarchy used elsewhere in the documentation.

Change-Id: I146e4d7ac280b4a3bb81fc3263f826637a8bf08f
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:36 -05:00
L.S. Cook 0c2e25f73e doc: Edits to the Overview and kernel primer
Fixed typo in system_fundamentals.  Acronyms FIFO and LIFO
defined with capital letters in kernel_fundamentals. Added bold
to paragraph lists to enhance readability in application_fundamentals

Added lots of :dfn: syntax for better interlinking to API.

Corrected whitespace for sub-bullet directive.

Change-Id: If6c5bc78746686d1a4986974f1b56bf9b2caebca
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-02-05 20:24:36 -05:00
Rodrigo Caballero 0452ab7463 doc: Fix warnings shown when building the documentation.
Fixes broken labels and the following warnings:

/home/nashif/Viper/forto-collab/doc/about_zephyr.rst:1: WARNING:
malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/apps_code_dev.rst:26:
WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/apps_code_dev.rst:73:
WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/apps_code_dev.rst:90:
WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_common_procedures.rst:24:
WARNING: Enumerated list ends without a blank line; unexpected unindent.
/home/nashif/Viper/forto-collab/doc/application/
apps_common_procedures.rst:12: ERROR: Unknown target name:
"set_environment_variables".
/home/nashif/Viper/forto-collab/doc/application/apps_kernel_conf.rst:26:
WARNING: Block quote ends without a blank line; unexpected unindent.
/home/nashif/Viper/forto-collab/doc/application/apps_kernel_conf.rst:75:
WARNING: Malformed :option: u'CONF_FILE =', does not contain option
marker - or -- or /
/home/nashif/Viper/forto-collab/doc/application/
apps_kernel_conf.rst:109: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application
/apps_kernel_conf.rst:172: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_kernel_conf.rst:208: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_object_conf.rst:24: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_object_conf.rst:76: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_object_conf.rst:89: WARNING: Include file
u'/home/nashif/Viper/forto-collab/samples/microkernel/apps/
philosophers/proj.mdef' not found or reading it failed
/home/nashif/Viper/forto-collab/doc/collaboration/code/doxygen/
defines.rst:65: WARNING: Line spec '42-47': no lines pulled from include
file u'/home/nashif/Viper/forto-collab/samples/microkernel/apps/
philosophers/src/phil.h'
/home/nashif/Viper/forto-collab/doc/collaboration/code/doxygen/
functions.rst:13: ERROR: Unknown interpreted text role "code:c".
/home/nashif/Viper/forto-collab/doc/collaboration/code/doxygen/
functions.rst:13: ERROR: Unknown interpreted text role "code:c".
/home/nashif/Viper/forto-collab/doc/collaboration/code/
gerrit_practices.rst:53: WARNING: Title underline too short.

Change-Id: I41cb0ee3edb401b0f8e9ecab1819278f0465343d
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:36 -05:00
Javier B Perez Hernandez 2f4c04cb70 doc: quick start: installing: add missing package required in fedora
Add missing package "glibc-devel.i686" required to build project in fedora.

Change-Id: I1baf9a72b1ca2dbdd3aa65936875b43479779ed1
Signed-off-by: Javier B Perez Hernandez <javier.b.perez.hernandez@linux.intel.com>
2016-02-05 20:24:35 -05:00
L.S. Cook c06c666ec9 doc: Edit the Submitting Changes to Gerrit section.
The edit includes: correcting a previous rebase,
adding bullets for clarity, and other grammar fixes.

Change-Id: I9a6ac616b2eca5f2bab9728ebd8b7e50d3effbe1
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-02-05 20:24:35 -05:00
Rodrigo Caballero 8d7b52f146 doc: Change conf.py and index.rst to fix the copyright and license.
Removes permalinks and sets the correct version and release. The change places
the copyright notice and license in the footer of every page.
Both copyright and license do not appear in the website's version.

Change-Id: Idb5171b24af004fc2f7aff42aab43469f26305b4
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif d743ae6c92 doc: xtools is obsolete
We do not support xtools, although it can be used, it should not
be documented as an alternative.

Change-Id: I7be753393e4976b8c9610bdb33f1018dfef5eb95
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif e973119ef0 doc: project -> Zephyr Project
To make the documentation readable from the source I want to get rid of the
substitutions for the project name an code name. This does not add any values
and makes it unreadable when looking at the text files directly. It also causes
some issues when people use those without actually knowing what they represent,
resulting in some weird and redundant language.

Change-Id: Icc70eef90966ed19531c3406fe7a6d1866f7d81d
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif ba751c80b0 doc: codename -> Zephyr Kernel
To make the documentation readable from the source I want to get rid of the
substitutions for the project name an code name. This does not add any values
and makes it unreadable when looking at the text files directly. It also causes
some issues when people use those without actually knowing what they represent,
resulting in some weird and redundant language.

Change-Id: I09e8cbbee7c1141a7a77d3ffff59cdae2b52050c
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif ea19a2dfc1 doc: remove empty driver model documentation
Change-Id: I8131a91e6109c8cbe2b00c644a92005191827966
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif 50fafd8e32 doc: remove disclaimer
Change-Id: Idae9b7e5b26dc48af769da5bcaf36e22ae1a614c
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif df64bba4d7 doc: build system documentation cleanup
Change-Id: I8a55b103f4143770c74434c376c4d1770a0374e3
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif 68f6032006 doc: fixed inclusion of files to avoid warnings
Change-Id: I454a998851f3546f98601ff3b24770e32cf3b268

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif 631f395096 doc: fixed bullet list alignment
Change-Id: I2220cba5c04f67b43d23de815451a17dc8a3c0e3
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif ceba13640c doc: update and consalidate galileo setup procesudre
Change-Id: I309fb071e37f85289f92dd52af52521b8e3f4a9b
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif bc6b6100ec doc: build system updates
Change-Id: Ifbe4dcad0ecf0a3ceb0de9ed83b4f70246e26e72
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif b3395c338b doc: update quick start guide
Change-Id: Ib9619257da6f405766501e8b067ca316de58faf7
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif 4c2e5de598 doc: remove PM keyword from substitutions
Change-Id: If6fdc05a7ff07fef057bbb33b98002321d321d2d
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif c2eb28e947 doc: rename 'about' section
'About' alone conflicts with the website menu called about and is
none descriptive.

Change-Id: Ib112baded87b2a3175ba22d0efaddfcb46a18c8c
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Yonattan Louise 6221ef066e doc: Kernel event logger documentation
Add the kernel event logger documentation where the user can find
how to use this mechanism and which event logging points are
available currently.

Change-Id: I6d86c7b79c6b4a56a9e3514b6c4933a35e0c782f
Signed-off-by: Yonattan Louise <yonattan.a.louise.mendoza@intel.com>
2016-02-05 20:24:34 -05:00
Rodrigo Caballero e29545556a doc: New note with markup for the function's Doxygen document.
A new note explains the correct ReST markup for links to the functions
in the API documentation extracted by Doxygen.

Change-Id: Ifd61794445bc559485dd4034ae68897271837939
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:33 -05:00
Rodrigo Caballero 1ff116950b doc: Add Application Directory Structure content to the App. Primer.
Adds the information regarding the application's directory structure
expected by the kernel and the build system. It includes how to create
a Makefile for the application's directory.

Change-Id: I4911bd86205831d7cdf1dea6095a9090ba9122b9
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:33 -05:00
Rodrigo Caballero 06ba8f7b34 doc: Fix labels markup and add figures to Application Primer.
Changes the labels to be consistent with the rest of the documentation.
Fixed other minor markup and language issues.
Adds the missing figures for apps_kernel_conf.rst

Change-Id: I34a7650c04bb2d1f525eaad4efa7395f8272c88f
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:33 -05:00
Rodrigo Caballero d36ca1b76d doc: Fix syntax in "Coding Style Guidelines".
corrected syntax of some inline code references

Change-Id: Id4deaefd655447b4e01665f6029d6ba92606da1f
Signed-off-by: Leona Cook <leonax.cook@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:32 -05:00
L.S. Cook d8e9f815d2 doc: Adding some parallelism to the documentation.rst scope summary
Deleting some redundant references.

Change-Id: I5187a88232297a9bd57fec9025b4bd80d7371aea
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-02-05 20:24:32 -05:00
Anas Nashif 7734572842 doc: galileo: update with latest features
Change-Id: I856c442d8bf1e05909b23912969edf2391c204c3
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:32 -05:00
Javier B Perez Hernandez 8dc16be5e4 doc: collab: coding style: update checkpatch pre-commit line
Update pre-commit checkpatch script to use project .checkpatch.conf
file.

Change-Id: I86ef9c64e9a13db2fd79fc5781eaa5456be78f36
Signed-off-by: Javier B Perez Hernandez <javier.b.perez.hernandez@linux.intel.com>
2016-02-05 20:24:32 -05:00
steveballard123 f183f4728b doc: edit the Galileo Platform documentation
Edited for grammar, style, markup, linkage, consistency.

Change-Id: I9aa11f6d3fbe20be7211735fdb14d708f977b872
Signed-off-by: Steve Ballard <stephen.r.ballard@intel.com>
2016-02-05 20:24:32 -05:00
Rodrigo Caballero b5cfa0db00 doc: Edit app development instructions.
The instructions were made more to the point and clearer.
Optional and necessary steps are now easier to identify.

Change-Id: I3f4dc16b1dc0a7e64ae888ed050d266fa1d59645
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:32 -05:00
Rodrigo Caballero 30e2a7dbd2 doc: Edit the Application Contribution section.
Based on Carol's original contribution. Edited based
on comments made to the original change.
Added better labels and links to other places in
the docs.

Change-Id: Iaff7d1849d7ab7c8276ac9fca87070442ce956fd
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:32 -05:00
Rodrigo Caballero 2f99a3183b doc: Edit the application development common procedures.
Corrected the :envvar: markup. Rewrote the text to be less patronizing.

Change-Id: I09ec541ae41ad682106dc73a6e4495216dfa34d3
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:32 -05:00
Rodrigo Caballero 08c09978d2 doc: Edit application code development document.
Also - fixed variable usage and ref links.
Also - fix trailing whitespace and missed deletion of Postrequisites section.

Change-Id: I72f857c8a82048922265db99669263050d1542ff
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:32 -05:00
Rodrigo Caballero c9d64fdd1f doc: Edit the object configuration section of the app development doc.
Removed prerequisites to fix the flow of the doc.

Change-Id: Ieed03a08c2794fe50d6be3b7d3496da5f4c4471c
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:32 -05:00
Rodrigo Caballero d3803bab2b doc: Add an improved application development section.
Introduces the first part Carol's original contribution. The original
contribution is broken up in multiple files. The updated toctree shows
the
files that will constitute the section. Edits for clarity,
redability and markup were also included. The old files were removed.

Change-Id: I29364c6bc94322c6235b51850c2d1b9f71eb1ad8
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:32 -05:00
Rodrigo Caballero a2144857c6 doc: Add and edit the kernel configuration section of the app development doc.
Removed the yous to be more concise and direct.
Second person phrasing can be overused making it redundant.

Change-Id: I849c0dce9a219962e724aade0cc4c5d57271cbe1
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:32 -05:00
L.S. Cook 8f613da882 doc: Added bold to lists and made some confusing wording more clear.
Another pass to improve readability and eliminate wordiness

Change-Id: I028483b6630de195e157159e8491abde60bb683c
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-02-05 20:24:32 -05:00
L.S. Cook f833735bd2 doc: Fix the Naming Conventions document markup.
Fixed the broken code blocks and rebased.
Content correction about architectures
Naming conventions fix broken line directive, comments, fix broken build
OK, really fixing the too-long line length this time...

Change-Id: Ib4aa60bed33ff40c5fbd6266670188c1c5e378c6
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-02-05 20:24:32 -05:00
Andrei Emeltchenko 82c958581e doc: Replace bt_init() with bt_enable()
bt_init() is now static function and API should use bt_enable().

Change-Id: I565f30bf816282961b71ceae2bbe90d5d93e7b8a
Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2016-02-05 20:24:32 -05:00
Andrei Emeltchenko 7c7a94ae4e doc: Correct Bluetooth sample lines
After license text was changed correct also code lines.

Change-Id: Idd3f34c38bb8ff9a40b6c02755f9716a98a6e86f
Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2016-02-05 20:24:30 -05:00
Rodrigo Caballero 207916c173 doc: Edit the communication section.
Performed edits based on Steve's comments. This new change fixes the
merge conflict of a previous version.

Change-Id: Ib99ed9a28da94c5780115ab0221edc9409e74919
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:30 -05:00
Rodrigo Caballero 7306a61264 doc: edit the Galileo Platform documentation
Edited for grammar, style, markup, linkage, consistency.
This change was resubmitted to avoid having a nickname as author.

Change-Id: Ie3a1a16c33939062ce2e139024afd2162a0c802d
Signed-off-by: Steve Ballard <stephen.r.ballard@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:30 -05:00