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>
The LTTng Documentation website has been updated to actually
have extensive documentation now. Previously, in the profile-manual,
we were stating that documentation did not exist, which was true
at the time of writing. I updated the section to link to the
main LTTng documentation website and altered some other text in
the section appropriately.
Additionally, I found and corrected a couple spelling errors in
this chapter.
(From yocto-docs rev: 6e03bd6b90726904a1ac54b8f16f6554b4bb22b8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replaced the 1.7 strings with 1.8 so that all links in the
mega-manual are self-contained and properly resolve.
(From yocto-docs rev: 49f4b02c999ff2c3c78111673f6760f5fde2b82e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Claudius Heine
Robert P. J. Day
Pascal Bach
Maciej Borzecki