Commit Graph

3814 Commits

Author SHA1 Message Date
Belen 00fe95d133 toaster-manual: Explain the local release
The fact that the Local Yocto Project release does not provide any
compatible layers confuses people. Add a section about the local release
to explain what it does.

[YOCTO #9229]

(From yocto-docs rev: cc7ebcd5a66ff3041a7fdd17e697dfb60b08cadd)

Signed-off-by: Belen <belen@icarus.isw.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:06 +00:00
Belen Barros Pena d06c7b8ce6 documentation: remove all references to Hob
Hob and the packageinfo class have now been removed from the
code base. This patch removes all references to:

* Hob
* meta-hob
* packageinfo and
* BBLAYERS_NON_REMOVABLE

from the documentation.

So long, Hob, and thanks for all the fish.

(From yocto-docs rev: 6a1ba2761d5c2ec1072616ce3d791787f1b1b2a7)

Signed-off-by: Belen Barros Pena <belen.barros.pena@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:06 +00:00
Scott Rifenbark be8af376b1 ref-manual: Updated COREBASE_FILES variable.
Applied review comments.  Fixed some wording.

(From yocto-docs rev: 0d1ccaf3dadf890498b3f2b090ece276a537b43c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:05 +00:00
Scott Rifenbark 01554725f5 ref-manual: Updated "Application Development SDK" section.
Applied review comments to the section.

(From yocto-docs rev: 83871d0f6cd996be2d3476bdfc0f2adef9ff52a7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:07 +00:00
Scott Rifenbark 443846088a ref-manual: Applied review edits to several SDK variables.
(From yocto-docs rev: 3d198bc298e6c88ba229f10b96a8e5faf0727897)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:06 +00:00
Scott Rifenbark 3c727ff843 ref-manual: Updated "Cross-Development Toolchain Development" section.
Updated the note to have a bit better wording regarding
extensible SDK specifics.  These changes were in response to
a review of the section.

(From yocto-docs rev: 0209292cafbbe4918ec7ecdf1f48fc8ef2703b9b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:06 +00:00
Scott Rifenbark af1517cbfe ref-manual: Updated "Build History SDK Information" section.
Applied review edits to adjust this section for the
extensible SDK stuff.

(From yocto-docs rev: d386fca0b4e54ae2d5e610b37089fb058d80a746)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:06 +00:00
Scott Rifenbark d9fc04b47c dev-manual, mega-manual: Updated "Application Development SDK" section.
I updated the figure for this section to include some stuff
for the extensible SDK.  I updated the text supporting the
figure to cover the different SDKs and the different SDK
variable sets.

(From yocto-docs rev: 5aafab3e2e841293ddba45dfd8683cbdc223ed7c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:06 +00:00
Scott Rifenbark 357aa3322e ref-manual, mega-manual: Updated "SDK Generation" section.
Updated the figure used to show SDK generation.  I added a block
to cover the extensible SDK stuff.  This affected the figures
folder in both the ref-manual and the mega-manual.

Updated the text section to support the new figure.

(From yocto-docs rev: b9fd7c2b0ea0e2fe1805a1bb1eb1bcb82c807b66)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:06 +00:00
Scott Rifenbark 54490c06c6 ref-manual: Added several extensible SDK variables to glossary.
SDK_EXT_TYPE
SDK_RECRDEP_TASKS
SDK_LOCAL_CONF_WHITELIST
SDK_LOCAL_CONF_BLACKLIST
SDK_INHERIT_BLACKLIST
SDK_UPDATE_URL
SDK_TARGETS
OE_INIT_ENV_SCRIPT
COREBASE_FILES
SDK_TITLE
SDK_INCLUDE_PKGDATA

(From yocto-docs rev: c057b9c7027460fa6e53beb3431bf6aa1518b3aa)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:06 +00:00
Scott Rifenbark 6dfd441d08 ref-manual: Updated IMAGE_PKGTYPE variable.
Fixed the text to a link to the populate_sdk_* class.
The link was good but the text was old.

(From yocto-docs rev: dc892cdf618c008a9ce615c31ef643987dfcca13)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:06 +00:00
Scott Rifenbark 77f002ca64 ref-manual: Updated "Cross-Development Toolchain Generation"
I added a note about the extensible SDK not including gcc-canadian-cross.

(From yocto-docs rev: 53866854af53e97c9d8ca8d0771e12a7744ad6bd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:06 +00:00
Scott Rifenbark ee90cc6bf0 ref-manual: Updated the "Build History SDK Information" section.
Added some new files to the list of files highlighted for this
directory with "sdk".

(From yocto-docs rev: 213371bc5c5eb00d37ace5f2b330a87e1f10b73e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:05 +00:00
Scott Rifenbark 53dd8a06ec dev-manual: Moved "Optionally Using an External Toolchain" to Tasks chapter.
(From yocto-docs rev: e7880667db33c1495d1cbcb91de8c91b9b84dc59)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11 23:06:05 +00:00
Scott Rifenbark 5cd71fe432 yocto-project-qs: Updated flow to mention Toaster
In the "Building Images" section, we just plow into the command
line experience without giving any indication of a GUI option
through which to try out the Yocto Project.  I updated the
paragraph introducing the build stuff by presenting the command
line method or a GUI method via Toaster.

(From yocto-docs rev: c7d0b2e1c3f9746bdcf2ba8ded71ee14cfa17e58)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:14 +00:00
Scott Rifenbark cd041b7546 dev-manual: Applied review comments to the devshell section.
Applied better wording to a couple areas in this section as
pointed out by the review.

Fixes [YOCTO #9114]

(From yocto-docs rev: f5a402aa08b102c767e112d8df05041650733d54)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:14 +00:00
Scott Rifenbark f54fe56fed ref-manual: Updates for nativesdk clarifications.
Fixes [YOCTO #8620]

Added a couple more clarifications for some nativesdk term
uses.  Minor edits to help make things clearer.

(From yocto-docs rev: 38082e1120861332674f97f67966b1f5cec7dc03)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:14 +00:00
Scott Rifenbark a882267b58 dev-manual: Fixed typo in the devshell section.
(From yocto-docs rev: 6dd9cae65d8ae0617c69f57c6df67bfd769ce30c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:14 +00:00
Scott Rifenbark 70c7e36cb4 dev-manual: Created devtool upgrade section.
Created the new section for the devtool upgrade flow.

(From yocto-docs rev: f3a7f78305ce5045604d9892e18b31b7eabcba62)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:14 +00:00
Scott Rifenbark b2b22d5eda dev-manual, mega-manual, Makefile: Added support for new upgrade flow
Created a new figure for the devtool upgrade flow.  Put the figure
in the "figures" folder of the dev-manual and the mega-manual.
Updated the Makefile to include the new figure when creating
Tarball of the dev-manual and the mega-manual.

(From yocto-docs rev: 4b504f6f179ca7c7e9a69f23fc25b1f33ced8e44)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark 0b7d8a4c76 dev-manual, mega-manual: Updated the workspace directory structure image
Removed the "mis-spelling" indicators.

(From yocto-docs rev: 558362fa59be94a8ebd29fbdbd932ef88d411272)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark 050e021d72 dev-manual: Applied review changes to the devtool section.
(From yocto-docs rev: 756cffbc732010f376c6c2362ba33a9061be121c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark 09ecf38658 dev-manual, mega-manual: Updated three figures for devtool
Made some review changes to the workflow structure, devtool
add flow, and devtool modify flow diagrams.

(From yocto-docs rev: f432d9b0270615974e67a0cc243560fdbfa44724)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark f33ffaa3d4 dev-manual: Applied more review comments to the section.
Closing in on the devtool add and devtool modify sections.

(From yocto-docs rev: 202b688c03cc1801576bbed3b771bb329f6b8520)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark fe70eb29b3 dev-manual, mega-manual: Updated the devtool modify flow diagram.
(From yocto-docs rev: 54fbb2c739eb696388c622fd755f0417fa98fe5e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark eb3b414308 dev-manual, mega-manual: Updated the devtool add flow diagram.
(From yocto-docs rev: eef94731d1eb094623511e1b85a2d8bc47e58b86)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark 4c5bd3f452 dev-manual, mega-manual: Updated the devtool workspace figure.
(From yocto-docs rev: 7c26a08d7549dd47557386e7037429465732b112)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark 9cee16bd2e dev-manual: Applied review comments to the devtool section
(From yocto-docs rev: 8bd08b5bbe245e48496b95740d8b205650bd4a35)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark c678d1a524 dev-manual: Updated the devtool add section.
(From yocto-docs rev: 3d6efac4a54de21f4c6bba4e3eb3a7c2fcfd33ba)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark a09238adc7 dev-manual, mega-manual: Updated devtool add flow diagram
(From yocto-docs rev: 8ae3414d80a7636719184e1b7ae4cc8618ba6887)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark 7699f0ab60 dev-manual: Added section for devtool modify flow
New figure and some writer notes for now

(From yocto-docs rev: 0a627626f5f353e514b0225b468b0bd0fa3ceef3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark 1eecaea70d dev-manual, mega-manual: Added new figure for devtool modify flow
(From yocto-docs rev: 2472ab38e0badd50d4e30e161bb56edba4cfbdb2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark 9582da61de dev-manual: Edits to the devtool-add section.
(From yocto-docs rev: f7f3cfa4a6faa556650b5ab8a04e68c585c30107)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark 740369fa14 dev-manual, mega-manual: Updated the devtool add flow figure
(From yocto-docs rev: aec89678e191405e7757d322c004de7bd1ab482c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark a848e9fec3 dev-manual, mega-manual: Updated the workflow layer content figure.
dev-manual: I did not have the checksum figure there or the sources
directory.

mega-manual: Per normal, had to copy the updated figure into the
figures directory of the mega-manual.

(From yocto-docs rev: d6fb3373b2f3c1e89da87d3e8b9877e643f73c8e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark 34e08b3373 dev-manual: Added new "writernotes" style.
This style is for review purposes and can be implemented in
the XML file using <para role='writernotes'>.  The text in the
paragraph is rendered red.

(From yocto-docs rev: db990802594af3a70b11e320c06fe6a9dc80579b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark 17a21e6f73 Makefile, dev-manual, mega-manual: Added new figure support
Created a new figure for devtool add flow.  Added support
for it in the Makefile.  The figure, as usual, needs to
reside in the figures directory in both the dev-manual and
the mega-manual.

(From yocto-docs rev: 2040a31b806fdade060f7a4182a09673b76db7b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark d346c35b19 dev-manual: Applied review comments to devshell section.
Fixes [YOCTO #9114]

Added a "Notes" box to address run script naming points
and the fact that running a task's script is identical to
what BitBake would do when it runs the task.

(From yocto-docs rev: ddfba59743c977a3a3483ed9053434d3c622f698)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark 3b410498fe ref-manual, dev-manual: Clarifying "native" and "sdknative"
Fixes [YOCTO #8620]

I applied some review comments for the changes made to several
areas in both these manuals.  Minor wording fixes and the
dropping of some changes as directed by Joshua Lock.

(From yocto-docs rev: 71af89da612c37162ba27844c297879d643caf65)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Scott Rifenbark a1970eb17b dev-manual: Updated devshell section.
Fixes [YOCTO #9114]

Added more detail on how to run commands from within the devshell.

(From yocto-docs rev: 6535a8b80bbad3a4ece191c7e5a145ef5e09f1e2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Belen Barros Pena a58cde0857 toaster-manual: Updated how manage.py createsuperuser command is run
The manage.py createsuperuser command must be run from the directory
containing the Toaster database, and not from the root of the checkout
directory, as the manual indicated. Amend the section to provide the
correct instructions.

(From yocto-docs rev: 41fa8a04c947169d971c5e1ecb4619249d1dc7b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Scott Rifenbark c5b4f69821 ref-manual, dev-manual: Clarification of "native" and "sdknative"
Fixes [YOCTO #8620]

I went through and made some judgement calls on the use of
"native" and "sdknative".  I tried to make sure that the reader
understood the real meaning of these terms.

(From yocto-docs rev: d711e8c6dfb32a4ad79e9d11dbf44fbc759d0245)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Belen Barros Pena 952bcc7fd5 toaster-manual: Removed prompts for json file.
Two instances existed instructing the user about a prompt
for the json file prompt.  These have been removed.

(From yocto-docs rev: f45cb8c5db70ef15e685c68508fd3941d8c6727e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Scott Rifenbark 34c75fadbd ref-manual: Updated the S variable description with feedback
Applied wording feedback.

Fixes [YOCTO #8542]

(From yocto-docs rev: 847d8bad345728c4a1c95766a127ec6ddb8ad33c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Scott Rifenbark 2b2ced01f7 ref-manual: Updated the staging.bbclass description
Fixes [YOCTO #8800]

Provided better wording.

(From yocto-docs rev: 4a419e22f1ec3623db45393422ca6287d2a73563)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Scott Rifenbark b9dddd511e ref-manual: Updated the S variable description.
Fixes [YOCTO #8542]

I updated the description with a new example specific to Git.
When you use Git, you have to specifically set the S directory
for things to work.

(From yocto-docs rev: 10d71ccda461098fd8c94677d91fd261f6edf508)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:11 +00:00
Scott Rifenbark 41e9f7cdac dev-manual, ref-manual: Updated licensing text information.
Fixes [YOCTO #8634]

To clear up the behavior the COPY_LIC_DIRS, COPY_LIC_MANIFEST,
and LICENSE_CREATE_PACKAGE variable behaviors, I updated the
glossary descriptions of the variables.  Also, added more info
to the "Providing License Text" section in the dev-manual.  Tied
everything together with good referencing.

(From yocto-docs rev: e7b2a1ed29dcd9d572b71f756e7705e6499a05ac)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:10 +00:00
Scott Rifenbark 5066fbcfb4 ref-manual: Added order information for conf file parsing.
I included a new paragraph at the end of the section describing
configuration in the "Closer Look" chapter.  Cases exist when
two configuration files set the same variable.  Depending on the
order, the last configuration file parsed is the one that actually
sets the variable.

Fixes [YOCTO #8914]

(From yocto-docs rev: 260e7dea7879846bcd3f3475cef001e512c657f0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:10 +00:00
Scott Rifenbark ad6b2f2e0b toaster-manual: Removed typo - double "allow" words.
(From yocto-docs rev: 47f55ee6ef4348d0825631f205815c97903ee4c8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:10 +00:00
Scott Rifenbark c8c533ec62 ref-manual: Updated the do_populate_sysroot task.
Fixes [YOCTO #8800]

(From yocto-docs rev: 582fc36e9c7157ca9457cad5c8bc6824163feede)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:10 +00:00