Commit Graph

263 Commits

Author SHA1 Message Date
L.S. Cook d229efe476 doc: cleaning up tone to be a little more polite to potential feedback givers
Gerrit review improvements

Signed-off-by: Leona Cook <leonax.cook@intel.com>
Change-Id: I39d00195c47ac015246068b308ef69e0ecb2d024
2016-02-05 20:24:28 -05:00
Allan Stephens 843f8a6224 doc: Add documentation for sys_thread_busy_wait()
Change-Id: I71f405448f141ae02c28889afd3fc03ddef55ecd
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-02-05 20:24:28 -05:00
L.S. Cook 86f851c55a doc: adding :dfn: syntax where needed
Updated as per Allan's comments to correct use of Zephyr
kernel in lieu of codename variable

Change-Id: Iaf5f8531c5452b6d8fb13318f00050aa63d99200
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-02-05 20:24:27 -05:00
L.S. Cook cb9749f443 doc: directive indentation fixes on language.rst
Editing language.rst file to clarify a few items
Also correcting a few things I missed earlier
Also fix title case without hyphen to be consistent

Change-Id: I463d1cdb436957a14af6ea40933f892a51b161aa
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-02-05 20:24:27 -05:00
L.S. Cook 1f901bd491 doc: change bash to console refs
Also: fixed trailing whitespaces.
Also: integrated comment change suggestions from GA

Change-Id: I41f7052d9895e0c61ad0e76be989ea6161f9ed83
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2016-02-05 20:24:26 -05:00
Leona c98560f783 doc: edit of gerrit tutorial
Change-Id: I3f5831d5e41968c5ce43cc1042565f7677025caa
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
Signed-off-by: Leona <lsc@hackeress.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:26 -05:00
Anas Nashif 6acf354d7f doc: use zephyr for SDK, not yocto
Change-Id: I51ebdaeb3408ea270a0b3d15f86ebe1f14b8f2f2
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:23 -05:00
Anas Nashif 5d563192c7 doc: set copyright on every page
Move license to bottom of first page.

Change-Id: Ib7ee2fc0485d4f386fcf3f2d6d209f4da4ffaf77
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:23 -05:00
Anas Nashif eb53f38f87 doc: move kbuild files into a sub-directory
Change-Id: Iaa18369a32c20cef7bab2327689ab744f28cadcc

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:23 -05:00
Anas Nashif 43667180da doc: update compiler version
Change-Id: I8944a107910079f6a1479b7498b8969a5330f1a4

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:23 -05:00
Anas Nashif cc3c284b4b doc: qsg: update with latest changes
Change-Id: Icce7f0249faf871b758257d86ef220b3d0ce8d52
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:23 -05:00
Anas Nashif 0fb169ee17 doc: realign kbuild documentation
Change-Id: I0599d45e662196e62c068da321f8fcd1f0512615
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:23 -05:00
Anas Nashif f1c948d064 doxygen: remove obsolete config options
Change-Id: I415be92785e2c56914e57be4d3225159a3f0ea8c
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:23 -05:00
Anas Nashif 1dc809b23b kconfig: use zephyr as the binary name globally
do not use microkernel or nanokernel as the output binaries,
instead, use zephyr globally.

Also change the documentation to reflect this.

Change-Id: I8405761d1a0392c90cdfeec5c67d72eb4e5a76ff
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:22 -05:00
Rodrigo Caballero 7c995f33b3 doc: Edit the Kconfig Reference Guides.
Edit text for grammar, style, markup, linkage, consistency and clarity.

Change-Id: I785179f867435f9d212718e10acc9e9c8f0f1e8a
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:22 -05:00
Gerardo A. Aceves 30a04a2250 doc: Edit redundant use of file
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>
2016-02-05 20:24:22 -05:00
Gerardo A. Aceves 575c1ba172 Change minor markup errors.
Corrected formatting to produce cleaner HTML output.

Change-Id: I7f2f655498829ed7fd8c468e1d6d7d04d595f181
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
2016-02-05 20:24:21 -05:00
steveballard123 981f4ab169 doc: Edited the Doxygen documentation
Edit for grammar, consistency, accuracy

Change-Id: I72eb48b546ab15097289469c25dc0c298bae46cb
Signed-off-by: steveballard123 <stephen.r.ballard@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:21 -05:00
Gerardo A. Aceves 2fe611587d Doc: grammar fixes on platform.rst file
Corrected minor grammar issues related to platform config description

Change-Id: I6960366ae088957dbff588adabc01adb15385066
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
2016-02-05 20:24:21 -05:00
steveballard123 15faebe139 DOC: edit the encryption documentation.
Edit for grammar, consistency, accuracy.

Change-Id: Iab9d315f350416ba1d863c5554305fd1f7a073a7
Signed-off-by: steveballard123 <stephen.r.ballard@intel.com>
2016-02-05 20:24:21 -05:00
Gerardo A. Aceves b47ec60080 doc: add the grouping documentation
Adds the correct use of Doxygen grouping
for in-code documentation.

Change-Id: I25d2e9259e27808da8a032f91dfeff4711bc1f4b
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
2016-02-05 20:24:21 -05:00
Rodrigo Caballero dd47daaaae doc: Edit the Makefiles reference documentation.
Edit for grammar, style, spelling, readability, clarity, linkage and
markup.

