Commit Graph

84 Commits

Author SHA1 Message Date
Scott Rifenbark 7707cf6562 sdk-manual: Fixed three broken links to sections within manual.
(From yocto-docs rev: 6c98ba1f0ac57e6ee9d2b77a4421e62bcb52a4c8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-05-17 21:35:00 +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 1ae33ba916 sdk-manual: Updated the normal customization.xml file.
Needs to used the downloadable XSL files and not the static
local 1.76.1 versions.

(From yocto-docs rev: 1dfc6081ffb745e424ff5f73c708e2559466831e)

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 b98a834818 sdk-manual: Updated eclipse customization file.
This file was still using the 1.76.1 XSL style sheets.  They need
to use the downloadable ones.

(From yocto-docs rev: 27e29bedb2d1c080a23298fc0ae23054c40971aa)

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 133224fb31 documentation: Fixed references using the DISTRO_NAME variable
With the introduction of a DISTRO_NAME_NO_CAP variable, the occurrences
of the DISTRO_NAME variable had to be checked to see if they really
should be using the "NO_CAP" variable instead.  Output and actual
branch names are case-sensitive.

(From yocto-docs rev: 711a3255538298dd3c4bd2af8ad13bc2d159c872)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:59 +01:00
Scott Rifenbark 3831ca0dee documentation: Updated release date in manual history tables.
Updated to "April 2016" for all manuals that use this table.

(From yocto-docs rev: 4d3753cc92c446668b0c383736c2071e24e53dd2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:59 +01:00
Scott Rifenbark b590fab4a1 dev-manual, ref-manual, sdk-manual: Removing oprofile references.
Fixes [YOCTO #9264]

I handled the occurrences of "oprofile" and "tools-profile" throughout
as I could.  They are not all done yet.  These in this commit have
been removed.

(From yocto-docs rev: d76e264ea210846ad8080134bacd56462ba69d24)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:59 +01:00
Scott Rifenbark 53729bca34 sdk-manual: Removed three sections of writer notes.
(From yocto-docs rev: f8aad4a55a38d4fe19dc8a83787e933c3fe15255)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:57 +01:00
Scott Rifenbark 9f0c571cd4 sdk-manual: Applied review edits.
(From yocto-docs rev: a00f0e593965063edc97672cdd70869d5d7ce179)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:57 +01:00
Scott Rifenbark d4bdafa8df sdk-manual: Added sections in Appendix B.
(From yocto-docs rev: 955f08c8d49fabd6022570e4d0a7442f06f6049b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:57 +01:00
Scott Rifenbark 2df514bfe4 sdk-manual: Added note for running remote apps with SSH port forw enabled.
I added the following note in the section that deals with running
Eclipse with a remote application.

Fixes [YOCTO #9276]

Currently, Eclipse does not support SSH port forwarding.
Consequently, if you need to run or debug a remote
application using the host display, you must create a
tunneling connection from outside Eclipse and keep
that connection alive during your work.
For example, in a new terminal, run the following:

     ssh -XY user_name@remote_host_ip

After running the command, add the command to be executed
in Eclipse's run configuration before the application
as follows:

     export DISPLAY=:10.0

(From yocto-docs rev: 7bf2875ff1653a8e50fa8e2bba540b2eb2512d2d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:10 +00:00
Scott Rifenbark 64241e0dfb sdk-manual: Applied more review edits to the manual per Eggleton.
(From yocto-docs rev: 8987852ad23e8a4694be55425e2c76bcd4301850)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:10 +00:00
Scott Rifenbark 54050ffceb sdk-manual: Applied 2nd round of review edits.
(From yocto-docs rev: 046b8ed69e0c6403f455e2ec8a0ccc30aea894de)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:10 +00: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 922eaeb963 sdk-manual: Updated the SDK devtool modify flow diagram.
(From yocto-docs rev: 0fa48508dc6da53f4611d41fee9aa946de6cf07b)

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 815d68684e sdk-manual: Added some intro stuff about the SDK
(From yocto-docs rev: 6b829c70349f42d902395a586c84fa21b53227e8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:08 +00:00
Scott Rifenbark 4c5157f7dc ref-manual: Resolving a conflict
(From yocto-docs rev: b364516928d04da38ef3188f07f190ffac64762b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:08 +00:00
Scott Rifenbark 4306f7f97a sdk-manual, mega-manual: Added new figure for Eclipse flow.
(From yocto-docs rev: 27150d4ed7dded90d726d91d92e4f905d365c3ba)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:08 +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 5a647013e5 sdk-manual, mega-manual, Makefile: Added new figures
Added a devtool add and devtool modify flow digram.  Updated
the Makefile to support those figures in the tarball creation.

(From yocto-docs rev: b40692065262dee0209329886b6e3a743c32b1bd)

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 af40e9a315 sdk-manual: Added a new figure for installed extensible sdk directory.
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 fc43555f72 sdk-manual: Added a red-text "role" to the style sheet.
This allows you to use the following to make a paragraph display
using red-colored text:

  <para role='writernotes'>Here is the sentence.</para>

What this allows is to create areas in the manual that are
easily identified as questions to the reviewers.

(From yocto-docs rev: 007ea508a36f453c66970666490a82885a8749e1)

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 b750729ddf sdk-manual-customization: Fixed XSL Appendix numbering parameter
The xslproc needs special handling of the statement that applies
the numbering for appendices.  I updated the line to use that
format so when making the file you do not get a billion
unrecognized parameter errors.

(From yocto-docs rev: a2787b7a6d045196c0d524e11531ca3aca41b9c2)

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 ad7a994cbb Makefile: Updated the figure list for the mega-manual.
Including three figs for Toaster manual.

(From yocto-docs rev: c41f9859b6cfc4e34b8e0d0e812fad0b8dd44540)

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 f15f96c07e sdk-manual: New content for outline purposes.
(From yocto-docs rev: bbea46ebb922de6e102e711bb6e63ed8479a6893)

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
Scott Rifenbark 4643b0408f sdk-manual: Updated with two new appendices for new files.
(From yocto-docs rev: 569f5853fa04d14d73a1e30dadceae62782e4127)

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
Scott Rifenbark d05566bd56 sdk-manual: Added sdk-environment.png diagram.
(From yocto-docs rev: 0f1c4a4714af348483d71e39a31877cb37722fae)

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
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
Scott Rifenbark 8bdc7071ee sdk-manual: Initial Manual framework
Makefile - Added support for new sdk-manual.
mega-manual - Added the sdk-title.png file to the list of figures.
              Modified to support inclusion of the new sdk-manual
              into the mega-manual.
poky.ent - Added a new string to support the new sdk-manual.
sdk-manual - Created new sdk-title.png image.
             Created new sdk-manual.xml file.
             Created sdk-manual customization layers for both
             standard build and Eclipse build.
             Note that we are pointing to local XSL templates for
             and these will change going forward.
             Created new sdk-style.css file.
             Created three chapter files that are placeholders
             at this point.

(From yocto-docs rev: ab591831a97a97d405d13ed75e9fb01e0452c292)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:45 +00:00