Commit Graph

755 Commits

Author SHA1 Message Date
Scott Rifenbark 56e0326d42 dev-manual: udates to toaster section.
Fixes [YOCTO #4730]

Edits to the new section on toaster.  These are from Belen's review.

(From yocto-docs rev: f1462bd53bf39c706a87af86830a92b451b3e00c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:58 +01:00
Scott Rifenbark 0615dc0a57 dev-manual, ref-manual, yocto-project-qs: Debian support added
Fixes [YOCTO #4912]

Throughout the manual set, various areas talk about the Linux
distributions we support and the required packages among other
items that are tied to a distro.  Debian had been missing except
from the list in the ref-manual that shows the releases we test
against.

I have attended to all areas where Debian needs to be mentioned
now.

Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 2004567821add745d320106b0dc6cccb4f73b605)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:57 +01:00
Scott Rifenbark 4888d1e6a1 ref-manual, dev-manual: Review edits for Build Directory wording.
Did some word-smithing to work around a false statement that
implied externalsrc.bbclass needed to be inherited on a
recipe-by-recipe basis.  This affected the usage section and
the glossary definitions for both EXTERNALSRC and EXTERNALSRC_BUILD.

Also updated the "B" variable description to be more accurate
in the use of the term "Build Directory."

(From yocto-docs rev: 46695817b6e44cfa88161699105b8d03a5828fd2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:54 +01:00
Scott Rifenbark 43bc43ca81 ref-manual, dev-manual: Fixed links for SERIAL_CONSOLE
These manuals had references to the deprecated SERIAL_CONSOLE
variable.  Changed the links to SERIAL_CONSOLES.

(From yocto-docs rev: 998b8524d2111ebfb6bdb3d4620434cd81d92489)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:53 +01:00
Scott Rifenbark 76f5d3f7bd dev-manual: updates to how to use externalsrc.bbclass
I made sure all the usage information for this class is in this
section and not in the ref-manual.  Changes involved using
EXTERNALSRC and EXTERNALSRC_BUILD now to select the source
and build directories.

(From yocto-docs rev: f818d7013502d943517a99b84397e98f5f9dfd9a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:50 +01:00
Scott Rifenbark d39c2e291d dev-manual: fixed a grammar issue.
(From yocto-docs rev: d3f5099e353c1f787d155d1178744f5a8f19e1db)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:45 +01:00
Scott Rifenbark eccd321364 dev-manual: Changes "Webhob" to "Toaster"
I made some assumptions that the supporting filenames would
be changed to reflect the new name.  If they do not, I will
fix them.

(From yocto-docs rev: 4e71ea30951cef60e5a7daf5f11a197511731b8f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:42 +01:00
Scott Rifenbark b44a9ab990 dev-manual: First draft of webhob section
Fixes [YOCTO #4730]

First draft of the section documenting the webhob service.

(From yocto-docs rev: 4d995519cd4e481445a5399f936fce682d330dfe)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:42 +01:00
Scott Rifenbark a9e5f08ec3 dev-manual: Fixed some rogue characters.
Discovered a random ":S" and ":" character in front of a
couple of list items.  Must have been a wandering cursor
situation during an edit session.

(From yocto-docs rev: b81412e255ca90e850bce61ef7f9927692f0fcb5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:39 +01:00
Trevor Woerner 4592adb69f dev-manual: Fixed reference to bug format.
Based on observations from the various mailing lists, it is obvious that
bugzilla issues are almost always referenced using square brackets.

(From yocto-docs rev: 10b51afe7db62b8eb6e29bd1dd1ba4edb4320f83)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:36 +01:00
Scott Rifenbark 6546d5a720 dev-manual: Removed file.
I removed the original version of this file.  It has been hanging
around long enough and there is no need for it to be tracked
now.

(From yocto-docs rev: 180465d8f3ab80e1b8bf51d82cbccc3b0e51f976)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:35 +01:00
Scott Rifenbark e3550b4f28 dev-manual: Changed repo name.
Changed the poky-extras repo name to meta-yocto-kernel-extras
repo.  This repository had become stale and Bruce did some work
to freshen it up a bit.  The name was poor too.  That drove the
name change.

(From yocto-docs rev: 4fa2b0f86cfe7191b8de7577d8d8ad6adb984a4e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:35 +01:00
Scott Rifenbark 26a9dd8c29 dev-manual: Updates to the "Cross-Development Toolchain" term.
This term description has been reduced to an introduction only.
The real details are now in the ref-manual.  This term now simply
is introduced and the reader is referred to the ref-manual
section.

(From yocto-docs rev: 4d53a25e1871d793d5c38eba4d1f8715c989cb4d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-06-21 14:26:30 +01:00
Scott Rifenbark a4218c821f dev-manual: partial update to cross-development toolchain definition.
(From yocto-docs rev: 3a6f396c09a6d6a4e8a7fe9316b57166488d7fee)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-06-21 14:26:30 +01:00
Scott Rifenbark 1e55bc4ae5 dev-manual: Added definition for the term "Meta-Toolchain"
The definition simply states it is sometimes used for
"Cross-Development Toolchain".

(From yocto-docs rev: 477c2f88694feb148111dc69907945d267056eaf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-06-14 17:33:31 +01:00
Scott Rifenbark 6ea2dd519a dev-manual: Updates to the term "Cross-Development Toolchain"
(From yocto-docs rev: 80fcb3ce0a7d91dff2cb09dc5267528cfb6548ae)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-06-14 17:33:31 +01:00
Scott Rifenbark cb427a6bee dev-manual: fixed formatting of PREFERRED_PROVIDER variable.
(From yocto-docs rev: 99248e450ebe4e5a7a413ffa7fb0f5e930289a6f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-06-14 17:33:31 +01:00
Jesse Zhang d67aecffea dev-manual: Fixed order for variables in ptest section.
The IMAGE_FEATURE and DISTRO_FEATURE are exchanged.

Reported-by: Jesse Zhang <sen.zhang@windriver.com>
(From yocto-docs rev: 07b09af0d94fed1812465db39aa89edc2db135d0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-06-14 17:33:30 +01:00
Trevor Woerner eacc13adbd dev-manual: Updated reference to where licenses are kept
After a build, the license data is found in ${TMPDIR}/deploy/licenses not
${TMPDIR}/deploy/images/licenses.

Reported-by: Trevor Woerner <twoerner@gmail.com>
(From yocto-docs rev: 7f9b3d842f0f68bd0c005a20d38f1b26aef11387)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-06-14 17:33:30 +01:00
Scott Rifenbark aeead1fe2d dev-manual, ref-manual, poky.ent: Fixed broken Release Note scheme
The URL naming convention for the YP Release Notes has changed.
It now takes the following form:

  http://www.yoctoproject.org/download/yoctoproject-15-poky-1000

The above is an example for YP Release 1.5 and poky release 10.0.0.

I have set up three new variables in the poky.ent file to somewhat
automate the links in the docs to point to the location of a given
set of release notes:

 1. DISTRO_COMPRESSED - set to the DISTRO string with no period
    (e.g 15 for 1.5).

 2. POKYVERSION_COMPRESSED - set to the poky version with no
    periods (e.g. 1000 for 10.0.0).

 3. YOCTO_RELEASE_NOTES - set to the full-blown release note
    URL.

I made two changes to existing links for the Release Notes.  One
was in the dev-manual and one was in the ref-manual.

(From yocto-docs rev: e6088927980a1de8022b22f7f38b3046fea20235)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31 08:19:21 +01:00
Scott Rifenbark 4f41a86018 dev-manual, kernel-manual: Added links to THISDIR variable
There is now a glossary description for the THISDIR variable
in ref-manual.  I added some cross-reference links to the
variable in key places of these two manuals.

(From yocto-docs rev: 0d0f756c142c506a66ebc6a1a33e9f124dafd333)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31 08:19:20 +01:00
Scott Rifenbark e230049198 dev-manual: Updated wording about Git
I removed the statement saying that checking out a Git repository
is a backup of the repo.  Technically, that is not true.  It would
be more of a clone operation.  The statement was superfluous anyway
so I decided to remove it altogether.

Reported-by: Trevor Woerner <twoerner@gmail.com>
(From yocto-docs rev: 081bd0119f8c17a3932485857b6846dcb6998ee1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31 08:19:20 +01:00
Scott Rifenbark ea114c07d4 dev-manual: Edits to removing package management requirements
Fixes YOCTO #1706

Applied another set of minor review comments to the section
received from Richard Purdie.

(From yocto-docs rev: 48aa19b7eea9f4b253cbe86981431ec7dc6d78df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:40 +01:00
Scott Rifenbark 9910776fd2 dev-manual: Applied review comments for eliminating packaging req.
Fixes YOCTO #1706

Richard suggested some technical wording changes.  I also added
the new sub-section into the introductory material as part of the
parent section.

(From yocto-docs rev: 201ae16541676365bef69be578433222191eccd3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:39 +01:00
Scott Rifenbark b637518909 dev-manual: Created new section to remove packaging requirements
Fixes YOCTO #1706

Added a new subsection to the section that talks about making
a tiny system.  The subject matter fits in with reducing a
kernel image size.

(From yocto-docs rev: 51eb79b88794beaefcb88a4408714a88c9126b2b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:39 +01:00
Scott Rifenbark 91ec8a8988 documentation: Updates to properly build the 1.5 manuals
1. Changed the variables in poky.ent to contain the "1.5"
   string and the "tbd" string for the unknowns.

2. Updated the manual revision history tables so to replace
   the 1.4.1 release entry, which should not be there, to the
   1.5 entry.

(From yocto-docs rev: d03a09875b1fe0d244b7a7c1bde718319d95a8ab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:38 +01:00
Scott Rifenbark 98d2211872 documentation: Set up the 1.4.1 manual set.
1. Edited poky.ent to have 1.4.1 and 9.0.1 for release stuff.
2. Updated the manual revision tables to have a new entry
   for 1.4.1 release.

(From yocto-docs rev: bd4058b98f93ea5fd5d878f24018ce78b8ce1a53)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:38 +01:00
Scott Rifenbark 514176c231 dev-manual, ref-manual: Minor edits suggested by Bill Traynor
Applied some re-wordings as suggested by Bill Traynor.

Reported-by: William M.A. Traynor <wmat@alphatroop.com>
(From yocto-docs rev: 2510d9795720afc0309a10b18605e5af4a83769b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:38 +01:00
Scott Rifenbark 06af7c1b32 dev-manual: Review edits applied to selecting init manager section.
Applied comments based on Ross Burton's review of this new section.

(From yocto-docs rev: d4f5f7b712ea2944efffec9b675341143675efb0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:35 +01:00
Scott Rifenbark 295db71895 dev-manual: Fixed directory name used in example.
(From yocto-docs rev: 1efd52814eaeadd36bb12a53f31967eb959b32a1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:23 +01:00
Scott Rifenbark 969218e5f6 dev-manual: Edits to "Set Up Your Layer for the Build" section.
Added a cross-reference to the section that describes how to
use .bbappend files.

(From yocto-docs rev: 884740c066f0f45cfc85282c6d20737a39d7af88)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:23 +01:00
Scott Rifenbark 6a3f129958 dev-manual: Edits to "Using .bbappend Files"
I re-wrote this to more clearly describe use.

(From yocto-docs rev: c3d6eecd38c6d4c8b4e0b4e134cbd53ae3fd2aee)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:23 +01:00
Scott Rifenbark fe7fa4eea6 dev-manual: Edits to "Providing Compilation Scripts and Source Code Modifications" section.
(From yocto-docs rev: ff4f02f8af25ff753a5b47e11ed1d79024c51cd5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:19 +01:00
Scott Rifenbark 376246967f dev-manual: Edits to "Providing License Text" section.
(From yocto-docs rev: 990d2a3ff9b837dcc4ddef2627a6ad534dbe6faf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:19 +01:00
Scott Rifenbark 4cf864248b dev-manual: Edits to "Providing the Source Code" section.
(From yocto-docs rev: 28dd64043d95dacf942076c2070751d6f6fcd387)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:19 +01:00
Scott Rifenbark 4c00602eb5 dev-manual: Edits to "Maintaining Open Source License Compliance During Your Product's Lifecycle" section.
(From yocto-docs rev: 3900ad2fbee0c343608d422dd1f77bc61c61f4c2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:19 +01:00
Scott Rifenbark 13dcc7835f dev-manual: Edits to "Online Mode" section.
(From yocto-docs rev: 1d60e57cbb98b988253989b15f294ba9a8e60630)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:19 +01:00
Scott Rifenbark f4e04abc78 dev-manual: Edits to "Using OProfileUI" section.
(From yocto-docs rev: 0286eed7d446995d07e576a7369280893f64358c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark 0bef07d6ef dev-manual: Edits to "Profiling with OProfile" section.
(From yocto-docs rev: 4530c0580667e54fdcc84aa4eb2d5e73ab23fca6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark de72fa2451 dev-manual: Edits to "Create the GDB Initialization File and Point to Your Root filesystem" section.
(From yocto-docs rev: 82098948ea76c3d30c34424a72c0d8be49bcc60b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark 913a9eebfc dev-manual: Edits to "Build the Cross-GDB Package" section.
(From yocto-docs rev: be2b0a26d07164c44442cc80fb1022564844b7c8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark bc16410c85 dev-manual: Changed section title to be parallel.
(From yocto-docs rev: 2202eab24dba3fae86518c516ee4e94e7697156b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark b24987da9d dev-manual: Edits to "Launch GDB on the Host Computer" section.
(From yocto-docs rev: 12a28e6f9994a345a8b922bdb09a67e2c904f264)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark 229ed0ab15 dev-manual: Edits to "Launching Gdbserver on the Target" section.
(From yocto-docs rev: 80c997528a2f6a72a392943ae15f4421c1377915)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark c566d3c5dc dev-manual: Edits to "Set Up the Cross-Development Debugging Environment" section.
(From yocto-docs rev: 1dd89a38de05fff8f1d39773109ba2a8b377d24b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark d2ebf82fe7 dev-manual: Edits to "Debugging With the Gnu Project Debugger (GDB) Remotely" section.
(From yocto-docs rev: 7946fc90e83f7b40752619d408325e9c76071b5a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark e9d7fa38d7 dev-manual: Edits to "Post-Installation Scripts" section.
(From yocto-docs rev: 19c951039faef92e22942f9641dabe3cbb55ac2c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark c7e81cc909 dev-manual: Edits to "Creating a Read-Only Root Filesystem" section.
(From yocto-docs rev: 01767752d8481213a33d3ed3bbb1ac648cd5f613)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:18 +01:00
Scott Rifenbark eacedc09de dev-manual: Edits to "Excluding Recipes From the Build" section.
(From yocto-docs rev: 926a855e4ebf88697ea2ecfe75aca4c402fdb4d4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:17 +01:00
Scott Rifenbark 2cb80f28a7 dev-manual: Removed a couple of links to variables.
(From yocto-docs rev: d7b2fc7e503498beba6dae043a7c9c66bccc5a31)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:17 +01:00