Commit Graph

1014 Commits

Author SHA1 Message Date
Scott Rifenbark
6c3d1192c7 documentation: Updated release date for manual rev tables.
Added "October 2014" to table for all manuals that have the
table.

(From yocto-docs rev: 3f9ceb4dd2397fe907bf701c842277eb65d11a56)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-03 14:41:30 +01:00
Scott Rifenbark
609c216b60 dev-manual: Updated the supported BSP bullet item.
The bulleted item on supported BSPs was very centric on meta-intel.
I rewrote the section to not be so exclusive.

(From yocto-docs rev: d8118bb6124fbbb2340ae8720cd6187fd5546967)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-30 21:37:42 +01:00
Scott Rifenbark
4995908b97 dev-manual: Added reference to the meta-selinux layer.
Fixes [YOCTO #5482]

Added a cross-reference to the meta-selinux layer in the section
that describes how to make images more secure.

(From yocto-docs rev: 0c96273ee857808046c5a76517c1eda4aa703c81)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-23 21:41:55 +01:00
Scott Rifenbark
bff185f625 dev-manual: Added a note to the EXTERNALSRC example about the class
Added a short note after the example that shows how to set up
the EXTERNALSRC variables stating that the externalsrc class
needs to be either globally or locally inherited.

(From yocto-docs rev: db935135c0b060e06f6a63530df995d286002598)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:44 +01:00
Scott Rifenbark
2acf47b6e6 dev-manual: Fixed typo in the make races section header.
(From yocto-docs rev: 26ffb2e47f3caa8a0ab0f2a9cd83af8cdf893cfd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:43 +01:00
Scott Rifenbark
ab7f117b09 dev-manual: Added a second EXTERNALSRC example.
Added a new example on how to set this from the recipe or the
recipe's bbappend file.

(From yocto-docs rev: bc0d9de3378f3462729301e74419b7dede17558b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:43 +01:00
Scott Rifenbark
79fd7f1b25 dev-manual: Updated another EXTERNALSRC example.
Found another occurrance of where I needed to add a <replaceable>
tag set in an example.

(From yocto-docs rev: 586e5a590bb5382a28fde4670fdcd6cbb75f6c32)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:43 +01:00
Scott Rifenbark
018c498d0f dev-manual: Updated EXTERNALSRC example for user-input formatting.
I missed a <replaceable> tag set on the example.  Adding it
clears up confusion for how to use the variable.

(From yocto-docs rev: 8bbf2a012e580d82aaf9c9a98ad5dab1aea64f7b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:43 +01:00
Scott Rifenbark
b4c03a7c28 dev-manual: Added some formatting for user-supplied input.
(From yocto-docs rev: 0b586d27a647d7afcaff0623919dff33a9206632)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:42 +01:00
Scott Rifenbark
f819f3d7b1 dev-manual: General edits to "Common Tasks" chapter.
* Found and fixed several areas with issues.

* Scrubbed for user-supplied input to make it use the
  <replaceable></replaceable> tags.

(From yocto-docs rev: 0e1c7ad31921ee7d4ee0d7d4ece01303a25a5d60)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:42 +01:00
Scott Rifenbark
c2e5449f96 dev-manual: Review edits for GDB without source
Fixes [YOCTO #6621]

Applied a few review edits for this fix.

(From yocto-docs rev: 99511bbcfa1de2f7bf691da1a002913f3a7f6034)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-22 13:04:42 +01:00
Scott Rifenbark
010d19ec2c dev-manual: Misc edits to the model chapter (Chapter 4).
I replaced user-supplied variables with <replaceable></replaceable>
tags to get proper formatting.  I inserted several references
to the new QEMU chapter for help using QEMU.  I updated a note
on the BSP available so that it is a bit more generic and not so
dependent on an exact list within meta-intel and the source
repositories.

(From yocto-docs rev: daef4406e7c3e45dd5d98d565e519d91939f6965)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:32 +01:00
Scott Rifenbark
1ab0c8fb8c dev-manual: Various small edits to Chapter 3.
Replaced angled bracket items for user-supplied variables
with the <replaceable></replaceable> tags.

(From yocto-docs rev: 393af6c0cfbfc0f3921bc1eb1fdbd3dd734f51ae)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:32 +01:00
Scott Rifenbark
4cc5cb151b dev-manual, mega-manual: Updated the downloads picture.
(From yocto-docs rev: 67c71f5a51749e4f15987ce7cb3ae8f22436bb93)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:32 +01:00
Scott Rifenbark
32b508e7ce dev-manual: Misc edits to Chapter 2.
Added some links and fixed up some replaceable items.

(From yocto-docs rev: 5c9ce934f13c68c2efbd952f399a8b88e87eb761)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:31 +01:00
Scott Rifenbark
d677a6839d dev-manual: Added Toaster to the list of other resources.
(From yocto-docs rev: 14652c5aeb7ae54d079f6360c1fa650638f280ab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:31 +01:00
Scott Rifenbark
5370b58892 dev-manual: Updated section on launching remote GDB.
Fixes [YOCTO #6620]

I altered the path name of the .gdbinit file in the text to prepend
~/ to it to reinforce what file the user must modify.  I also removed
the /home/jzhang string in favor of ~ to make it more general.

(From yocto-docs rev: ff09d3a5666c97598adf385f63dee4b30b0f1792)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:31 +01:00
Scott Rifenbark
932b956b4c dev-manual: Minor edits to the section to add binaries to an image.
Review edits from Paul.

(From yocto-docs rev: 088410d607418531d6ab8a40fdc9d77495b132c9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:30 +01:00
Scott Rifenbark
a20e75f45b dev-manual: Review edits to how to find checksum values.
Edits from Paul to better word this section.

(From yocto-docs rev: 51425ab506050ee5ba30d5c3c10639d5a1b8cc8e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:30 +01:00
Robert P. J. Day
0467e3addf dev-manual: Minor edits via patch to "common tasks" chapter.
(From yocto-docs rev: b1516fb6e6d40e7668ca5a4d5804d1a09c7ed6f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:30 +01:00
Robert P. J. Day
93f0d03a8d dev-manual: Technical and text edits applied as patch.
(From yocto-docs rev: 703cbe5c037334b3fbf08123b7cc501d36e1e8f0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:29 +01:00
Robert P. J. Day
99a3c1911c dev-manual: Edits to several examples and some typos.
These catches are from Robert P. J. Day and applied as a
patch.

(From yocto-docs rev: b805795e9bf68286aa5b79a94792e2fefd293b92)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:29 +01:00
Robert P. J. Day
034640585f dev-manaul: Small edits to various examples.
(From yocto-docs rev: 6ef54d31664b097b8ceeb5da1b8c48cdc6f673a3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12 13:50:29 +01:00
Scott Rifenbark
4a226369b7 dev-manual: Updates for checksums and wic
Accidentally put in a couple different things in this one commit.
Oh well.

1. New wording for how the user needs to figure out some checksums
   for a recipe.

2. Fixed up some note placement in the wic reference section.

(From yocto-docs rev: 6c13f49c265c99ddd6dcd4ec3c3c8e66b78824e0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Robert P. J. Day
d283686dc3 dev-manual: Minor fixes.
(From yocto-docs rev: 71c9e378c86d03e5fb7f4e459e677ad8a9965f52)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark
152d307767 dev-manual: Updated manual overview to include new QEMU chapter
Fixes [YOCTO #641]

Added a new bullet to the list that overviews what the manual
covers.

(From yocto-docs rev: 54bdb50df3951346a2e926700681db55bd59a2e1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark
fb4649297b dev-manual: Edits to the wic reference section.
Pulled a note about future support of commands and options from
the bootloader section and got it up in the higher level intro
section for that part of the manual.

(From yocto-docs rev: f8d677301abcd0d549ea9ad4cca79f43cb2db7f0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Robert P. J. Day
f937e05b44 dev-manual: Miscellaneous fixes in the newbie chapter.
(From yocto-docs rev: 34d6bd814e813591631b336f6247c300381fd309)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark
3152e69383 dev-manual: Created new chapter on QEMU.
Fixes [YOCTO #641]

New chapter added that covers the YP instance of QEMU.

(From yocto-docs rev: 7ca17d02364af7e5924e23df6c138ab4dd2203d6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark
5f31e281ec dev-manual: Added support for new QEMU chapter.
(From yocto-docs rev: d8a852e244f1c0f4d5ef33f50844bb1cb479cb92)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark
25d7b0df2a dev-manual: Modified how to find checksums in the recipes
The section on wrting a new recipe suggested using a "build-fail"
method to get bitbake to return exact checksums for code.  It
was pointed out that this could be a middle-security risk and
that we should not do that but instead get the signatures from
the upstream website.  However, many times those sites don't
provide that information.  I re-worded the text to note the
ideal method (upstream checksums) and then resorted to the
"build-fail" method as a "way" to also get them when the upstream
location does not have them.

(From yocto-docs rev: b06699de2f512b01600bf952a8ee928c2a4c358a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark
3be4af9cf3 dev-manual: Applied review edits to the 'wic' section.
I made some small edits to the section based on Tom Zanussi's
review.

(From yocto-docs rev: 560ea7b0eb131e59b190a34cadbe77729e76d61c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark
73abcb0b16 dev-manual: Fixed up the list of other references.
There was a bogus link in there to the Build Appliance page.
I also noted many links that use the <ulink> tag that crossed
multiple lines.  That is not good.  I cleaned all that up.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: a39cea47cae29d7efb8e12495e8eefb484d464c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark
231fde5b16 dev-manual: Replaced "--" with &dash;&dash; throughout.
(From yocto-docs rev: 79fb4973909ff3a2ba5da8cad8c3d7bdb4206003)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi
7ef076cd9e dev-manual: Miscellaneous wic edits.
This is a set of fixes for miscellaneous dev-manual updates noticed
while transcribing wic help for the dev manual.

(From yocto-docs rev: fd2205e2778e2cef86561025fd904f303d64586a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi
e0aa8f04e9 dev-manual: Miscellaneous updates from the wic help text.
(From yocto-docs rev: 99b04623aa47d07970f91e2bdf648f25ab54c59b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi
b8a836c0c9 dev-manual: Added --fsoptions to wic
--fsoptions support was recently added to wic, so document it.

(From yocto-docs rev: 91efb698eea438083474c1e905dbaad3fffdbd81)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi
537e965cc7 dev-manual: squashfs support added to wic section.
squashfs support was recently added to wic, so document it.

(From yocto-docs rev: 22ca1141953b4fae92e15126da296d3d95e80c25)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi
2a11e9d294 dev-manual: Created new "Plugins" section in the wic section.
Add a new section discussing plugins, taken directly from the
corresponding wic help section.

(From yocto-docs rev: c1b4c378a496413f2dde8ad2f043a537cba24b6e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Scott Rifenbark
1a825210d8 dev-manual: Updates to the creating partitioned images section.
Fixes [YOCTO #6511]

Added a new example to this section that shows how to package
up binaries so that you can add them to an image.

(From yocto-docs rev: e52acc444c8f142d0469d7274fb936b5242306ec)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Robert P. J. Day
4560e2fc92 dev-manual: Added note and fixed a grammar spot.
(From yocto-docs rev: 934dbe2faff2a553bf281d55edcd6b8de9c31c06)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Robert P. J. Day
b1a9074744 dev-manual: Patch to fix some links and references.
Add in a few links to member orgs, and update the BitBake link.

(From yocto-docs rev: 481c89e9b8e219358db8bfdfff0b5b0150247c07)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Scott Rifenbark
6ebbf038ab dev-manual: Updated example "foo" recipe name used in examples.
The recipe should be named "foo_1.3.0.bb" instead of
"foo_1.3.0-r0.bb".

(From yocto-docs rev: c34c3ea05d550fc85ab04036856704a7c04fd64c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Scott Rifenbark
5ba68f32a8 dev-manual: Added the section on "Creating Partitioned Images"
This is the section on 'wic'.  I have dropped in the same exact
section from the 1.5.3 (dora branch) release as a starting point
for Tom Zanussi to scrub and update for the master branch.

(From yocto-docs rev: e189992bff4249664ba959b1c440541e0b84e03d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-23 10:02:13 +01:00
Scott Rifenbark
ed3cd02d4c dev-manual: Removed not to the PTEST_ENABLED variable.
The note did not need to be there.

(From yocto-docs rev: 5ff94a1a412447c1ed1cda64e985b52545ccd9e7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:53 +01:00
Scott Rifenbark
08d68e5bc8 ref-manual, dev-manual: Updates to support PTEST_ENABLED.
In the ref-manual, I added a new variable description for the
PTEST_ENABLED variable.

In the dev-manual, I added a note to the "Adding ptest to Your
Build" section to mention that the OpenEmbedded system uses
PTEST_ENABLED to enable or disable building ptests and that
the user does not set this variable directly.

(From yocto-docs rev: 52d6608caaa25378b873e41e1ddd05356ff8629a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:10 +01:00
Scott Rifenbark
11bf70bba1 dev-manual: Fixed a couple typos in the Template section.
(From yocto-docs rev: 9285eee037022ed29a0bdc2c9ecc628c63b47e2b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:10 +01:00
Scott Rifenbark
9eb3e85557 documentation: Added permalink display styles to CSS files.
Fixes [YOCTO #5772]

Updated each manual's CSS style sheet to contain a style for
how the permalink symbol looks on its own and how it looks
when a user hovers over it with the mouse.

(From yocto-docs rev: c8d4afa0b83a40ac2de0c47c191a11b3e7d241e5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:09 +01:00
Scott Rifenbark
01af798187 dev-manual: Fixed a mult-line <ulink> cross-reference
These types of references cannot span multiple lines.  If they
do then mega-manual.sed will not process the link in the
mega-manual.html file.

(From yocto-docs rev: 8a06542c0f1fee503eda12052adddaaf9c94ca91)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:07 +01:00
Scott Rifenbark
d785a16dff dev-manual, yocto-project-qs: New section on working with source files.
Fixes [YOCTO #5566]

For the dev-manual, I created a new section called "Working
with Source Files."  In the section, I cover how to set up mirrors
and also how to pre-fetch source using the bitbake -c fetchall
<target> command.

For the yocto-project-qs, I removed the mirror information in the
"Super User" section, which became redundant with the new section
now in the dev-manual.  I also, removed the fetchall variation of
the bitbake command.  Both areas reference into the new section of
the dev-manual now.

(From yocto-docs rev: f314061e3e752d35ea85ed16a60f7f9292180921)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:50 +01:00