Change-Id: Idc8e5f83141639035b08c5664dd3d39567a993e6
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:20 -05:00
Dirk Brandewie f37a4fcd71 kernel: kconfig: remove dependencies on EXPERIMENTAL
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>
2016-02-05 20:24:20 -05:00
Rodrigo Caballero 31c12f811b doc: Fix the use of substitutions.
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>
2016-02-05 20:24:20 -05:00
Javier B Perez Hernandez e200eec7a3 doc: quick start: installing: New Zephyr SDK 0.6
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>
2016-02-05 20:24:19 -05:00
Gerardo A. Aceves a049bf3de8 Change minor punctuation characters.
Corrected some punctuation characters to improve readability.

Change-Id: I44930a8a314f9fa5f3da216df3c7d2262c9cb1ef
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@intel.com>
2016-02-05 20:24:19 -05:00
Anas Nashif 67dbf7531a doc: fixed type sempahores -> semaphores
Change-Id: Iec1748ddcc15f2f42cf195ebd7ad0b9594e4224c
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:17 -05:00
steveballard123 b4c75df9dc doc: Edits to the supported platform documents.
Edit grammar, punctuation, consistency, linkage, and accuracy.

Change-Id: I46b2b0cdf18b89f5c669c398360decd6a4c68217
Signed-off-by: steveballard123 <stephen.r.ballard@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:15:59 -05:00
Andrei Emeltchenko a1b25ec1e1 doc: Format Galileo running code block correctly
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>
2016-02-05 20:15:58 -05:00
Andrei Emeltchenko 8b757e860d doc: Remove unneeded steps in Galileo running
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>
2016-02-05 20:15:58 -05:00
Andrei Emeltchenko e805c2bd52 doc: Fix splitting long line
When line is split the html output does not format list correctly.

Change-Id: I942529d134ec6afc65ae11400a2702d5d7051cbd
Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2016-02-05 20:15:58 -05:00
Andrei Emeltchenko cea7764f14 doc: Make Galileo instructions more readable
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>
2016-02-05 20:15:58 -05:00
Andrei Emeltchenko 62777786d8 doc: Fix bug splitting long line and breaking list
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>
2016-02-05 20:15:58 -05:00
Anas Nashif bcbea5dbc7 doc: remove doxygen index and add groups instead
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>
2016-02-05 20:15:58 -05:00
Anas Nashif 1f99be5d1b doxygen: define variables for pre-processing
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>
2016-02-05 20:15:58 -05:00
Andrew Boie fb036433a1 doc: fix GRUB build instructions
Change-Id: Ia67ceb8438a1675dd8dae503e84367e5ee294d2f
Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2016-02-05 20:15:58 -05:00
Gerardo A. Aceves 19ea0268ff Doc: Add gerrit recommended practices to the appropriate
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>
2016-02-05 20:15:41 -05:00
Constanza Heath 7d0e1d9218 Add initial import of TinyCrypt crypto library and tests
Change-Id: I89b8db6925385dd02e95e0401bc42f32543e0daf
Signed-off-by: Constanza Heath <constanza.m.heath@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:15:36 -05:00
Gerardo A. Aceves 60260536ac Add Recommended Practices Documentation.
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>
2016-02-05 20:15:36 -05:00
steveballard123 ab315b3046 doc: edited grammar, punctuation, spelling, word usage.
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
2016-02-05 20:15:36 -05:00
steveballard123 670da4331b doc: updating quickstart for style consistency
Rewrote and edited for clarity, punctuation, grammar, word usage.

Signed-off-by: Steve Ballard <stephen.r.ballard@intel.com>
Change-Id: I0332be9152312047a39067e7d610a563352abb1b
2016-02-05 20:15:36 -05:00
Allan Stephens dfa734d57e doc: Enhance information about microkernel pipes
Revises and supplements information on concepts.

Change-Id: I7dd9dd2e99cd5d975cc0f617b076dcf13c414fd0
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-02-05 20:15:35 -05:00
Anas Nashif 8a931c4828 Remove index.rst for kconfig, it is auto-generated
also add a readme saying files here are auto-generated.

Change-Id: Id33056192d8020c6cddcd12f406d15384db374ac
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:15:35 -05:00
Allan Stephens 945ed24597 doc: Clarify requirements for referencing microkernel objects
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>
2016-02-05 20:15:35 -05:00
Anas Nashif dada389eb1 generate kconfig variables automatically
Change-Id: Iba70557100f49209edb6874251f93f79c2358737
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:15:35 -05:00
Anas Nashif dafe23edd9 Remove static configuration option reference
Change-Id: Iea95deb8cfbbc1bf2125f22b3a4eab81224b2115
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:15:35 -05:00
Peter Mitsis 64a9720a7b doc: Update arm platform configuration names
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>
2016-02-05 20:15:35 -05:00
Peter Mitsis 902dd32348 doc: Remove obsolete references to "generic pc"
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>
2016-02-05 20:15:35 -05:00
Peter Mitsis 5089655d57 Add PRIORITY_CEILING note to mutex document
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>
2016-02-05 20:15:34 -05:00
Peter Mitsis 7f7020b2cf Update priority inheritance in mutex document
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>
2016-02-05 20:15:34 -05:00