Commit Graph

1125 Commits

Author SHA1 Message Date
Scott Rifenbark
5992839b92 documentation: dev-manual - Buzilla components updated to six.
(From yocto-docs rev: 28480c246f0346d16424837d6be5d45e084e15c3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:30 +01:00
Scott Rifenbark
d399b589b2 documentation: dev-manual - better wording.
For obvious reasons I changed this one :)

(From yocto-docs rev: 5f3203292f46bea799321e4520668252a46fb599)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:29 +01:00
Scott Rifenbark
12ba89a88a documentation: dev-manual - Added link to pull scripts.
(From yocto-docs rev: 87fe511d4114295f8d67705c03ac11983f51cf7a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:29 +01:00
Scott Rifenbark
332e696958 documenation: dev-manual - added link to section on patching.
(From yocto-docs rev: 6316ef2aa8947d64fb262824b9f57df0e3a8e1c3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:29 +01:00
Scott Rifenbark
07925515ac documentation: dev-manual - better terminology.
(From yocto-docs rev: 06f1556d10c75134e53ade7bab407623f00b6a87)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:29 +01:00
Scott Rifenbark
6bf96aa1f9 documenation: dev-manual - formatting fix.
(From yocto-docs rev: 24e653c02278d7a3d935104296f54cf9fff9ce12)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:29 +01:00
Scott Rifenbark
8606f28cb4 documenation: dev-manual - clarifies local branch.
(From yocto-docs rev: fff80ac6e0a7092f19a268694f974ff45fb0fe8b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:29 +01:00
Scott Rifenbark
78aedfa4d4 documentation: dev-manual - grammar fix.
(From yocto-docs rev: eecdc407ae10a9c4146d79735e2e3fce7a031083)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:29 +01:00
Scott Rifenbark
a1fc37eabc documenation: dev-manual - updated the key tags example list.
(From yocto-docs rev: 8bdbe16e97be04482d3b06c9cf63bdef6ab49d5a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:29 +01:00
Scott Rifenbark
5bd37e57e1 documentation: dev-manual - Better wording for repo setup
I improved the wording such that it is not tied to a
x.x type release.  It is more generic here and will survive
better under future releases.

(From yocto-docs rev: 2bd644db7fef71cd2f07f6d3dcbd2ba60b83df08)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:28 +01:00
Scott Rifenbark
e25d32bd2f documentation: dev-manual - updated string of example branches.
(From yocto-docs rev: 79171c5c3c805178971ac099471d466e08968bbf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:28 +01:00
Scott Rifenbark
a206035698 documenation: dev-manual - Added "the" in front of YP use.
(From yocto-docs rev: 0bb38edb5a1b855322da2afe2af57d627a573c51)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:28 +01:00
Scott Rifenbark
2977ae4021 documentation: dev-manual - grammar fix.
(From yocto-docs rev: 0c6804e0c9c3721964f5780f6ce6d56ec813fd47)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:28 +01:00
Scott Rifenbark
52780ddb3e documentation: dev-manual - grammar fix.
(From yocto-docs rev: 8611504763fe3d1e8fb95ceb06416e78203741b8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:28 +01:00
Scott Rifenbark
ee198802a3 documentation: dev-manual - First re-write of "Package" term.
(From yocto-docs rev: 735f6b10710f060541de88c9164c9cc1e605d436)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:28 +01:00
Scott Rifenbark
0101e9edf4 documentation: dev-manual - Added QEMU for image target.
(From yocto-docs rev: 6dceb27dd5687e1a6a9ae3ad8decccbaa211376a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:28 +01:00
Scott Rifenbark
33547c2f0c documentation: dev-manual - grammar fix.
(From yocto-docs rev: a601b39d93d036a0e54f5e4f0b8d0bb052c5ef98)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:27 +01:00
Scott Rifenbark
655264abcf documentation: dev-manual - Fixed buildbot target heading.
(From yocto-docs rev: dc8949b3493b16d3a8ba83aad0ec756c53fcd1cf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:27 +01:00
Scott Rifenbark
0824517235 documentation: dev-manual - updated meta-intel repo example.
Added a line to cd to the poky directory so the example makes
sure the meta-intel directory is created in poky as it states.

(From yocto-docs rev: fdeff0fc2c61c521eaf9d3c48429792f1559c2a4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:27 +01:00
Scott Rifenbark
b7eb759920 documentation: dev-manual - formatting change.
(From yocto-docs rev: ff04bcaaae1a4f9a6e7b97c502fce9cde579c624)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:27 +01:00
Scott Rifenbark
a8ceece7d6 documentation: dev-manual - Update poky-extras example
Updated so that the repo poky-extras is for sure created inside
the poky repository.

(From yocto-docs rev: b01ea76ded2ade66f2cb19b37d9e9d8d5d2e96c9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:27 +01:00
Scott Rifenbark
f38b88a66c documentation: dev-manual - changed 3.2 to 3.4 for kernel support
(From yocto-docs rev: 6305dc7b4cbeae7f5725a2c2bc003b361460cfdf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:27 +01:00
Scott Rifenbark
25fb8ec27d documentation: dev-manual - corrected heading for yocto linux kernel.
(From yocto-docs rev: a929747d076d0ce5d7401c95eaebc4800ed7cd4b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:27 +01:00
Scott Rifenbark
dce39b7494 documentation: dev-manual - Added reference to supported distros.
(From yocto-docs rev: 1e9ed539913e0c23bb9d6b36e992a3a6e7a91963)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:27 +01:00
Scott Rifenbark
5473c28ac8 documentation: dev-manual - Defines QEMU acronym.
(From yocto-docs rev: 665b9476a915031c30ada0f1d5cf80270486a404)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:26 +01:00
Scott Rifenbark
2b8d3c2db9 documentation: dev-manual - Fixed broken release notes link.
(From yocto-docs rev: af8f343cf62a0fabd1ef2fabc654817487cab6aa)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:26 +01:00
Scott Rifenbark
76dd4dd7b4 documentation: dev-manual - minor edits to manual limitations
changed the example of what the manual does not provide to
be more appropriate.

(From yocto-docs rev: c4e7712cfd2e13b42f7322ffed6a1f84116df963)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-01 23:30:26 +01:00
Scott Rifenbark
db70697baa documentation: dev-manual - changed to directory for BSP example.
Section A.5.2.3 "Changing recipes-kernel" indicated that the user
needed to look in poky/meta-yocto/recipes-kernel/linux to find
the linux-yocto_3.2.bbappend file to locate correct SRCREV
values.  With 3.1, the team split out kernel and BSP stuff
even further by creating a poky/meta-yocto-bsp directory.
The example needs to reference that directory instead.

(From yocto-docs rev: 6e9b0ceb5ad24b1be8399bf5a0a83fdc30129f82)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-28 17:54:27 +01:00
Scott Rifenbark
9bc3b44866 documentation/dev-manual/dev-manual-common-tasks.xml: external SCM Update
Updated the section "Using an External SCM."  This section was
written so that PN was refering to a package instead of correctly
refering to the recipe.

(From yocto-docs rev: 2bf44cf78bef08d2dd4d9e596100900913777d60)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-24 16:36:09 +01:00
Scott Rifenbark
c4a923bcb0 documentation: Toolchain corrections from tarball to .sh file
For 1.3 there is not longer a toolchain tarball.  Instead, there
is a wrapper script that lets you install the tarball.  This
fundamental usage model change caused several ripples throughout
the documentation set.  I have changed wordings and examples
to reflect the new paradigm.

(From yocto-docs rev: afb2069daa91e04c0f78ba425a6b184cb820d888)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:52 +01:00
Scott Rifenbark
4c90692716 documentation/dev-manual/dev-manual-model.xml: updates to project creation
The steps for creating a project in Eclipse vary a bit between Juno
and Indigo.  These changes reflect that.

(From yocto-docs rev: a020ecde8ed02a29f67498ef1511261d2054f784)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:52 +01:00
Scott Rifenbark
7adb367e74 documentation/dev-manual/dev-manual-model.xml: Updates to plug-in install
Edits to test out the lastes version of installing the Yocto Eclipse
plug-in from the latest source.  Small changes to be more complete
on the step-by-step process with regard to being in the right
branch.  Also, inserted 1.3_beta as the version.  This will change
later.

(From yocto-docs rev: 1326916a7d03bdbb0613e6e26a4089b3bd87d204)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:51 +01:00
Scott Rifenbark
fa2da885af documentation/dev-manual/dev-manual-bsp-appendix.xml: Fix repo example
I fixed the repo example so that the -b option is right after the
git checkout command and so that the "origin/" string is part of the
example.

(From yocto-docs rev: ba7ed26cf308a69e1ec8cfb0072dd10742af4ac5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:50 +01:00
Paul Eggleton
b39457ccc6 documentation/dev-manual/dev-manual-common-tasks.xml: package group changes
Task has been renamed to package group, and there are some minor changes
in how package group recipes should be constructed - in particular the
inherit of packagegroup.bbclass is now highly recommended as it will set
appropriate defaults and automatically add complementary -dev and -dbg
packages.

In addition to Paul's patch, I added a couple <filename>/</filename>
tags around some switch names to be consistent with manual
formatting.

(From yocto-docs rev: 598d18507ace2054f8c8bb5f496557c98f066b5a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:46 +01:00
Paul Eggleton
a3de958c63 documentation: remove references to task bbappend
The meta-intel BSPs and yocto-bsp tool no longer use a bbappend of
task-core-tools-profile to add systemtap, so these sections should be
removed.

(From yocto-docs rev: cdc12163dd95f0a78cc0f35c03b5eb3d7b1476e3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:45 +01:00
Scott Rifenbark
64b9137b43 documentation: Fixed links to BitBake User Manual
Robert P. J. Day pointed out a link in the development manual that
was for the BitBake User Manual.  The link resolved to an old,
non-maintained version of BitBake documentation.  According to
Richard Purdie, the BitBake docs referenced should be the ones
that ship in the bitbake/doc/manual directory of poky.  The
YP docs had been using a variable named BITBAKE_DOCS_URL that
also resolved to the antiquated user manual site.  Consequently,
there were many links that needed fixed across both the YP
Development Manual and the YP Reference Manual.  Each of these
references now points in general to the bitbake/doc/manual
directory in poky for more information.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:45 +01:00
Scott Rifenbark
3fa4a6a146 documentation/dev-manual/dev-manual-common-tasks.xml: note on readme
Added a note in the "Creating Layers" section noting that to be
Yocto Project compliant, a layer must contain a README file.  This
change was prompted by a discussion over the fact between Robert
P. J. Day and Mark Hatle.

(From yocto-docs rev: 2e073763a81125699a2d962031ca29ca64c81595)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:45 +01:00
Scott Rifenbark
0278e3b760 documentation/dev-manual/dev-manual-newbie.xml: Edits to email patch section
I updated the section that describes how to submit a patch through
email while not using the scripts that send patches and request
pulls.

(From yocto-docs rev: 9167b89289134d8d16610cc527d0d71713c0641b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:55:01 +01:00
Scott Rifenbark
d192e6f2ad documentation: Section change for using email to submit patch
Changed the title and a single reference from the Kernel manual
to a title more representative of how these patches are sent -
not using scripts.

(From yocto-docs rev: ff908c34fae88eab9724891a008142a834f34081)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:55:00 +01:00
Scott Rifenbark
2595a2b65e documentation/dev-manual/dev-manual-newbie.xml: Updates to submitting patches
I added text to indicate that using the two scripts for generating
patches and requesting pulls is the preferred method to send
a patch.

(From yocto-docs rev: d6f036a91074dd00c51fe0f937224182fc801b3b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:55:00 +01:00
Scott Rifenbark
6b357655fe documentation: Section Heading change for pushing commits
Changed the section heading for the part describing how to
push changes upstream via the poky scripts.  Also had to
change one cross-reference to the section in the kernel
manual.

(From yocto-docs rev: be7712aba044238e8781cdf869c5d14e77eb09a2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:55:00 +01:00
Scott Rifenbark
0c69e7be91 documentation/dev-manual/dev-manual-kernel-appendix.xml: Fix PARALLEL_MAKE
Every place in the YP documentation suggests setting BB_NUMBER_THREADS
and PARALLEL_MAKE to twice the number of cores as the host machine.
This fixes a single instance in the YP dev manual where it was
suggested that PARELLEL_MAKE be set at 1.5x times the number of
cores.

(From yocto-docs rev: b6b820371cbe43e39425156c72c45df283fdf7d1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:59 +01:00
Scott Rifenbark
d4a65ef1df documentation: Title changes
Removed "The" from all the titles of the books.  This makes it easier
to reference to them and easier for the automated processing of the
mega-manual.

(From yocto-docs rev: af566d6d007cff642648698ea487a6eeaa8cc930)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:59 +01:00
Scott Rifenbark
55cd232c06 documentation/dev-manual/dev-manual-model.xml: Fixed mis-named guide
I fixed a reference to a manual that should have had "Guide" and
not "Manual"

(From yocto-docs rev: a51de96fe0cd78cb379e6758d7e357c91daa2791)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:58 +01:00
Scott Rifenbark
9df4aa6d8c documentation: Manual reference fixes for mega-manual processing
I fixed several occurences of cross-references to whole manuals where
the formatting was split in the <ulink> statement.  The <ulink> tag
and the manual title must be on one DocBook line in order for the
sed scripts to correctly process the links when the mega-manual is
created.

(From yocto-docs rev: 0dee12d518c892f59c0446e1c7b5d0f71b6ee22b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:58 +01:00
Scott Rifenbark
923563477e documentation/dev-manual: Title Fixes
Fixed several references to books.  There should be no books referenced
using "The" at the beginning of the manual title.  These need to be
"the" in order for correct mega-manual link processing with the
sed script.

(From yocto-docs rev: 76753216c7138d55f7b6f9167d678245ab3134e7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:58 +01:00
Scott Rifenbark
03fd402081 documentation: Fixes to note for mega-manual processing
the notes that say "Due to production processes..." at the start of
each manual contain links to manuals.  the links needed to be formatted
such that the entire <ulink> code and manual name appeared on the same
line so that the sed script can effectively remove the link in the
resulting mega-manual.

(From yocto-docs rev: 0a41971c331ad1961e6ee1e067b59c36c9f048f6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:57 +01:00
Scott Rifenbark
2c6f72d01a documentation/dev-manual/dev-manual.xml: fixed so mega-manual works
I moved "the" outside of the generated HTML link so that the sed
script will process this part of the manual correctly for the
HTML mega-manual.

(From yocto-docs rev: 3bdf7c7dc4478f2a435cbc84a8a815daf7130660)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:57 +01:00
Scott Rifenbark
b84383a7e1 documentation: Fixed references to the YP Dev Manual
The references to the YP Development Manual were inconsistant.
These references were fixed.

(From yocto-docs rev: f4ded0b965fcbce7b500ca21886ee9b755c38383)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:56 +01:00
Scott Rifenbark
b3ac19b1bf documentation: fixed Quick Start references
The way I refered to the YP Quick Start was inconsistant.
I have made edits to remove these.

(From yocto-docs rev: d9487c60db23861e8a9dd2c81ac46d4960abd462)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:56 +01:00