Commit Graph

1163 Commits

Author SHA1 Message Date
Scott Rifenbark 2bbf77a6bb dev-manual: Fixed a grammar error
(From yocto-docs rev: 7b81f29a641cad4f10c3c721c0d40ce11d928648)

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 c3946bcaa6 dev-manual, profile-manual, ref-manual: Updates to remove meta-toolchain
The term "meta-toolchain" is legacy now.  I went through and removed
its use except for where it appears still as output from the
oe-init-build-env script.

(From yocto-docs rev: 1cc134060459278997d57f1293f54091c5404d85)

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 19e3648390 dev-manual: Edits from a 2.1 read-through.
* Removed some eMenlow stuff
* Cleaned up the description of the BSP structures we have now.
* Various links fixed into the SDK manual.
* Other minor fixes.

(From yocto-docs rev: 5e45005d7ff2254df2754a5ea2d7efd7f1c19a42)

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
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 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 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 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
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
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 2a3942bd2a dev-manual: Updated section on adding license text.
Fixes [YOCTO #8634]

I updated the "Providing License Text" section to include some
verbiage on the new CREATE_LICENSE_PACKAGE variable.

(From yocto-docs rev: db2155875dd741000e5f67253486580bba70584f)

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 b2b72143ab dev-manual: Restored ptest-runner2 to ptest-runner
Notified that Anibal wanted this reverted from the commit
that changed it.  This is due to the fact that we now use
the same name for the new recipe ptest-runner instead of
ptest-runner2 to maintain compatibility with old code.

Reported-by: Anibal Limon <anibal.limon@intel.linux.com>
(From yocto-docs rev: a1548ee35a797035247d8fdee6127560db9ead5d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:04:48 +00:00
Scott Rifenbark d39e9d1451 ref-manual: Rewrite of "Image Generation" and devtool text.
Rewrite of devtool reference section. This was a separate commit
but got squashed wrong so it ended up with this commit.

The changes to "Image Generation" section reflect the new, more
detailed image generation figure

(From yocto-docs rev: 827c6872b88c17d2d0c8d44b1024fff19076e505)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:04:47 +00:00
Scott Rifenbark 9f192c81be dev-manual: Updated the devtool help examples.
(From yocto-docs rev: ca02638c515a77986f08c392602df105ab9c185a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:04:47 +00:00
Scott Rifenbark 4bbd39d00b dev-manual: Grammar fix to kickstart section.
The "Generate an Image Using an Existing Kickstart File"
section had a missing subject.  Fixed it.

(From yocto-docs rev: 7ab6d1422690373e59d681e423a80595879788b4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:04:47 +00:00
Scott Rifenbark 75078dd273 dev-manual: Updated wic reference section
Fixes [YOCTO #8844]

Made some changes to reflect the requirement of certain options
when creating a partion such that the partition is automatically
mounted.

(From yocto-docs rev: 096f33b7b7a0360c1df345dd669bbe00723b1882)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:04:47 +00:00
Anibal Limon afc6cbaa80 dev-manual: Updated "Running ptset" section
Changed out "ptest-runner" with "ptest-runner2" and updated
wording from "script" to "program".

(From yocto-docs rev: 221d7c6125f5fc02b9ce7bcf177fb382f421ff9f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-15 16:31:17 +00:00
Ed Bartosh 5d2745190f dev-manual: Added the --configfile bootloader option.
(From yocto-docs rev: 649b6cf64a726b0682d756e23e6d56a490ea505e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:46 +00:00
Ed Bartosh 7b3b1f9d31 dev-manual: Added three new wic option descriptions.
* --part-type
 * --use-uuid
 * --uuid

(From yocto-docs rev: 63e08898bc2853789a0a13ce015183a35cf1a92a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:46 +00:00
Ed Bartosh eeffa647d5 dev-manual: Added the --overhead-factor wic option description.
(From yocto-docs rev: 67d90401faa4992638ed6903fb74388193ff6aec)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:46 +00:00
Ed Bartosh 2beb19b764 dev-manual: Added the --extra-space wic option description.
(From yocto-docs rev: 1c386d5f76eb905487fe59c55618aea02abd1d7e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07 12:13:46 +00:00
Ed Bartosh 95851dffbe dev-manual: Added wic --notable option description.
(From yocto-docs rev: 5e0594889eee6cff30cf378ac66993439351b486)

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
Ed Bartosh 88a2794b18 dev-manual:
Updated the --source wic command-line option for partition
size details.

(From yocto-docs rev: 3affc38b6a9716316257d1d627185a4d5e9befef)

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
Anibal Limon 6686a3176e dev-manual: Correction to the KVM stuff in the runqemu commands.
Applied this patch from Anibal to correct an earlier patch.

(From yocto-docs rev: 9b944a5f4192b2e03df4ddcba5af4949df7bb8a9)

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
Scott Rifenbark ccc830df1d documentation: Prepare for 2.1 builds
The changes are for the poky.ent file and the mega-manual.sed
file to take care of variables.  Also, entries added for the
manual revision table.

(From yocto-docs rev: 60da39f85165e2d4aef55d456f8203183e089433)

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
Anibal Limon 2e649d79ab dev-manual: Updated runqemu command options list
Since 2.0 release KVM mode does not require VHOST
enablement and a new option was added to support the
old mode.  Updated the list of runqemu command options.

(From yocto-docs rev: 6bca626b163ee5e35e04d659579076ab92c4951a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-11-18 16:42:22 +00:00
Scott Rifenbark cd48ccccaf dev-manual: Added notes to clarify use of pkg-config
Fixed [YOCTO #8168]

I placed a couple notes in the "Configuration" and "Compilation"
sections within the "Writing a New Recipe" section.  These notes
point out that the build system (as of release 1.7) now disables
several *-config scripts.  The user should be using "pkg-config"
to ensure proper pathname construction and location of these
types of scripts.

(From yocto-docs rev: a46fd0f7b4d5da7bf3b218441ec5b9a6ef552266)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:35 +01:00
Scott Rifenbark 2fe3809465 ref-manual, dev-manual: Applied feedback to edit several classes
Fixes [YOCTO #8298]

Updated several classes with feedback from Jose Lamego of Intel.
The feedback fixed some class groupings so that previously isolated
classes could be bundled under common classes (e.g.
autotools*.bbclass).

I scrubbed the cross-references for cases where a particular
class became "undocumented."  The cross-references now point to
the bundled class entry in the ref-manual.

(From yocto-docs rev: 07a533cb41ad26d202f4e303f2dbc7d7bf26e076)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21 23:06:34 +01:00