Commit Graph

57 Commits

Author SHA1 Message Date
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
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