Commit Graph

33 Commits

Author SHA1 Message Date
Scott Rifenbark
7a4d6b011f documentation: Fixed bad target ID for the dev-manual.
This fix involved a few other manuals.

(From yocto-docs rev: d2659951a458a8db773e8c1b2b86a7b109d667fa)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
2c8cc82b3e sdk-manual, mega-manual: Updated the fig for installed ext. SDK
This figure had changed.  I updated the file and folder hierarchy.

Also fixed some wording.

(From yocto-docs rev: 359292397781f9f5eac2fb693d89ec286ddf9940)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
7bdb9a7bcc sdk-manual, mega-manual: Updated standard SDK install directory figure
The figure was incorrect for the installed file and folder hierarchy
for a standard SDK.  I updated it.  This figure goes in both the sdk-manual
and the mega-manual.

(From yocto-docs rev: a0dc11ce74bba0a18f385d9800f93524340ed033)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
5c6ce7e467 sdk-manual: Final edits to the extracting root filesystem section
Verified a good example and updated the text to match that example.

(From yocto-docs rev: 053467557ef22ce37762222a2997ff9c10be87e8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
f6bf56a17e sdk-manual: Added note in step to set SDKMACHINE
The value of SDKMACHINE must match the architecture of the machine
on which the SDK installer is being built if you are building an
installer for an extensible SDK.  I added a note to this effect.

(From yocto-docs rev: ffdd9a9d00cccf270b5aa236279e6eeea0ff47ed)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
c7d9010a07 sdk-manual: Updates to section on obtaining the SDK
Updated the example to more current information.

(From yocto-docs rev: 6952824473f820cbe6d02cba9523c023652f68e3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-07-07 10:59:38 +01:00
Scott Rifenbark
293183961e sdk-manual: Updates to "Building an SDK Installer" section.
Updated some links.  Also, rewrote the note about the libraries.
It was inaccurate.

(From yocto-docs rev: a0fce0ed36f3d0668e2d211433e7d93fb8833319)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
3658816dec sdk-manual: Updates to the section for locating SDK installers
I corrected some wrong information.  Provided the correct terminology
for the build host, and provided quotations for supplied values to
be in line with manual writing conventions.

(From yocto-docs rev: 420a7e96e7145dbef31d706cd257059619f71e12)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
ea1936fc02 dev-manual: Changed title to remove redundancy
The "Setting Up the Development Host to Use the Yocto Project" title
changed to "Preparing the Build Host".  Fixed links in a lot of
other manual.

(From yocto-docs rev: 00e487e01a0e2a16f5b8d786b3124cbe5115b38b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Scott Rifenbark
1b877bc9dd documentation: Updated everything for new overview-manual
This involved changing the root manual folder from
"getting-started" to "overview-manual".

Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was
changed to "YOCTO_DOCS_OM_URL".  Most manuals had several
occurrences of these links.

The makefile needed updating to process the new manual
and not process the old "getting-started" manual.

(From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:13 +01:00
Scott Rifenbark
20a5fecdb4 sdk-manual: Updated Eclipse trademarking usage
Made sure that each first occurrence in a chapter used the
"tm" mark.

(From yocto-docs rev: b7b21441b5fc009b8161902a10cfe1863d87b8a8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:09 +01:00
Scott Rifenbark
ae06e04cd2 documentation: Created new "Getting Started" manual.
Creation involved removing the overview-manual and replacing it
with the getting-started manual.  All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set.  I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".

The style sheet for the new manual needed updating to display the
new .PNG image for the title page.  The mega-manual file had to
be updated to include the files.  The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.

(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Scott Rifenbark
b797db0db4 documentation: Created new YP Overview Manual
Fixes [YOCTO #12370]

Added a new chapter to the newly created Yocto Project Overview
Manual.  This chapter originated from the YP Reference Manual and
was the old chapter 3, which talked a lot about various concepts.
This information is better suited for the new overview manual.

The change involved moving the entire chapter and renaming it.
This move of the content affected many, many external references
and links into the old area.  Consequently, I had to recast all
these links from the different manual.

Changes also included fixing the mega-manual.xml file so that it
would include the new overview manual as part of it.

Many figures had to be relocated as part of the move as well.  This
meant deleting them from the ref-manual/figures folder and putting
them into the overview-manual/figures folder.

(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
e7465c9175 sdk-manual: Fixed links to dev-manual for changed dev-manual title.
(From yocto-docs rev: 20fdeaf0a9003e694fb240f75c14e98148459b67)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
b103ff6ba7 documentation: Purged "oe-init-build-env-memres" from docs
Fixes [YOCTO #11968]

Purged all occurrences of the "oe-init-build-env-memres" script
from the YP documentation set.  Occurrences in a lot of places.
The BBSERVER variable was also impacted and had to have the
definition updated.

(From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
2c0c962dd9 sdk-manual: Updated steps to build an SDK installer
The steps needed updated to reflect the introduction of CROPS
as a way to prepare a build host.

(From yocto-docs rev: 8f52372afad4c32d0b895a88c2298625e7f53da3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
33969a3c92 sdk-manual: Converted extracting root filesystem to procedure
(From yocto-docs rev: 371b7c6c4d0d18c7212e0af3ca3ff558de347633)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-22 09:19:25 +01:00
Scott Rifenbark
5731def901 sdk-manual: Converted SDK build section to procedure
The section needed to be a step-by-step procedure.

(From yocto-docs rev: de4868c97c1199b39b3c3e68b4ff159f6546cd9e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-22 09:19:25 +01:00
Scott Rifenbark
8b04dca455 sdk-manual: Updated section to locate and install pre-built SDK
The section "Locating Pre-Built SDK Installers" was turned into
a procedure.  I also added some information on the actual names
of the *.sh files.

(From yocto-docs rev: 548886d5a392164783596c0c04779aaffd6ac930)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-22 09:19:25 +01:00
Scott Rifenbark
d17632463e sdk-manual: Updated the note for building SDK Installer
For development purposes, static libraries need to be
present only in the SDK. We do not need those static
libraries in the image for most scenarios. So, replace
IMAGE_INSTALL with TOOLCHAIN_TARGET_TASK in the documentation.

I updated the note to reflect this.

Suggested-by: Maxin B. John <maxin.john@intel.com>
(From yocto-docs rev: c05458c6614c38961d23db8f894d542bf93dbf09)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
959a062096 sdk-manual, dev-manual: Applied SDK review edits.
* Removed the note box formatting for the cross-reference
   from the sdk-manual and dev-manual sections that
   talk about devtool.  The reference is now non-note
   form and goes to the ref-manual devtool quick ref.

 * Added devtool upgrade as a third item in the list that
   introduces methods to use devtool.

 * Fixed the working on the devtool finish step 5 for both
   the dev-manual and sdk-manual.

 * Renamed the new chapter that describes different projects
   you can use devtool on.  The focus is on using the SDK
   toolchain directly.

 * Scrubbed the entire sdk-manual for the term "toolchain
   installer" and replaced with "SDK installer".

(From yocto-docs rev: 6d4daef49cc6d54a700a8c3965c9e8814f75d20a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
3a5397d306 sdk-manual: Removed "snapshot" in an example version string.
(From yocto-docs rev: 5ce7ad30cfc95b459a3da7b1cc540d1207d50dd8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:28 +01:00
Scott Rifenbark
4d1e6423ba sdk-manual: Added note to link to the wiki on building an SDK
(From yocto-docs rev: 29704fa495a97279c5d4e29bee22f0aaa9e15cba)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:28 +01:00
Scott Rifenbark
4bdd0cfffa sdk-manual: Added an example name for an extensible SDK
(From yocto-docs rev: bbc2ac36d19713242307b73393035d3fca6ed5a0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:28 +01:00
Scott Rifenbark
64293699f6 sdk-manual: Applied review edits throughout the manual.
Updates included minor items for wordings and clarity.  Review
comments from David Kinder, Stephen Ballard, and Paul Eggleton.

(From yocto-docs rev: b25e5cab60f9c1e059fadd844a3a75d9df450ebf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-29 07:48:22 +01:00
Scott Rifenbark
6db8cbcbad sdk-manual: Applied review edits to the manual.
(From yocto-docs rev: be853fb74b28bcf1b27b3b7a8e83012928d4e53a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:09 +00:00
Scott Rifenbark
7233e359dd sdk-manual: Edits to add extensible SDK configuration sections.
(From yocto-docs rev: 378bbceb8ea06c225c4758807e25a35521faa3a9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:09 +00:00
Scott Rifenbark
b31bf7c68b ref-manual, sdk-manual: Changed section heading.
Changed the heading for "Optionally Building a Toolchain
Installer" to "Building an SDK Installer".  This changes the
heading and many references to that heading.

(From yocto-docs rev: 97d8cd34d0dd0993b1b1135bb75f2212bb46878a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:09 +00:00
Scott Rifenbark
0bb6e48a33 sdk-manual: WIP on the book.
(From yocto-docs rev: 140577dd1f91c096152354e711709efe64bbcd0e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:07 +00:00
Scott Rifenbark
62477889fd sdk-manual: Applied some "red" text formatting to indicate notes
I am using "red" text to indicate sections of the manual that
are my development notes.

(From yocto-docs rev: 95b432d852ac3248874a2a958d4a80e59187f062)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:07 +00:00
Scott Rifenbark
d07100d5ff sdk-manual: Added new section detailing installed SDK directory.
Added text and a new figure to show the resulting directory
structure from running the SDK installation .sh script.

(From yocto-docs rev: 3c5aec4a0088262e60ee6becb5e34552feeb6151)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:07 +00:00
Scott Rifenbark
890f7215f0 sdk-manual: WIP - Various small edits as WIP
(From yocto-docs rev: 53c16de81028d5564a75b4787203d6862258f68e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:07 +00:00
Scott Rifenbark
0936eed201 sdk-manual: Added two appendix files to SDK Manual.
(From yocto-docs rev: ce926aeeb6e5594de53f606910a932b3a54ee5f0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:06 +00:00