Commit Graph

43 Commits

Author SHA1 Message Date
Scott Rifenbark
73cc31c11a documentation: Updated title page notes
Updated the notes to help the user be sure they have the
right set of documents for the matching YP release.

(From yocto-docs rev: 8e112affb406731ac98f3c2e08542c5049232ff1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-10 20:43:10 +00:00
Scott Rifenbark
628aea354d documentation: Updated all manual revision tables to June, 2017
The release was pushed from May to June for 2.1.3 (krogoth). Updated
all manual revision tables.

(From yocto-docs rev: 5ec75c194147fecf0bda8095e430cdd8e6f34b6b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:50 +01:00
Scott Rifenbark
8f4b7758b5 documentation: Updated YP set for 2.1.3 Krogoth release in May '17
1. Updated poky.ent to contain 2.1.3 variables
2. Updated mega-manual.sed to use "2.1.3" string
3. Updated all Manual Revision tables to use "May 2017" date

(From yocto-docs rev: 49e08a543347d7e6548f6873faf701a0e5e95ae8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-18 13:12:30 +01:00
Scott Rifenbark
0742e8a43b documentation: Updated manual rev tables for Dec 2016 2.1.2 release
(From yocto-docs rev: 922482b4b9bc9a28858ac2760df027d3828f2d5a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16 10:38:23 +00:00
Scott Rifenbark
260ff60f93 documentation: Changes to support a 2.1.2 krogoth release.
Updated the poky.ent file to have the 2.1.2 variables.

Updated the manual revision tables to use 2.1.2 and October (a guess)

Updated the mega-manual.sed file so mega-manual links would resolve

(From yocto-docs rev: edf0777e7aa1fc2b41691791284c29d75dc94357)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:25 +01:00
Scott Rifenbark
12eb72ee3b documentation: Updated manual revision list tables for August
The date for the 2.1.1 release has pushed into August now.
Updated all the manual's release dates in the revision history
tables as needed.

(From yocto-docs rev: ccd7930ca3fdeec87003c2d3861ebd491c7c6d18)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-19 08:42:19 +01:00
Scott Rifenbark
4c36d5209e documentation: Updated manual revision tables for July 2016 date
YP release 2.1.1 moved from the June timeframe to July.  Updated
the manual revision tables.

(From yocto-docs rev: 09f228e7228146685af56dc341ca8fbd81e63282)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-19 08:42:19 +01:00
Scott Rifenbark
9891a867ef sdk-manual: Fixed three broken links to sections within manual.
(From yocto-docs rev: 25eb664cf20c08014f2ad6cf61ffe07b76fb23df)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-19 08:42:17 +01:00
Scott Rifenbark
e1f49c6068 sdk-manual: Updated configure.ac file in helloworld example.
The file was named 'configure.in' and was slightly different than
what it needed to be in order to work.  The file needs to be named
'configure.ac' and have slightly different contents.  Fixed both.

(From yocto-docs rev: ea2aa991e8072ac8d371afdcbb72daf34065d5fb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-19 08:42:17 +01:00
Scott Rifenbark
046fd3cb83 documentation: Set up for the 2.1.1 YP Release
* poky.ent variables updated.
* Manual revision tables entries added "June 2016" date
* mega-manual.sed string "2.1" globally changed to "2.1.1"

(From yocto-docs rev: 59ffde8e39df96cbc41dc294e8623b94b217a0a4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-19 08:42:16 +01:00
Scott Rifenbark
c914668db2 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:50:00 +01:00
Scott Rifenbark
5448ecf1a2 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:50:00 +01:00
Scott Rifenbark
9f96ef9d98 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:50:00 +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