Updates the application build steps needed to rebuild your system.
Adds team recommendations on the current friendly manner to build
an application.
Change-Id: I7aff1788dc15c7159a319c926f14bc621924ce67
Signed-off-by: Juan Manuel Cruz <juan.m.cruz.alcaraz@intel.com>
JIRA: ZEP-180
This line was missed when the task IRQ APIs were deprecated
by commit a83f895dd5.
Change-Id: I0135eebb2f7bd0991364fdaab8a0a1fd6981d50d
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Incorporates the brief discussion of device driver support into
the Device Drivers document, so that the driver material is all
in one place. (Also converts a few unprintable characters in the
latter document to spaces, since they appear to have been used
by accident.)
Removes the empty discussion of networking support, to avoid
duplicating stuff already covered in the Networking document.
Change-Id: Ia5b8a92ade72a0634ee142afb45928016442d7dd
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
No longer necessary since the host tools compile natively now.
Change-Id: Ibe6f66fa79498678bddc25f69f799555d181ea7f
Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
Relocates material that outlines the structure of a Zephyr application
so that it appears at the beginning of the "Application Development
Primer". (i.e. The primer now tells the reader the file structure of
an application, then explains how to create these files.)
Revises the description of the MDEF file to make it a bulleted item
(like the other file types are) and improve readability.
Change-Id: I9f003b8317257c927bea752da55cc434f957592c
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Relocates material that describes the most fundamental terms used
in Zephyr documentation so that it appears in the "Introducing Zephyr"
document. (i.e. Ensures that the terms are defined before they are
used in the "Getting Started Guide" that follows.)
Transforms the material into a definition list to make it easier
for readers to locate and understand the mateial. Revises the text
to give it a consistent look-and-feel.
Change-Id: I0187d99b1bdac37397a4c907d57bc1f24d7698e7
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Relocates the introductory material for Zephyr into a new document,
so that it can be more easily located by users. (Previously this
info couldn't be accessed from the list of documents on the left hand
side of a web page; instead, you had to click on the "Documentation"
tab at the top of the page, which is non-intuitive.)
Change-Id: I1e1f78162a314b958789fcef57fc864336007f3c
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Moved the DesignWare ARC EM Starter Kit information from
em_starterkit.rst to the Zephyr wiki.
Change-Id: I2d5343d7bf03c69f5c8365e955dbb86980b4c5d1
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
Moved board content from arduino_due.rst to the Arduino
Due Zephyr wiki article.
Change-Id: I438d674b43836beb45a0690d86327b9526c9eddf
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
Groups top-level documents so that related documents are adjacent.
Also re-orders things so that documents for newcomers appear before
documents on more advanced topics.
The rationale behind the resulting order is described below:
Getting Started Guide
- Enables a newcomer to access & try out Zephyr by running a sample
application using QEMU.
Supported Boards
- Enables a newcomer to try out Zephyr by running a sample application
using actual hardware.
- Also lets newcomers know which boards are currently supported.
Zephyr Kernel Primer
Device Drivers and Device Model
Subsystems
- Describes the various components of the Zephyr kernel.
- Lets a developer know what is available when they are *designing* code.
API Documentation
- Describes the various APIs of the Zephyr kernel.
- Lets a developer know what is available when they are *writing* code.
Application Development Primer
- Provides the info needed for a developer to create a new application
using Zephyr.
Contributing Code
- Tells a developer how to contribute code back to the Zephyr project.
- Advanced topic.
Porting Guides
- Provides guidelines for porting Zephyr to a new architecture.
- Advanced topic.
Build System User Guide
- Covers writing Kconfig options, and also contains reference guide.
- Advanced topic.
Change-Id: I8ecb4953c788e843028d1e8778be1ef1aee6c175
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Moved the QEMU x86 information from qemu_x86.rst
to the Zephyr wiki. Also corrected a typo in
qemu_cortex_m3.rst.
Change-Id: Ic7ac8a1ab59018f25466c9031ce465973d6bdd8f
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
Moved the QEMU_Cortex_M3 information from qemu_cortex_m3.rst
to the Zephyr wiki.
Change-Id: I4899c562844f8fc90096aea45b14a80f40791239
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
Moved the OLIMEXINO-STM32 information from the
olimexino_stm32.rst file to the Zephyr wiki.
Change-Id: I97aa1b400bd65bbe53bb58e635a789cb325c3795
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
Moved the nRF52-PCA10040 information from nrf52_pca10040.rst
to the Zephyr wiki.
Change-Id: I0069b9e720a39b515c8ca612343e3f3410f4a77a
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
Moved the Minnnowboard Max information from minnowboard.rst
to the Zephyr wiki.
Change-Id: I97c2090e3a76e2ab6a9ab1e5f338fb4c3ffb0715
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
Moved the Galileo Gen1 and Gen1 info from galileo.rst
to the Zephyr wiki.
Change-Id: I2210ab98429efb55be5ef3e47096842dfdbce16e
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
Signed-off-by: viggo.jf.intel.com <evanx.couzens@intel.com>
Moved the FRDM-K64F information from frdm_k64f.rst
to the Zephyr wiki.
Change-Id: Ibf5431d21bb82af1b9eebc7b693b88d774247369
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
Moved the arduino_101_ble.rst content to Zephyr wiki:
https://wiki.zephyrproject.org/view/Arduino_101#Blue
tooth_firmware_for_the_Arduino_101
Change-Id: I361f124967da277aba835f39294a36718cf990a8
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
The doc build needs not the HTML or Latex documentation generated by
doxygen, as sphinx takes only the XML. Disable them to use less space
and speed up the build.
Change-Id: I51974449262fc5b45c6c2b41aad54365cceac341
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
A workaround used to silence a warning in the doc generation process
which involved tagging a structure with a #define can now be solved
with a cleaner approach which is non-code-invasive.
Backup said change and update documentation on what to do when the
issue is found.
Change-Id: I1ef5224cd1b2df2e57c2ace438dba90ba3fc8528
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Fix the omission of having bullets for the enumeration of options, as
it makes the formatting look properly vs just different lines.
Change-Id: I701f705bc03ccc2082439c3ea3c1b5053b2aac0a
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Change-Id: I955bad3c560d8e0026d671dadf6004edb94559e4
Signed-off-by: Adrian Bradianu <adrian.bradianu@windriver.com>
Signed-off-by: Jesus Sanchez-Palencia <jesus.sanchez-palencia@intel.com>
Signed-off-by: Jithu Joseph <jithu.joseph@intel.com>
Moved the Quark D2000 CRB information from
quark_d2000_crb.rst to the Zephyr wiki.
Change-Id: I62b6970633570c6af2d8d946d5621b032ff10467
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
In preparation for more strict guidelines on documentation, provide a
trouble shooting guide with the most common and obscure issues found.
The CI system will point to this guide to help committers upon doc
failures.
Change-Id: I386baea75dad0c82b58b23926e0bd32de8a0b249
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Moved content from arduino_101.rst to Zephyr wiki article
Change-Id: I10d42e28f375bcb5c5c7266e7595b6dd7767ac8b
Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
Fix with a workaround in unnamed unions / structs in bluetooth, i2c,
sensor and uart.
Current documentation parsers (sphinx under Doxygen) don't seem to
understand well unnamed structs / unions. They will not generate any
documentation for any documented members (see left side of
http://imgur.com/mcpBXWc).
A workaround is to make the parser think there is something like a
struct/union/enum name that is actually something with no effect to
the compiler.
Naming it with __unnamed_workaround__ ensures it is clear it is a
workaround while we wait for a final fix. It is #defined to be a NO-OP
to the compiler and rearrange the member documentation as *@param* so
we have some documentation that the non-worked around code fails to
document.
Anonymous structs/union that declare a variable are just given an
internal name.
Workarounds documented in the contribution guidelines.
Change-Id: I4d32cf444f3c5e7d2fb11581e4b41f80e93c9786
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
update index.rst to include 1.4.0 doc folder
Change-Id: I57b7ea470e4a5d2f8e93459f90421a87abf331ce
Signed-off-by: David Kinder <david.b.kinder@intel.com>
Add a document.title='xxx' via on-page javascript for the
.rst files generated by the genrest.py script
Jira: ZEP-459
Change-Id: I2b3dbb97758cfa232006a0cd98c4bd8394d8183e
Signed-off-by: David Kinder <david.b.kinder@intel.com>
Some function *typedefs* confuse the *Sphynx* / *breathe* parser [see
the patch for full details]. Implement a workaround (defining the name
with @typedef), add workaround documentation and file a bug with the
sphinx/breathe developers.
Change-Id: I7f3dba4a53d0cc73e12f02511a5f85526f357b5f
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Sphinx's parser gets all confused; add a workaround using @fn,
document the workaround in the contribution section; bug filed with
Sphinx for a permanent sollution.
Change-Id: I0200add092da27206b9d006bb13110c4cc37d0e4
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Kills warning:
error: Tag file `NO' does not exist or is not a file. Skipping it...
Change-Id: I1543b672f7f8eca406d2ab5493a1ad9a45ce7868
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This is needed so the parser can find the functions that are being
documented in high level files as part of ports.
Change-Id: I6b7fe1c2ef28d74741966a18e8008a893975c969
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Otherwise the trees hide the forest and it is really difficult to see
what issues are introduced.
Change-Id: I2272f2caff8b99a15a0b2540787845e4541a36d3
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Makes no sense to integrate the whole file for just a few lines, so
defaulted to remove the inclusion and just copy the lines that are
interesting.
Change-Id: I84a2218063ca7368678402b1123da34efae14f27
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Setting CONFIG_ARC_INIT=n in prj.conf make it possible to use same
config for both QEMU and Arduino 101 targets.
Change-Id: Ie4f549d5721f2b87077fba8787f5b1e2a8f07680
Signed-off-by: Szymon Janc <ext.szymon.janc@tieto.com>
These influence the existence of some struct members, so to ensure
that their documentation gets included we need to explicitly define
them.
Change-Id: I0b0d3deec5874f6f8dbfda51376f6a4456942353
Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Per:
commit a83f895
Author: Andrew Boie <andrew.p.boie@intel.com>
Commit: Benjamin Walsh <benjamin.walsh@windriver.com>
microkernel: deprecate task IRQs
This mechanism does not add enough value to the kernel to be worth
maintaining it. Drivers that need deferred processing of interrupts
can simply define their own task and have the interrupt handler
release an event that the task waits on.
The API is marked as deprecated and it is removed from unit test
coverage as well as the documentation.
Change-Id: Ib87b91cb41e9b6d7fdf0dc62b240a531b6a8889f
Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
Change-Id: I0d891772b1fb4246ec9ee9f4764b2121333ae972
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Original link "fiber services" does not exist, so renamed to the one
at the head of "nanokernel_fibers.rst".
Change-Id: I39c89e5dbe9b8d0462eb2aa8d84db65b22625fdc
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Not sure which was the original link, but naming_conventions seems
like the sensible place where the document should be pointing to.
Change-Id: I12f8317578b33371765605786735c30aadb92b77
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Must use :c:type instead of :cpp:type.
Change-Id: I600c7a018e1b1492e967b05f44fec14afd87eccc
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
:c:option:`xyz` is non usable without a . c:option:: declaration, so moved
to *xyz`; likewise :option:`xyz` where no .. option:: xyz is declared.
Change-Id: I011ccf2aac244125dbe2d09d197e443bd4c12fe2
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
