Removed an out-dated note near the bottom regarding a distro
we don't support
(From yocto-docs rev: 4211914f16d4ab01182633785068b56a258c0d04)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We did not have time to do this for 1.8. So, I restored the look
of the glossary pre-images. I did leave commented code in both
the glossary chapter and the style sheet for later.
(From yocto-docs rev: 9f1472b7d4cd86545e7927b0f693aafc88ae2791)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7535]
Removed this from two places.
(From yocto-docs rev: d169ce99610745e8c1b4b53d898f526e557af665)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the note that tells the user they have to initialize the
virtual environment every time before starting Toaster to the
correct location. I had it misplaced.
(From yocto-docs rev: 65258338e1ffb92ded573ea3b447b424b5f5fa97)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some suggestions from Paul Eggleton to downplay the role
of this variable. It is basically ignored now in all parts of the
manual set except for the descriptions of the variable itself
and the BBLAYERS variable. I added some text reinforcing the fact
that BBLAYERS_NON_REMOVABLE is ignored by the build system and only
matters if you are using Hob.
(From yocto-docs rev: 98112751aaec6e25de48d9e3ee56592be3f53a07)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied review edits from Paul Eggleton.
(From yocto-docs rev: 4815556b6c9f45ce230afede7cb3b2aadf0bef1c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied review comments from Paul Eggleton.
(From yocto-docs rev: 403c9ae5443eaf2a115e2224f07ee19f98c8139d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I could not get the embedded vids working very well. So we
defaulted to just linking to the Youtube locations directly.
(From yocto-docs rev: 95bef674ec04eec94f568ab00b94f7174d456011)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The user must re-initialize the virtual environment (if installed)
prior to starting Toaster each time.
(From yocto-docs rev: b0daa23784f17778f758b0572f90f9293a822812)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The docs are not building on CentOS and we think it is due to the
XSL templates being called for the Eclipse parts. I located all
the "current" templates and switched them out for "1.76.1" version
as are used by the mainstream doc builds.
(From yocto-docs rev: afbddde6524630433dfec973bbe886de32395bc8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Trevor wrote a nice paper (tutorial) on the use of devtool that I found
to be very helpful in developing the information for this new workflow.
I decided to publicly credit this effort with a small footnote near
the top of the section.
(From yocto-docs rev: 97d234f2d535f85e5a50ac4e7f0c0a79579cd004)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Paul Eggleton reviewed the section.
(From yocto-docs rev: 82d9750b4349b3c54f73118ec7d65f0bb96e3f7a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The figures I added are for the Toaster manual.
(From yocto-docs rev: fb9bb83e48afd2e7d24d68f0c167d8d64f5d25fd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the reference chapter in so it is included as part of the
mega-manual.
(From yocto-docs rev: 90a6ebabd0657d6dd7381a8c1fc7db5ea8b26a1f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the three Toaster Manual figures to the list of
mega-manual figures so they will be included in the tarball
generated for mega-manual.
(From yocto-docs rev: 2190bc43dfc20c0c0ef5da82c85570f9294e1788)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Edits to the "Customizing an Image Hostname" section from Ross.
Updated the last paragraph to not imply incorrect information.
Fixes [YOCTO #7417]
(From yocto-docs rev: 8997be297077ee0052a5afbe50b9864cdef14058)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7417]
New section to address how the user can change the devalt image
hostname written out to /etc/hostname.
(From yocto-docs rev: 4ac6bc05947e56106aafcc6f9aef93bd93293fba)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Schedule did not permit support for Luna to complete. So, I
backed out the half-complete changes to support this version of
Eclipse.
(From yocto-docs rev: 1ca893766047f30ffbb0c99e51e575ea1302e7bc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7460]
There was a single occurrence of specifically calling out that PR
needed to be manually incremented in the workflow section of the
manual. It was step 8 of the Quilt flow. I deleted this step.
Previous edits to the set have included extensive instruction on using
a PR Service, which is basically what replaces the need for manually
updating PR as it was in the past.
(From yocto-docs rev: d8db2175225be45cb3f2b4d11f8281c5b1f40ad4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replaced texinfo -> makeinfo in the list of essential packages for
OpenSUSE.
texinfo was in the essentials to only provide makeinfo utility.
/usr/bin/makeinfo is provided by makeinfo package on OpenSUSE distro, so
it's enough to install makeinfo to be able to build poky.
This change reduces number of packages installed on the host system as
installing texinfo causes installation of around 1500 texlive-*
packages and requires around 1Gb of additional disk space on OpenSUSE.
(From yocto-docs rev: dce793a2ac0a781ae074f3eb7ad34fbdb65dc3ea)
Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed out the example to use some bits from the meta-xilinx layer
instead of the emenlow layer.
Reported-by: Robert P. J. Day <crashcourse.ca>
(From yocto-docs rev: 477c62877f5882538176d0f9c8a10fc4cf878628)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example was ancient so I consulted Bruce Ashfield for a better
example and implemented it.
(From yocto-docs rev: e737f380ca5bb36c0095f11182cd3e3a93791e61)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The note alerts users to issues building QEMU when the build system
has the oss4-dev package installed.
Fixes [YOCTO #7382]
(From yocto-docs rev: 0f189ca7567e3e646808d5360fdb1499df8605c0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7386]
Apparently, copying HTML displayed commands that have a
double dash created through "‐‐" in the docbook source
causes some issues in the shell. I have scrubbed the manual set
to replace any "‐‐" strings with "--".
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: e88b813b71d7d6d8acd8a8638f2db71265145b64)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Tweak the manual to refer to the name of the kernel build directory as
it is listed precisely in linux-yocto.inc.
(From yocto-docs rev: f8c762e42a67bd84b733a5ae2512581af805a76b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Tweak a number of doc lines so that the KERNEL_FEATURES variable
refers directory to .scc files, and does not take advantage of
potentially confusing shortcuts.
(From yocto-docs rev: 6236fb098fc2d518f6f4f63e16b19a06a775d2d6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First edits to update this section to support the Luna version of
Eclipse. I weeded out Juno, which leaves Luna as the preferred
version and Kepler as a second version if they don't want to update
to Luna.
(From yocto-docs rev: 4f2dc237aa3498402cdf637ac2e85fdf0c3bf8a0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the support of Luna version of Eclipse, I had to create a new
variable named ECLIPSE_LUNA_URL and set it to
"&ECLIPSE_DL_URL;/releases/luna"
(From yocto-docs rev: 4c686fc8e52d608975c4fd9040fd83870419bcf0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fill out missing machines for the MACHINE variable.
(From yocto-docs rev: 2b8179cfb7e3a25d95c43f9160d284ebd5deefc7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Using Kernel Metadata in a Recipe" section, the example
called out "fri2" as an example BSP that shares the same KMACHINE.
This was true last release of meta-intel but is no longer true.
I used "emenlow" now as it seems to be like "fri2" was before
the "fido" release.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 65516ed8f31752288eeaaacc6279f808a3a8a8df)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Substituted a more correct build directory path in the
example by providing
"${WORKDIR}/linux-${PACKAGE_ARCH}-${LINUX_KERNEL_TYPE}-build"
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 818493d7ee5fc6c1750f20e5cea22a3816c8675c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added some changes based on input from a new user. Basically,
added a bit more explanation in a few spots and some suggestions
on where to read or go next after concluding the two basic
quick-use sections.
(From yocto-docs rev: 5381f1202957e171d16d97332b40e8d363828a20)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Modified the area from which the Eclipse Git repository is located.
This has changed.
(From yocto-docs rev: ec2bf4125877b28dae0681c8b578c7bebec5a5b6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This kernel is not supported and is ancient. Many of the examples
were referencing this kernel. I switched to use the 3.19 version.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ba04c4f11a02b4562994d5d79838cd2cf90efc7e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a small text issue where a hypen was needed. Also, provided
a real link to the YP LTSI page.
(From yocto-docs rev: aa8c06b79eef1855c3b5af4c8bfa47a96a86d332)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some edits to the areas where KBRANCH is discussed.
Clarified that setting it is not optional any longer.
(From yocto-docs rev: 4d0b2d92140d066048d9ff36453c7ea589eebe55)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is out. There were some references to deal with.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: fcdd5de04c722ebde2d3f236310c46a251cf1afc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed traces of the deprecated KBRANCH_DEFAULT variable.
(From yocto-docs rev: 8130f0db46be872cd857d8579323e4ad00da6380)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some small changes to clarify how to change the configuration.
(From yocto-docs rev: fce7c97abb69f15142dbadf90a90965a49ec3e0e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7358]
Added a new variable description.
(From yocto-docs rev: 42ff075319b346f22d2c604c0de249ac3039a992)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 198ce97a1158237056f035ade555ce04a6031c56)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 4d85a363602eeb8c5f52064af9ffa1a47e541470)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two areas affected by this change. I updated the KBRANCH and
PREFERRED_VERSION variables in the glossary. One change in the
KBRANCH area was getting rid of the deprecated Crown Bay example.
I substituted in the Emenlow BSP.
(From yocto-docs rev: d7ed727ab5828dc257361c558a86a298bc537748)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These kernels are unsupported for the 1.8 release. They will still
show up in the YP source repos but the recipes are removed from the
poky area. Updated all references appropriately.
(From yocto-docs rev: a9adc071409fd31dabc3affec12350c300312600)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Version 1.8 drops support of the 3.10 and 3.17 kernels. The
emenlow example was using the 3.10 kernel recipe as a showcase
and it also listed the recipe in the directory structure. I
removed it. Additionally, the yocto-bsp create command was
prompting for the user to accept the default 3.17 kernel. I changed
that to 3.19.
(From yocto-docs rev: 03bf66e961400b27b7e31d4a25776a11ce5719fd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the PNG file for the context to be the first item displayed
for a given glossary term. The PNG file must be negatively indented
though to look decent.
Fixes [YOCTO #5601]
These reformatting changes were needed because of brower incompatibilities
discovered with the existing solution for displaying these PNG files
with glossary terms.
(From yocto-docs rev: 06aeb6540c1343825369dd02006cb19e5a318d48)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the PNG file for the context to be the first item displayed
for a given glossary term. The PNG file must be negatively indented
though to look decent.
Fixes [YOCTO #5601]
These reformatting changes were needed because of brower incompatibilities
discovered with the existing solution for displaying these PNG files
with glossary terms.
(From yocto-docs rev: c84c4bc91b10e1443dc5aefc3a987a370d25432b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7306]
Some review updates to have better wording.
(From yocto-docs rev: 6f2d10c87128934958295111d10e038689fd94d3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7306]
Added an example for when the user tries to inherit the most recent
version of software through use of the SRCREV variable. When using
SRCREV = "${AUTOREV}" PV does not always get ${SRCPV}, which it need
in order to fetch the latest software. I added a clarifying example
to explain this situation.
This commit also has a small change to fix a broken link to
EXTERNAL_TOOLCHAIN. We do not documentat that variable so I removed
the link.
(From yocto-docs rev: 82f66a7193d0e40ffd65547223d4d9b10fdcf9bd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6901]
This is the 2nd review draft of the manual.
(From yocto-docs rev: 9f541e4421e0e74e59e3b3da1896b6c1254daf08)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4907]
I created a new section in the toolchain chapter of the adt-manual
called "optionally Using an External Toolchain". This provides
some fundamental information for the user that wants to use
an external toolchain. Additionally, it references Mentor
Graphics Sourcery toolchain as an example.
In the ref-manual, I updated the TCMODE variable description to
better integrate the MGC Sourcery toolchain as the overriding
example.
(From yocto-docs rev: 51e9c3b88f7e5a16da2aa101589b0f2612fff11d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The image feature 'debug-tweaks' has been fragmented into three
separate areas of functionality that deals with handling empty
passwords and post-installation logging. I updated the list of
image features appropriately and the description of 'debug-tweaks'
in the EXTRA_IMAGE_FEATURES variable.
Fixes [YOCTO #5344]
(From yocto-docs rev: ce0ab20472a75049298287cd05109f6e091b80bd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updates to the following:
BUILD_ARCH
SOURCE_MIRROR_FETCH
TARGET_PREFIX
SDK_PREFIX
SDK_SYS (I added this one new).
(From yocto-docs rev: ad5f9b56dc912783b415b30604456bd5071f9721)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5601]
Discovered that the solution I had to display a small PNG file
to indicate the context a variable is used in the build system
was not displaying properly in the ref-manual variable glossary
when using the Chrome browser. The solution was to adjust some
settings in the CSS file and place the image after the term.
This allowed me to dump the webkit stuff that I had inserted
into the CSS file styles to make it work in Mozilla, which
ended up not working in Chrome.
Additionally, I needed to update the 'define-generic.png' file to
have less white space on top as part of the figure. Note that
this commit adds the figure to Git for tracking as well.
(From yocto-docs rev: 59a1295aeb1c866f330634907ad28642a997cd63)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied a different example from Paul.
(From yocto-docs rev: b21ef6a792361eb0893ee17524794fba3bed885c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Small typo fix for STAGING_DIR_HOST. Some re-wordings for
TARGET_PREFIX.
(From yocto-docs rev: 919a13436de6ea150f685a50b6ecc8154b75da86)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did a significant re-write on this description as I had the
meaning pretty far off.
(From yocto-docs rev: 6bcc63ac83f0aeb3d3d06db33c7a8f010c737312)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-worded the way you say the date.
(From yocto-docs rev: 3c6b51fb474628954654f2f1290509a78a48a1fb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed the meaning up.
(From yocto-docs rev: 1b057475acd2bf33bb6fa3bd03e85a415697873f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added an example.
(From yocto-docs rev: 7a22c2941618f29ad89087c186ae2af6f0c07323)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed wording to be more accurate.
(From yocto-docs rev: 1acb7ce94a4f4b02cc50d1e098f04a77d9a53ab3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some review edits to these two variable descriptions.
(From yocto-docs rev: fb1eb903b9bcc8b0bb67e72c795a1dd602143589)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I removed the last paragraph example as it is not a good example.
Unfortunately, there is not a good example so I replaced it with
a minor suggestive work-around at the end of the first paragraph.
Also, used some <replaceable></replaceable> formatting for the
first paragraph.
(From yocto-docs rev: 6c3989fd4fe41a6434d70208d59747060e62a366)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6852]
I added a new FAQ entry to address situations where during a
native build, the build fails due to previously installed stuff
on the system from /usr/local/include and /opt. The entry
tries to cover "leakage" issues in general but calls out the
specific case involving libiconv and iconv.h.
(From yocto-docs rev: 2c09c7ee0970189953bfbbdcaac49a1ebe8482fe)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way the mega-manual used 'xinclude' to suck in the other
YP manuals was to suck in the root XML file. The problem with
this was that the root XML file for each subsequent book would
include front-matter information. The front-matter information
included an .authorgroup style, which caused the new mega-manual
title displayed at the very top to be also re-displayed with
a subsequent manual's title. These changes altered the strategy
for using 'xinclude' to pull in the various YP manuals. Rather
than pull in the root XML file for a given manual, individual
chapters are pulled in that comprise a given manual. A slight
side-effect is that chapter numbering is sequential from top to
bottom in the mega-manual, which I suppose is better as it is
being presented as an entire manual anyway.
(From yocto-docs rev: 61cc9f2f92900894ef09ff13e1e92ebe30a17be3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
the customization layer for some reason was referencing the
ref-style.css file instead of the mega-style.css. I changed this
over.
(From yocto-docs rev: f47e14c27cde0a436a9ffbf26ca425951eae5d4e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6901]
I removed some left over stuff from the intro that should not
have been in there.
(From yocto-docs rev: 91d1ee2b4433312e0f94e1ac99f8ec0e14ef6ac7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added logic to string search and fix links in the Toaster Manual
part of the mega-manual. This keeps the links correct for the
mega-manual.
(From yocto-docs rev: f93b5a187984949129db16b638935b678fd344a1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6901]
Added the toaster-title.png file to the mega-manual/figures
folder so the Toaster title would show up in the mega-manual.
Added lines so that the mega-manual would include the Toaster
manual file to the mega-manual.
(From yocto-docs rev: 5a4a67e4f140802da133b7bcb480c84b4a8edb63)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6901]
These are the second and third chapters of the Toaster Manual.
(From yocto-docs rev: 6ff4e3dfff391efdbb0f36dc6800bf115abcfc92)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6901]
Makes it so the boxes appear around the manual revision table.
(From yocto-docs rev: f3ee2bc1ef957a585d0f814b91451a8460dec8c1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added both chapters that follow the intro chapter to the root
file so they will build as part of the book.
Fixes [YOCTO #6901]
(From yocto-docs rev: 37967896f12471d34188cd532e00211ca665910b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes to the files that support building out and publishing
the Toaster User Manual:
* poky.ent - Added a new variable YOCTO_DOCS_TOAST_URL that can
be used in other manuals to link to sections with the Toaster
User Manual.
* Makefile - Added a section of code to build out the Toaster
User Manual. Currently, no eclipse support is added as I don't
think we want to cross into that development environment with
Toaster.
(From yocto-docs rev: 35ea6656265d61024d5db36a534a7250f783956a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For this commit, the manual only has a single "intro" file with
placeholder text only. Graphic for title page is in place,
stylesheet is in place, all files needed for a successful, initial
build of the new manual.
(From yocto-docs rev: 99416caa943fe6af13292b18bda53522ce3576d6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6912]
The example used to make sure builders use the same sstate
signatures regardless if they use icecc or not was incorrect.
I updated the INHERIT_DISTRO line of the example to use the
append part in the name so it appends the icecc as suggested
by the bug submitter.
Reported-by: Peter Bergin <petan679@gmail.com>
(From yocto-docs rev: 1f6b2f152202ab6e0be3026af3275f67bdb40d16)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7256]
In the "Serial Console Connection" section there was a link to
TEST_POWERCONTROL_CMD when it should have been to the
TEST_SERIALCONTROL_CMD variable.
(From yocto-docs rev: 9ec64c86bd4171a017898daa332d2a98fea0358a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The description for "tc" was described as "the called text context..."
rather than "the called test context...". Updated the description.
Fixes [YOCTO #7269]
(From yocto-docs rev: 0da4437c26225ce0302f10f7ba3c012f1f990c74)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These edits help place the two sections within the new organization
that basically splits out the devtool and quilt methods as ways
of modifying your source code.
(From yocto-docs rev: 1dc2e8783d9774bb98a30e06d114f1c9bfb85b71)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using the 1.76.1 version in all the customization layers so
the manual revision tables will build with boxes.
(From yocto-docs rev: 85a31ef53a59d17bed23ebf57a14db507eb21338)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Put in proper front matter for the mega-manual. This effectively
creates a real title for the manual as well as a brief abstract
that explains why this behemoth exists.
(From yocto-docs rev: 26c78f0b00762846a839fbfc9ba969b7aa5d5b58)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Mark Hatle reviewed the section and I updated some things based
off his input. A rewrite to the "Makefile-Based Projects" section
to get it technically correct. Also, removed all SDKROOT
documentation from both the adt-manual and ref-manual.
Fixes [YOCTO #7133]
(From yocto-docs rev: dd785777834611d94868a3774f2eb21ffc081b1a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7133]
Edits to add more clarification for use and role of the
cross-toolchain environment variables established when a user
runs the cross-toolchain environment setup script.
(From yocto-docs rev: 2c3fa3a838a3a8970cd112935e903c96552ed06b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the ADKROOT, GDB, CROSS_COMPILE, and CONFIGURE_FLAGS
variables to the glossary. Also added appropriate cross-reference
links from the adt-manual to those new variables.
(From yocto-docs rev: 812367e3b915b99d900b7934c4d5d409f393e814)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7133] partially
At the end of the section that first mentions running the
environment setup script for the cross-toolchain, I added a list
of environment variables that are defined as a result of running
the script.
(From yocto-docs rev: f1b66a09676d1b5c055e7ae7e7cc9a7f45cb9b67)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The note in the "Getting the ADT Installer Tarball" section has
a note that warns the user to be sure they have local.conf
properly configured before baking out the adt-installer. I
provided a linked cross-reference into the section of the
ref-manual that takes a closer look at user configuration.
(From yocto-docs rev: d13c044b65543a2f15fbda0266d2e30a14cfd19f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The intro to the "installing the ADT and Toolchains" section notes
that the user must source the cross-toolchain environment setup
script. I added a clause stating that this establishes environment
variables.
Fixes [YOCTO #7133] partially.
(From yocto-docs rev: e9777012d935ced8fd82209543569aaa70ab1832)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "User-Space Tools" section incorrectly stated that user-space
tools are provided as part of the distribution. The Yocto
Project is not a distribution. So I changed to say that they
are provided as part of the Yocto Project.
(From yocto-docs rev: 03dd97b68a1900959aa51ad6a17547822e8392fc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added text to note how this term is used, what makes up the
OE BS, and how the term "build system" is used in general.
(From yocto-docs rev: 2af0a59a84fd1cf6d23db29f470cb5644f962746)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The list of terms had a "build system" term that basically
described the OpenEmbedded build system. I dumped this entry
in favor of "OpenEmbedded build system." I updated the term's
description to cover the generic term "build system" for no
confusion.
(From yocto-docs rev: 0ada8348a2ace6ce99e640d1c1f21812188151d5)
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>
Found a typo in this list. The "qemux86-64" should be "qemux86_64".
(From yocto-docs rev: 32f62f51c1574f3a479c12b67aeba7ebcb743a02)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the description for the SOURCE_MIRROR_FETCH variable
so that it actually made sense. The [doc] string was also
updated.
Found a typo elsewhere that was fixed when I spell-checked the
file.
(From yocto-docs rev: 609f09231815f80ea3fd800e0b5d9a4fbad110cc)
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>
Scrubbed the eglibc from the buildhistory directory and
also replaced with an i586 example.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: c7469f1a857f278e1adac9012d99802195e36849)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the references to eglibc and replaced them with glibc.
This involved updating the example buildhistory output with
current examples as well
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b44cce9817191d616d51d6b1d067efc730423198)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7133]
This goes toward fixing the bug but not completing it. I have
added the following variables to the variable glossary:
SDKTARGETSYSROOT
PKG_CONFIG_PATH
CC
CXX
CPP
AS
LD
TARGET_PREFIX
AR
STRIP
OBJCOPY
OBJDUMP
RANLIB
NM
(From yocto-docs rev: c9d9e422684dad7cdc81db309235d0d1751ac88a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is a Python script that a developer can run to create a .patch
file that when submitted to oe-core will update the documentation.conf
file. The update will bring the [doc] file variable descriptions
in line with what is in the ref-manual variables file.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: f9dca76a8d9be3dcdbde9229beb03f0ba3701485)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This option to the PACKAGE_CLASSES variable is broken and not
supported. I added several warnings saying such. We opted to
keep the documentation rather than eliminating it completely to
prevent questions should someone find the code and wonder why
it is not documented.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 1acf3da2034c4c3f74acee1ccb375f0450ed90a0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way the old manual set had worded the use of the
BB_NUMBER_THREADS, PARALLEL_MAKE, and BB_NUMBER_PARSE_THREADS
had become depricated. It suggested a lot of user intervention
to get these variables set to have the build system utilize
optimal parallelism. The change a while back to the build system
where the variables are set to the number of build host cores
now makes the variables automatically be set to their best
values. I have gone through the manual set and changed wordings
appropriately to reflect this.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 3a27b1792c92a2f22173315e2732f672cdad2c78)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Speeding Up the Build" section presents a list of items the
user can consider when they want to tweak the build speed. One of
the items is the three variables BB_NUMBER_THREADS, BB_NUMBER_PARSE_THREADS,
and PARALLEL_MAKE. It was noted that the system figures out
the optimal settings for these now and it is pretty useless to
override the settings. However, the introducing sentence to the
list is still valid due to other considerations that go beyond these
three variables. So, to update the text, I have re-emphasized the
role of these three variables for quickening the build time.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 84610550cef66d0aa7478bcf95ad97b081709b2f)
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>
Placed a reference for more information on the variable into the
section of the dev-manual that explains how to choose a device
manager.
(From yocto-docs rev: 3f9b1329fe4794af03d673323d11558e85d9b097)
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>
I had it out of order alphabetically.
(From yocto-docs rev: d766cc58dfe2581599815b76729c742034c910ef)
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>
When you "make" the mega-manual, there were four tags across the
various manuals where the same string "id='intro'" occurred. This
causes warnings during the make process. I updated the strings to
be unique. There are no cross-references to these so no collateral
issues were caused.
(From yocto-docs rev: d0e770e0ad797031a75e2373a41723408b4b051c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the following variables based on slight review changes
from Paul Eggleton:
EXTRA_AUTORECONF - changed autoconf class to autotools
KERNEL_IMAGE_MAXSIZE - Wording tweak
AUTO_LIBNAME_PKGS - Wording tweak
DEBIANNAME - [doc] string updated
TCLIBCAPPEND - Second clarifying sentence in first para added
PACKAGEGROUP_DISABLE_COMPLEMENTARY - [doc] string updated
(From yocto-docs rev: ff5c765ffab1cdf6fc8a007cebdf7114432f65ef)
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 note provides a bit of a warning or tip regarding naming
BSP layers. The letter of the law dictates that you don't
need to prepend a BSP layer name with the string "meta-".
However, scripts exist in OE where the naming convention is
assumed.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 0375349fdd3cd5ff8a54db8124d5cdc02133ff12)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7029]
I was missing the "sysroots" part of the path. I added this
to the pathname.
(From yocto-docs rev: 077efc8063ed01ef4067f7e71912dd52c1f6a4a6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Crown Bay is short on life so I swapped it out for the eMenlow.
(From yocto-docs rev: 6d5394c12a374463cb1d5215af88178b63a5b8c0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The yocto-bsp and yocto-kernel tool output for the examples
were updated to be current.
(From yocto-docs rev: a05b1df35c7518027b1eb73f9ea2b6a3d00dca43)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added descriptions for the following variables:
EXTRA_AUTORECONF
KERNEL_IMAGE_MAXSIZE
UPDATERCPN
AUTO_LIBNAME_PKGS
DEBIANNAME
DEBIAN_NOAUTONAME
TCLIBCAPPEND
PACKAGEGROUP_DISABLE_COMPLEMENTARY
CLEANBROKEN
DISTRO_CODENAME
BASE_WORKDIR
DISTRO_FEATURES_DEFAULT
DISTRO_FEATURES_LIBC
Part of adding new variables is checking to see if a previously
undocumented variable is used elsewhere in the manual. One
occurrence was spotted and turned into a link for this list.
(From yocto-docs rev: bb75387b7aa4fcb0b594d300772952d81a651644)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
By default, making a file will not include the PDF version of the
manual. Some manuals you can't do a PDF version anyway (i.e.
yocto-project-qs and mega-manual). The PDF versions do not need
to be part of the mainstream make process. If someone wants these
they can take the extra step of doing 'make pdf DOC=<manual>'.
(From yocto-docs rev: 16f605350adb1b252b94e921faf282d0634cefb6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Covering CentOs to 6.x and the debian stuff to 7.x
(From yocto-docs rev: fa7d6f138506b90330c52c1dbe3a56e40a34a97e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
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>
The way the explanation for adding the BSP-specific files did
not take into account for layers that might support multiple
machines versus a layer not supporting multiple machines. I added
more explanation that covers both scenarios to be clear.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 3f00f0bb830665f8711c68aa6110b8399e867345)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Crown Bay BSP now only supports VESA graphics. Because of
this, some of the examples in several areas of the BSP hierarchy
were wrong. Changed accordingly.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b61f013a086a9135a86eedf2884fd1b07f798165)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the choices and version numbers of the "yocto-bsp" section
of the BSP guide to match the current development utilities.
(From yocto-docs rev: 0f8472ffa2bc3ae762587c4e2345a4d9850608ed)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The directory structure no longer seems to support two flavors
of the BSP: one with EMGD and the "noemgd." Only the "noemgd"
remains. I have updated some of the examples here to reflect
the current directory structure and sample configuration code
for the BSP.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 64fc4a7a6d69eb99dcd3d8c5e388810e7052ad75)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* small number of typos fixed.
* documentation corrected in a couple places.
* for most part, reduce line lengths to 80 for printing.
I was going to fix just a couple typos, then figured that while i was
there, might as well do some cleanup, mostly in the area of reducing
line lengths to 80 where possible for printing. feel free to comment
on any other possible aesthetic fixes, i can add them and resubmit.
(From yocto-docs rev: cfe4c061d8691e128933b81693aa42c809ef5486)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Update entry for IMAGE_BOOT_FILES with information on glob
patterns.
(From yocto-docs rev: ad3fc0061e3f4dc3ecc6b0a101685c301c5690e9)
Signed-off-by: Maciej Borzecki <maciej.borzecki@open-rnd.pl>
Signed-off-by: Maciek Borzecki <maciek.borzecki@gmail.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5463]
Updated the notes in the TUNE_ASARGS, TUNE_CCARGS, and
TUNE_LDARGS to indicate that the BSPs select the tune and then
selected tun affects the tun variables themselves.
Also combined the TUNE_PKGARCH and the TUNE_PKGARCH_tune variable.
We really don't need the TUNE_PKGARCH_tune variable as it is simply
the TUNE_PKGARCH variable with the override.
(From yocto-docs rev: dabc624272a9bb4cf5e62dee664ba729a9887208)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This reverts commit 914c482bd89071ab34b3381e3bd8065f871cc047.
I had to revert this change because it broke the footnote behavior.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Creation of a PDF version of the YP Quick Start is not supported.
The <mediaobject></mediaobject> code appears in the manual for
that purpose only. It is ignored during HTML generation. Thus,
I have removed it from the file. The image is actually displayed
through the <authorgroup> definition, which is located in the
CSS stylesheet.
(From yocto-docs rev: 322ae6450dfac9b2054b33334898a078fdd20902)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I discovered some artifacts and inconsistencies with how the YP
Quick Start was made. I made the following changes:
1. Changed the structure of the QS from "article" to "book"
as it is a separate book. This change doesn't fix anything
but it does bring the XML file closer to passing validation.
2. Removed the <abstract></abstract> tag. This tag was in place
simply to display the PNG file for the Yocto logo in the upper
right part of the first page. After turning the QS into a
book from an article, the title could be displayed as a PNG
file similar to the other books. This change solved two issues:
1) removed the empty "abstract" element from being displayed in
both the mega-manual and the PDF version, and 2), brought the
author and look of the first page into line with other YP
manuals.
3. Removed the old PNG file used to display the Yocto logo at
the top of the QS. This file was removed from both the
yocto-project-qs and mega-manual "figures" directories.
4. Added a new "yocto-project-qs-title.png" file to both the
yocto-project-qs and mega-manual "figures" directories.
5. Updated the "qs-style.css" file's .authorgroup element to
match and behave like the other YP manuals. This effectively
correctly displays the title PNG file for the QS.
6. Updated the Makefile area where the TAR files are made for
both the yocto-project-qs and the mega-manual. I had to
substitute in the new PNG file for the QS one and had to
add the title PNG to the mega-manual part.
(From yocto-docs rev: 914c482bd89071ab34b3381e3bd8065f871cc047)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The DocBook type at the top of the file indicated chapter
when the actual block of XML is article. I changed it to article
to be consistent.
(From yocto-docs rev: 5350426c11abc2fa4b1418a2d215cd8814745ef9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the example that creates a new BSP layer by using the yocto-bsp
script, the final step 6 could be interpreted as the script
creating the new layer in "poky". Even though the sentence is
technically correct, sloppy reading could mis-interpret it. I updated
the sentence so that nobody will be confused.
(From yocto-docs rev: 7c2bed2aa6f8c189ed9cabff6e4d4d9557238702)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6158]
Updated the style scheet file to format glossary variables in
such a way to allow for a PNG file of standard size to be
displayed below each variable. Right now, the PNG file is a
generic placeholder. Each variable displays a PNG file.
Updated each variable to include that PNG file.
(From yocto-docs rev: 24b7b847b7093022a49a014395df0c3a8c019331)
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 #5600]
Added a <info></info> tag pair with a short description of the
variable to each variable in the glossary. The short description
is what will be used in the documentation.conf file. Scripting
from engineering will pick up the variable description
automatically. The information between the tags does not
appear in the HTML or PDF output.
(From yocto-docs rev: 57fb9100e377a96c330be20613c5895b25910022)
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>
Scott Rifenbark
Ed Bartosh
Robert P. J. Day
Robert P. J. Day
Claudius Heine
Pascal Bach
Maciej Borzecki