Completed draft of the new devtool material. This commit affects
some linking and figures across the YP doc set.
* Added the build-workspace-directory.png file to both the
dev-manual and the mega-manual.
* Updated the Makefile to include the new figure in the TARFILE
for dev-manual and mega-manual.
* Re-did the section organization to pull the quilt and finding
source file out of the "Modifying Source Files" section.
(From yocto-docs rev: 4585b9fbb1636ae3c65e2e3ad2d1d6baca636e59)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This start to the script is not really necessary and is in fact
the rare case. I have removed two occurrences of it in the
"Post-Installation Scripts" section where it was used in code
as the best form to create a script.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: f7c1a1e135e8a9d76005bb6ae7b9cc2810f0af90)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on "Handling a Package Name Alias" was confusing and
wrong. We decided to eliminate it. The section was removed from
the dev-manual. The corresponding variable DISTRO_PN_ALIAS
remains for now but without the cross-reference link to the
now missing section.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 9938cdcc8488baffa4252288bf45243055e76fed)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scrubbed out the occurrences of eglibc and replaced them with
glibc.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 868ceda79b1c738349e512e523c850b24f9232ca)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example was out of date. Updated accordingly.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b95535fca149abbbe4fee7e74ebc13d2bb376c27)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated some text to indicate that you should put patch files
in $BP, $BPN, or "files." Also, added more on how the patch
files suffix is (i.e. accounting for compressed suffix names
like diff.bz).
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: d9e23da24e9d86ec5e2b9d4067667478f3e56ba1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Patch files can end with compressed suffixes such as
diff.gz and patch.bz2.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 69993710d1466dddc804c33c1d76f46d0982d28f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Fetching Code" section, some loose description of how the
build system reacts to the two checksums in a recipe existed.
Robert asked some questions about how the behavior would be if
just a single, correct checksum existed and if the two existed but
only one proved correct. Turns out, if you supply a single one then
the build will not throw an error or warning. If you supply two
but one is incorrect, then the build will throw an error or
warning. I updated the text to be technically correct without
going into huge details.
(From yocto-docs rev: f49a744821d9326314803d5003158bd402e74e0d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor edits to the original patch. These edits were caught by
Robert P. J. Day.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b50a2e44eccd50166351611f17c643cbbc60f8b8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This patch was modified to fit in with the style of the book.
(From yocto-docs rev: 7c6c7ac573f92bfc844977e0d7a97ca4aac9bc70)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Bob Cochran pointed out that the skeleton recipe shown in the
example is not really what is created by newbb.vim. I updated the
example to match.
(From yocto-docs rev: 2dfa712522aec5204b9e739b6060109090280011)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section was a bit confusing on the use of "_prepend" as associated
with the FILESEXTRAPATHS statement. Especially in the final note
where it indicated you don't need "_prepend" if your append file
is not adding any new files. I updated the note to be more specific.
Another small change I made was to replace the Crown Bay BSP referenced
in the section with the Emenlow BSP, which has a longer life span than
CB.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 35bdc8031bc4ecf1ea321b0cafade97eeaa56513)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Customizing Images Using Custom IMAGE_FEATURES
and EXTRA_IMAGE_FEATURES" needed a bit more clarification on
the image features. The text pretty much passed off image
features as all mapping into package groups, which is not true.
Some, like "debug-tweaks for example, are more like general
configurations. I updated the section accordingly.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 7dd55ff0bd6f7923e22695ed7323df5cfe17d1d4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
* 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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
--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>
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>
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>