Commit Graph

67 Commits

Author SHA1 Message Date
Scott Rifenbark ed6a5495a1 documentation: devtool upgrade and quick ref changes to mult manuals
Did the following:

 * Added the devtool upgrade flow to the SDK manual.
 * Removed the devtool Quick Reference from the dev-manual and
   added it as a new chapter to the ref-manual.
 * Made sure all the links and cross-references work now with the
   moved material.
 * Updated the Make file so that the manual set builds correctly
   regarding the new chapter in the ref-manual.
 * Created cross-referencing notes in both the sdk-manual and the
   dev-manual to the newly located devtool Quick Reference chapter.

(From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc)

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 38278f0a21 sdk-manual: Added the devtool upgrade command flow to the manual.
I needed a new figure and a new section.

(From yocto-docs rev: d413ca7b9b946450af7c2c15ab0e68e9181517e9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:31 +01:00
Scott Rifenbark cea1d78f1f sdk-manual: Removed two Git tag developer notes.
These notes can't be in the final version of the manual.
Now is the time to get them out.

(From yocto-docs rev: 600b4f2c7360b30d12fdc7ed0f5ba41bc09fc778)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark 394b909174 sdk-manual: Removed notes about the BitBake Commander
Fixes [YOCTO #10032]

The fix to remove the BitBake Commander from the tools to install
when dealing with the Eclipse Yocto Plug-in has happened.
Consequently, I removed the developer notes in the manual stating
that the Commander was still showing up there.  The manual set
is now clean of this stuff.

(From yocto-docs rev: fbe169b086faac571de8a2ebd9d32682162cfd31)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark 0ac7b1e9df sdk-manual: Updated Passing host options example
Fixes [YOCTO #10267]

The example works better using OECORE_TARGET_SYSROOT for the
aclocal line.  I changed it to that.

(From yocto-docs rev: 362b786e7bf2083c5809e961f61c0ad81b778d71)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark 0c823cce36 sdk-manual: Updates to the devtool Finish command flow.
(From yocto-docs rev: f980b7cfa021c3777acd8e26b00cf40ed58f10f4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark aba386b92c sdk-manual: Updated SDK workflow
A new command devtool finish has superceded the final commands
in the SDK workflow.  I updated the two figures (add and modify)
to reflect this new flow.  I also updated the ordered number list
to match reality.

(From yocto-docs rev: 0ba31e730cd748d06eab8d46b38764cda5c4e3bd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark 6cecded9ef sdk-manual, ref-manual: New variable for including toolchain
Added a new variable description for SDK_INCLUDE_TOOLCHAIN.
Along with the new glossary entry, I updated a couple places
where it would be relevant to cross-reference the new variable.

(From yocto-docs rev: df99b097595e7488a93354082b8d9f33acd9c229)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark 7267910323 sdk-manual: Updated the connection steps for deployment
Provided clearer instruction on how to set up a new SSH
connection when deploying an application to QEMU.

(From yocto-docs rev: 93adc542a40e86377380684e1ce294edd0fd7268)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:33 +01:00
Scott Rifenbark 43b5d140c6 sdk-manual: Fixed spelling error.
(From yocto-docs rev: 46794f1c852a12375764d80c7242312921d8bd20)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:33 +01:00
Scott Rifenbark 72d1435f20 documentation: Added new description for the PACKAGECONFIG_CONFARGS variable.
Fixes [YOCTO #10183]

Added a new variable entry for the PACKAGECONFIG_CONFARGS variable.

With the introduction of the new PACKAGECONFIG_CONFARGS variable,
many places in the mainstream YP documentation that referenced
how to pass configure arguments using EXTRA_OECONF needed to also
make mention of this new variable.  I added many cross-references
to the new variable.

(From yocto-docs rev: 00f02d45319bab90b72eab89fcb69cbe8bd05bb5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:33 +01:00
Scott Rifenbark 0637314b84 sdk-manual: Updated neon JDK requirements to be 1.8+
(From yocto-docs rev: 796fad8a20ece3ef5fdb0c7c1d325a18e37e676b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:33 +01:00
Scott Rifenbark 4317c65d4e sdk-manual: Updated legacy mars links to go to neon section.
(From yocto-docs rev: 4c524f3763f676d4f60a8fb383019b6153901b9d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:33 +01:00
Scott Rifenbark 3277d8d307 sdk-manual: Updates to "Working With Eclips" for Neon
Fixes [YOCTO #7546]

Applied changes throughout this section to move it from Luna to
the Neon version (latest) of Eclipse.  We now provide a single
thread for Eclipse, which is based on the latest version (Neon).
Information for Mars, which is also supported) is in a new Appendix
C.

(From yocto-docs rev: 82995d9c49e4c55707591a1375c5d86874c589b0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:33 +01:00
Scott Rifenbark b9df28b9b2 sdk-manual: Added developer note for updating to Neon
(From yocto-docs rev: bd21fdd102d7daa3f03b978760d9190a3815e243)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:29 +01:00
Scott Rifenbark eb7781f633 sdk-manual: Updated boxes to check when installing pre-built mars yp plug-in
Removed the Bitbake commander item and renamed the ADT one to SDK.

(From yocto-docs rev: 7bb7823bd9991ce95315b76bdfb3175c53198401)

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 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 5393fd7b34 sdk-manual: Fixed a broken "do_install" task link
(From yocto-docs rev: bef1a51e0c0a5a0145e942c1cc3f868f1cfaa03c)

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 0d4510e733 sdk-manual: Fixed a broken link to the "base" class
(From yocto-docs rev: 22eba313276ea95030634eef8632e4e05cb1e484)

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 3c77e18c81 sdk-manual: "Linkified" the CC variable in section 3.3.4
(From yocto-docs rev: d020cfc08e5d0679d7d5d3fd4269be877413e863)

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 9359c104ad sdk-manual: Grammar fix.
(From yocto-docs rev: 709481dd0711abda063120f775b35b58c9a2af15)

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 e990bceca0 sdk-manual: Updated the extensible SDK installer example
(From yocto-docs rev: 3791f4abc21c565f7e258a550e66327dbbe7a384)

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 66ca0c4fef sdk-manual: Re-worded Step 6 for deploying image in eclipse flow.
(From yocto-docs rev: dd0b96a3917ab6b6c0a22af1d23f48beee6a2cd3)

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 7bbaab7c4a sdk-manual: Added note about building the image for QEMU use
Placed a note in step 4 of the "Workflow Using Eclipse(tm)"
section that an alternative method to getting the target
root filesystem and toolchain is to build them out.
Referenced the wiki.

(From yocto-docs rev: 60720be0fe0d29a0b695005bb40f5b0c25475b55)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:27 +01:00
Scott Rifenbark 151a129877 sdk-manual: Removed bad link
Dumped a link to pre-built kernel naming information.  The
link was to the sdk-manual, which made no sense.

(From yocto-docs rev: 9b7a9f8217d9251f2d7166afc0bb3b4235264201)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:27 +01:00
Scott Rifenbark 766e91fa2b sdk-manual: Provided better wording to intro running sdk env script.
(From yocto-docs rev: 41b9b8170179a59b6534db9e926d5086be7d4328)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:27 +01:00
Scott Rifenbark 4e0a0d1253 sdk-manual: Added note about building and SDK
(From yocto-docs rev: 6518e03bc0259af04f01596f3f66c123616063e7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:27 +01:00
Scott Rifenbark 99d43e6293 sdk-manual: Used &DISTRO; for some output release versions.
(From yocto-docs rev: 4dbcd9957366665028adf955951af6256e67c152)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:27 +01:00
Scott Rifenbark 4d5dc4a890 sdk-manual: Created new Mars Eclipse appendix
Fixes [YOCTO #7546]

First draft of the new appendix supporting the Mars version
of eclipse.  New appendix file created and entry made to
the sdk-manual.xml file to include that new appendix file
into the main book.

(From yocto-docs rev: 2fb79c29bcbb5c0801f67d4c245c07c3aa9d2ca2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>

sdk-manual: WIP on appendix C

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:27 +01:00
Scott Rifenbark a3494dde70 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: 1b80e90848d23737462f8b0e55b2ff604f9abf41)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:08 +01:00
Scott Rifenbark 6c5fea2171 documentation: Prepared manuals for a 2.2 release.
* Updated poky.ent to have the appropriate 2.2 variables
* Updated all manual revision tables to have a new entry for
  2.2 - used "Sometime in 2016" for the date.
* Updated the mega-manual.sed file to process internal links
  for 2.2.

(From yocto-docs rev: 2acd49ee197e3e3e725f4cb8cc432437afd8646b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-06 22:53:35 +01:00
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