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>
Scott Rifenbark
Claudius Heine
Robert P. J. Day