Commit Graph

13 Commits

Author SHA1 Message Date
Anas Nashif 8ba05cc2ad update documentation to use boards where applicable
Change the terminology in the documentation and use board instead
of platform where applicable.

Change-Id: I812598e1948ee7df8739e5cc9029278e9e849c7f
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:25:11 -05:00
Anas Nashif c740608ce5 Use BOARD instead of PLATFORM_CONFIG
Change-Id: I14db0087cd705df0db8a911071bc3949b5c79314
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:25:11 -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 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 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
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 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
Peter Mitsis 859a4c8240 platform doc: Fix galileo content issues
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>
2016-02-05 20:15:33 -05:00
Peter Mitsis 648ca009ff platform doc: Standardize on note section formatting
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>
2016-02-05 20:15:33 -05:00
Peter Mitsis 17c83fe62e platform doc: Fix up minor issues in tables
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>
2016-02-05 20:15:33 -05:00
Peter Mitsis 73b066fc76 platform doc: Automate table of contents
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>
2016-02-05 20:15:33 -05:00
Peter Mitsis 7752ddff16 platform doc: Clean up section names
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>
2016-02-05 20:15:33 -05:00
Peter Mitsis d50f786145 doc: Rename quark platform configuration to galileo
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>
2016-02-05 20:15:33 -05:00