Commit Graph

1033 Commits

Author SHA1 Message Date
Scott Rifenbark d250d38974 documentation: Changed back to the "current" XSL style sheet.
I need to get back to how it was working and then fix the table
box issue from there.  Using the 1.76.1 stylesheets makes the
build too long for the manuals and sometimes the XSL sheets do
not load.

(From yocto-docs rev: 7bc502fa069fdc4aebf5705513bb82127716859f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:47 +00:00
Scott Rifenbark 66ad91bd54 dev-manual: Rewrite of the section on customizing images with packagegroups
This section was pointing to a poor example in meta.  I substituted
in a better example and rewrote the section to flow better around
that example and the final fabricated one.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:47 +00:00
Robert P. J. Day c8691a2d44 dev-manual, mega-manual: Updated kernel-overview-2-generic.png file.
There was a sample string in this tree that ended in "ro" when it
should have been "r0" (as in release 0). Anytime you update a figure,
the modified file must go in both the "figures" directory of both
the manual (dev-manual in this case) and in the mega-manual.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:47 +00:00
Robert P. J. Day 0cec924324 dev-manual: Applied wording to warn reader that wikis have dated info.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ea4489f856417d70b54a7e38da32e068cbd54cbf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:46 +00:00
Robert P. J. Day cd37517f97 dev-manual: Add ref to bitbake-layers "add-layer" and "remove-layer"
(From yocto-docs rev: aafc8f1da396a1838ce541706a8162a1493382b3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:46 +00:00
Pascal Bach b7020b0bb8 dev-manual: Added missing ending quotation to code snippet.
(From yocto-docs rev: 7bf228dbf54e227a06dc69d701b9c83f9c6a2f3a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:46 +00:00
Robert P. J. Day 2674ddb4b0 dev-manual: Some minor fixes to some text.
I applied (in spirit) the changes here... Some literal and some
with changes.

(From yocto-docs rev: 0ccf8a43264981accbe42f729c723804e5b69b72)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-01-06 14:27:03 +00:00
Robert P. J. Day cf17b6cb72 dev-manual: Minor hyphenation fix.
(From yocto-docs rev: 7a88f5f3a3f826ff4c2a6415c279d1fc4a8cc5f8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-01-06 14:27:03 +00:00
Scott Rifenbark 46f120c85c documentation: Updated all XSL style sheet imports to use 1.76.1 version
This fixes the issue where the lines for the manual revision table
are not appearing.  For some reason they do not appear when building
the docs using Ubuntu 14.10 and the "current" XSL transformation
files.  So, I backed up to the 1.76.1 version, which is the nearest
version where the issue does not surface.

(From yocto-docs rev: 82b15986b97b9ed082b652b562eaaf843572fdff)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-01-06 14:26:59 +00:00
Scott Rifenbark 3a17209e12 dev-manual: Added link to ptest wiki page into Ptest section.
(From yocto-docs rev: 2a9cd5948cd17ce9f7eb5381b27c25f97963578e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09 15:09:06 +00:00
Scott Rifenbark 6a57cb10b7 dev-manual: Added more info to mulit-machine builds section.
Fixes [YOCTO #5400]

Per Martin Jansa, added some information in the bullet item that
talks about the tools and the cases that can cause issues when
tuning things by machine or architecture.

(From yocto-docs rev: e8e47828df65abdc18bbd681c47719a7df77b00f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09 15:09:06 +00:00
Scott Rifenbark 117c9b4a64 dev-manual: Edits to the multi-machine builds section.
Fixes [YOCTO #5400]

I applied some review edits to this section as suggested by
Richard Purdie.

(From yocto-docs rev: a1898cf65537e732e0e42605bb28d636077e7f56)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09 15:09:06 +00:00
Scott Rifenbark 5f4050f73d dev-manual: First draft of "multi-builds" section.
Fixes [YOCTO #5400]

This is the first draft of a new section on multi-machine builds.

(From yocto-docs rev: a47fd17295d943bff482a0747f3b2e69831aa985)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09 15:09:05 +00:00
Scott Rifenbark 9104c1c29c dev-manual: Fixed broken link to the allarch class.
(From yocto-docs rev: 3ec771dffdaf7d42b98371516bbb33f915dfe572)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-11-08 11:15:12 +00:00
Scott Rifenbark 1484e62e5f documentation: Updated the manual revision history tables.
Added an entry for the 1.8 release stating that the release
is slated for sometime in 2015.

(From yocto-docs rev: 9799a7848f24024048eae0cbed470a2be4b4b879)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-11-04 10:28:30 +00:00
Scott Rifenbark a0aeeff2c6 dev-manual: Updates to "Performing Automated Runtime Testing"
Updated the section to account for some new variables and
several more ways to run tests against expanded targets.  Also
added power control section.

(From yocto-docs rev: a0f08466c00ae51a99d790fa6c9dccef2e0f1518)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-28 22:31:18 +00:00
Scott Rifenbark e9ecf3fc24 dev-manual, ref-manual: Updated 1.7 migration section with review comments
Applied the second round of review edits from Paul Eggleton.
Minor fixes.

(From yocto-docs rev: 2c7c45c8f09b724e92e8b59fe47834226b44b4fb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:28 +02:00
Scott Rifenbark 8eb706a41b ref-manual, dev-manual: Applied migration review edits.
Applied the full set of first draft revision edits for the
new migration section for 1.7.  Comments from Paul Eggleton.

(From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:28 +02:00
Scott Rifenbark ba0483c9ed dev-manual: Updated the list of linux-yocto kernels
I removed the linux-yocto 3.4 kernel from the list in the
section describing which kernels we support.  Also, added
the 3.17 linux-yocto kernel to the list.

(From yocto-docs rev: 41f57a9abe1201ed2fb657f8441c97f86f75200a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:27 +02:00
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