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>
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>
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>
Corrected minor grammar issues related to platform config description
Change-Id: I6960366ae088957dbff588adabc01adb15385066
Signed-off-by: Gerardo A. Aceves <gerardo.aceves@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>
Fixes minor content issues with the galileo documentation such as ...
1. Avoid use of "Zephyr projects"
2. Fix typos
Change-Id: Ie3e49cbebfe3cee819b85b005bb44916d6d96129
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Fixes minor content issues with the fsl_frdm_k64f documentation such as ...
1. Avoid use of "Zephyr projects"
2. Fix referenced variable and file names
3. Fix default value of NUM_IRQS Kconfig option
4. Fix typos
Change-Id: Id5f2d219fab7ba184f0b1ae1c0d28894e69faacc
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Fixes multiple instances of the following build error:
ERROR: Error in "code-block" directive:
maximum 1 argument(s) allowed, 3 supplied.
The revised text avoids the use of code-blocks, and improves readability
by highlighting the supported combinations of configuration options.
Change-Id: I6f495bcc2e6bada096e5d117e9f886d4a9fb6269
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Adds a preceding backslash to the '*' character in C-like comments to ensure
that they are not interpreted as belonging to part of an emphasis block.
Change-Id: Iac9da1fc68ace0b9829e1b687c163baa81040718
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Standardizes on the text formatting following a ".. note::" label.
1. No blank line after the label.
2. Uses an indentation of 3 spaces.
Change-Id: I9b28a88fef237fe5a8bb6eb2d6fb746f745598fd
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Fixes multiple instances of the following build warning by updating the
platform documentation to no longer use a unicode equivalent to the ' character.
WARNING: undecodable source characters, replacing with "?"
Change-Id: I226176cc4699be79692a3591c7b53772df6d1bef
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Fixes up the following minor issues in the various tables in the fsl_frdm_k64f
and galileo documentation.
1. Ensures that there is a space between the column '|' and text.
2. Eliminates inconsistent italicizing of table text.
3. Order of the "Interface" table matches "Supported Features"
4. Ensures that items are correctly identified.
Fix tables in fsl_frdm_64kf platform documentation
Change-Id: I5d9127bdde2f2af285d4344a8def3a81a11deb76
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Sections now make consistent use of the ####, ****, ====, and ----
headings so that the table of contents can be automatically generated
instead of relying upon a manually created table of contents.
Section names have been modified as necessary.
Change-Id: I57c2bb133de7ded07bb1e30d37c6a2850ccfb9c5
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Fixes up section names and the table of contents so that they align with
each other. This necessitates a little reworking of content and relocation
of sections.
Change-Id: Ib9766f2090cf949eaf9a0d7686d496301b88a407
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Updates the documentation as the quark platform configuration had been
previously renamed to 'galileo'.
Change-Id: I31e1920f30f57b243b07215fe92be08b5e5c9d59
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
Except for the table, lines are now 80 characters or less.
Change-Id: I023f68b358806970899dd70a6cd49a0bee403dfa
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
irq_handler_set, irq_priority_set and irq_disconnect have been made
private by prepending an underscore to their names:
irq_handler_set -> irq_handler_set
irq_priority_set -> irq_priority_set
irq_disconnect -> irq_disconnect
The prototypes have been removed from header files when possible, and
extern statements used in C code where they were called.
_irq_priority_set() for ARM is still in the header file because
IRQ_CONFIG() relies on it.
Change-Id: I2ad585f8156ff80250f6d9eeca4a249a4477fd9d
Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
The content of the files was left unchanged except for labels for
cros-referncing, the main title of the part and the tabs on the tables
which were changed to spaces. That last change ensures the integrity of
the tables independently of editor. The structure of the content files
will be revised at a later time.
Change-Id: I90477966fb3f4727d61e859d77682b529c83337d
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>
Anas Nashif