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>
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>
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>
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 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>
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>
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>
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>
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>
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>
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 #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>
Applied the third set of review comments from Paul Eggleton to
some variables.
(From yocto-docs rev: 2be5bc26a6fda1922ee73a874522180633d33b98)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For consistency, I changed the introductory sentence to the
variables that function when inherited.
(From yocto-docs rev: 6ba4fe635c45abf7692f4be0a09ede89a89ec9fa)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These edits were minor with the addition of some descriptions that
had to be fleshed out. All comments from Paul Eggleton.
(From yocto-docs rev: 4ae7c5a5e5aa23307e28de0832d379145c4ef8f1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added ASSUME_PROVIDED and SANITY_REQUIRED_UTILITIES variable
place-holders. There is no text there yet but they are there
for placeholders.
(From yocto-docs rev: adfa77dc597303dcff0e95fd4b3ffd5ae2fb08d5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual I had been using angled bracket sets to
denote user-supplied input. This is confusing and better shown
by using the <replaceable></replaceable> tags. I scrubbed all
the chapters and replaced as needed.
Some other minor formatting changes were caught and fixed during
the scrub as well.
(From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied the full set of first draft revision edits for the
new migration section for 1.7. Comments from Paul Eggleton.
(From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable has been replaced by the KERNEL_MODULE_AUTOLOAD
variable. I updated the description to note that and to provide
a cross-reference to the new variable.
(From yocto-docs rev: 8b2f464f7d100db1c585ccc62d7cab89f7f7b164)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added this description to the variables glossary.
(From yocto-docs rev: 3da322f92d5028e96422e0c1f5df78b285f2355e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added this new variable to the variable glossary.
(From yocto-docs rev: d2d75631777f6cef3472bde428ed65419c99457e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This description was a bit confusing with the way the general
syntax was described so I re-wrote it a bit. Also, added the
requirement that if you use module_conf for a given <modname>,
then you must also include the <modname> as part of the new
KERNEL_MODULE_PROBECONF variable.
(From yocto-docs rev: 15b7819a0d9946ad6565576a6f28897e2dd724f9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is a space-separated list and not a comma-separated list.
(From yocto-docs rev: 23cf09ac128289e878bbc056e28060008ab5217c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Corrected some wording and also the first example.
(From yocto-docs rev: d641cdbf697b14d8122b3a018b06eed3437011ad)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was confusion about how this actually worked when you
do not create a package for a package listed with the variable.
Cases for when the build would throw an error or not had to
be clarified.
(From yocto-docs rev: 02f95339322afe53db816b3b73234490d835b1ca)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6629]
Added a new variable description to the glossary and also updated
the IMAGE_LINGUAS entry to have a back-reference to the new
variable.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 219097735c57a3dc10195511dd5b199e73b8a094)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6621]
This is a new variable that helps control how debug symbols and
source files are split off when creating -dbg files for use with
GDB.
(From yocto-docs rev: 506b79707f6aec7c14f1f9d7e5099d20fca45c0e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The initrd image used by the Linux kernel is list of file
system images concatenated together and presented as a single
initrd file at boot time.
So far the initrd is a single filesystem image. But in cases
like to support early microcode loading, the initrd image need
to have multiple filesystem images concatenated together.
This commit is extending the INITRD variable from a single
filesystem image to a list of filesystem images to satisfy
the need mentioned above.
(From yocto-docs rev: 051ef2e4d6480b28d21a59a79b6f0dca1a5944bd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the "svk" protocol and added in the ClearCase one.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 21b241990dec9b7beeeec639ac6c6e9b22f2b871)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6499]
Fixed a couple example INCOMPATIBLE_LICENSE examples so that
they now use the canonical licensing names GPL-3.0 LGPL-3.0 AGPL-3.0.
(From yocto-docs rev: d2d6be323d1a5ed9da88b7924954f9733a78da84)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* INITSCRIPT_PARAMS - noted the default
* INITRD_IMAGE - added a reference into the image-live class.
(From yocto-docs rev: 152cb93ca591c46a1344f2f09e0f85f14519ddf3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6499]
Updated three areas to include similarly licenced components
regarding the use of non-GPLv3 licensing.
(From yocto-docs rev: 88c0720e4070be58fbde17bc04db2b53c3307bf8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a reference that was not linking to the manual but
was instead referencing the Source Directory structure.
(From yocto-docs rev: aae3fb868e95ef2dbd548a5f9d1ea61a013190cd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Conflicts:
documentation/ref-manual/ref-variables.xml
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the ref-manual, I added a new variable description for the
PTEST_ENABLED variable.
In the dev-manual, I added a note to the "Adding ptest to Your
Build" section to mention that the OpenEmbedded system uses
PTEST_ENABLED to enable or disable building ptests and that
the user does not set this variable directly.
(From yocto-docs rev: 52d6608caaa25378b873e41e1ddd05356ff8629a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a bit about values being passed through the
update-rc.d command and then a reference to the command's
page.
(From yocto-docs rev: e007414608ed801e440b701d6c43dca955a11611)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the link into the section for understanding how
OVERRIDES work.
(From yocto-docs rev: f897b9d0cc51899f3e4ce05b69a3c1dd429780d7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
More detail added.
(From yocto-docs rev: 84177a600f84af4cc41b9493b46e2a23bc7ccc19)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5463]
In addition to adding these two new variables, I did some cleanup
of the TUNEABI variable description for consistency.
(From yocto-docs rev: cf5c5fd0cb262b8da030ac923fda902d9e007b21)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New glossary entries.
(From yocto-docs rev: dbf566e1009d51ad8fce1ac8251249a70fb9270c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variables added to the glossary.
(From yocto-docs rev: 903ed6d26d7d32e4c1237fa9fd44b7471f1a41f2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO 5463]
Added the TUNE_ARCH variable. Also placed a cross-reference to
TUNE_ARCH in the TARGET_ARCH variable.
(From yocto-docs rev: 85d2a49323e0040b263b6d7f08fd036a25297b05)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Paul reported that "buildimg" was being used as the class name where
it should have been "bootimg". Not quite sure how this slipped through
but it has been fixed now. There were five occurrences.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: fdd6a6725bd22e4272a99a3da179cd69c4a221a1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistency on how we refer to a task name throughout
the YP manual set. The proper way is "do_<taskname>". Some
occurrences did not include the "do_" prefix. These have been
fixed.
(From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed a view wordings to more accurately describe what was
going on. This was feedback from Paul Eggleton's review.
(From yocto-docs rev: 6152a849c0e26178ce13a29b1f353d1b2912427c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added "meta" as part of a path.
(From yocto-docs rev: 14cda136d1f8690f5ea15b218f2ab4fb49c0afa9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I implemented some review feedback from Paul Eggleton on these
variables:
TARGET_CFLAGS
BUILD_OPTIMIZATION
SDKMACHINE
IMAGE_ROOTFS_ALIGNMENT
IMAGE_DEVICE_TABLES
EXTRA_IMAGECMD
SSTATE_MIRROR_ALLOW_NETWORK
PACKAGE_ARCHS
SDK_PACKAGE_ARCHS
(From yocto-docs rev: 6fd804376367449494d5a5cfeb7e9bb2f4c04de1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had the wrong description in here.
(From yocto-docs rev: eafe3fb2324d6361ee799177ffbb3de05795a2e2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a link to IMAGE_ROOTFS.
(From yocto-docs rev: b87975da8f99926f220d11a02b1655245d00f8e1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the following variables:
CFLAGS
CPPFLAGS
CXXFLAGS
(From yocto-docs rev: 58d82513ef70287717e7e208742aa72196708fc1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the following variables with minor changes:
TARGET_CC_ARCH
BUILD_CPPFLAGS
BUILDSDK_CPPFLAGS
CPPFLAGS
TARGET_CPPFLAGS
(From yocto-docs rev: f7d48ed379778a8568c7e5f812cdb1cbc5339f39)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the CFLAGS and TARGET_CFLAGS variables.
Created these new variables:
BUILD_CFLAGS
BUILDSDK_CFLAGS
CXXFLAGS
TARGET_CXXFLAGS
BUILD_CXXFLAGS
BUILD_SDKFLAGS
CPPFLAGS
TARGET_CPPFLAGS
BUILD_CPPFLAGS
BUILDSDK_CPPFLAGS
(From yocto-docs rev: 00d1895f56f8d65944549ab216d1e0ccdceea674)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the creation of the new chapter that documents the 51
tasks defined by the OpenEmbedded build system, the remainder
of the ref-manual had many first-instance occurrences of do_*
task names that could be cross-referenced to the new sections.
I have added these links.
(From yocto-docs rev: 2ff39bd226a1d8f11924283bbaa3542a9d936ba3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5159]
Edits to fix the occurrences of VIRTUAL-RUNTIME_initscripts = "".
I removed it from all places in the manuals except under
"Selecting an Initialization Manager". Note that it still
needed removed from "Using Systemd for the Main Image and
Using SysVinit for the Rescue Image".
Also, in the "Using Systemd Exclusively" section I made some
edits as suggested by Paul Eggleton's review.
(From yocto-docs rev: 28b2e3eba3acff17f165899a7f4a65c98263e201)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5554]
Applied edits to the section in the dev-manual on running tests
on hardware.
Edited the TEST_TARGET and TEST_IMAGE variables.
(From yocto-docs rev: a26ba11c739aabab4009a944d9b622e2814c7fca)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO 5766]
I removed the note about the "live" IMAGE_TYPES. Turns out I
was wrong on this information. It does not create a "directdisk"
image. That is accomplished through a .bbclass.
(From yocto-docs rev: a3b762be9933178e9cecdac3fa9e110c031a64d0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6125]
Did some re-writing based on Jonathin Liu's feedback.
(From yocto-docs rev: bee4a584bcb1e70e9848324781c32d1d9e3d1fc2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor re-wording edits as suggested by Paul Eggleton.
(From yocto-docs rev: 699eec0b691a19b4ae2f05c7774f559898e952da)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4961]
Documented the user requirement to use PACKAGE_INSTALL to specify
packages for installation into an initramfs image. Normally,
you use IMAGE_INSTALL. To account for this user model, I updated
the PACKAGE_INSTALL and IMAGE_INSTALL variables. I also added
a bit more information to the "Images" chapter item that
talks about the core-image-minimal-initramfs image.
(From yocto-docs rev: a1ad649cf310f281a7de584d5b9a1820ca99d4eb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5888]
Applied some feedback to the variables based on Paul's comments.
Needed a caveat on how you can use these variables.
(From yocto-docs rev: ef8fac4b36089d3162ee16c93866a39bcd31701c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5888]
Two new variables added to the glossary. These help with
specifying kernel modules that need to auto-load on boot and
with specifying module.d syntax in the modname.conf file.
(From yocto-docs rev: 1ac544c4f6129faafea10691b426cd510ff56a69)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I replaced the v3.4 version example with the v3.10 version.
It is more up-to-date.
(From yocto-docs rev: 2e7f5d4fbe24a8248686c9ca7cf870204966beec)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied this patch from Dennis and then removed some whitespace,
used the 5-space indentation convention for the literal, formatted
the task name and did some other minor fixes.
(From yocto-docs rev: 477a9ecb2f91681ee401478189a424793381bfcb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some review edits to change the useradd-staticids class and the
related USERADD* variables. Input from Paul Eggleton.
(From yocto-docs rev: 9b94046721a971de41d2062a48d624e06dcf17f0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the new useradd-staticids class to the reference section
for classes.
Updated the USERADD_UID_TABLES and USERADD_GID_TABLES variables
to tell how the system uses BBPATH in the default mode to
get UID and GID information from the files/passwd and files/group
files.
Added a note indicating that you can delete the TMPDIR directory
to fix things up if you configure useradd-staticids in a
configured system.
(From yocto-docs rev: a3f5ee3f5060369405d59a238fb02bddfeae5d6f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2444]
Several areas affected by the reference BSP "beagleboard"
being replaced by "beaglebone".
(From yocto-docs rev: 2f02b570e1ebcf0469871b67a029b65fa8b285f2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Turns out that the user does not set these variables.
(From yocto-docs rev: b016906dad7e3d7856935e83e5c9b09cfa399caa)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5159]
In the dev-manual, I located instances where a note about using
VIRTURAL-RUNTIME_initscripts = "" in the local.conf file would
be appropriate. Three areas updated.
In the ref-manual, I located the note in the systemd.bbclass
section and the variable descriptions for SYSTEM_AUTO_ENABLE,
SYSTEM_PACKAGES, and SYSTEMD_SERVICE.
(From yocto-docs rev: 57b0acf2f3f8159b635b42dcffa129f7d945eb81)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3686]
In the dev-manual, I created a new section called
"Making Images More Secure." The section explains in general
how to enable the security flags.
In the ref-manual, I updated the CFLAGS variable to point to the
new section.
(From yocto-docs rev: 3ed91a46eaf5c1fdf84369ea69951775d87a42da)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5861]
Added a note to the SDKMACHINE glossary variable stating that you
can't set the variable in the distribution configuration file and if
you do, it won't get recognized.
(From yocto-docs rev: 8cdc14e553586f6a754dfc3a91cc9741eb1784ee)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6045]
Added a sentence to the end of the variable's description indicating
how to enable building an ISO.
(From yocto-docs rev: 2806518155fdbb42b392a64b57a67c9259640f79)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The do_package_write task has been removed leaving only
do_package_write_* tasks. This variable description had an
example using that obsoleted name. I changed it to
do_package_write_ipk.
(From yocto-docs rev: ec1c33a867f539cd83d672845075f2437cd917ed)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did not eliminate this variable but rather changed the description
to indicate that it has been deprecated and that the user should now
use a PR Service to do this stuff. There were several areas in the
YP manual set that used the variable in code. I just deleted those
lines from the code.
(From yocto-docs rev: 88a075e6306349e5f8c0d53b5288ef1e64956cd3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "sum.jffs2" option was renamed to "jffs2.sum" to better reflect
its purpose. I updated the list of options for the IMAGE_TYPES
variable to reflect the change.
(From yocto-docs rev: 4226ff4aa96eed1d51753d5dee72c6264ee2d7f7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The PACKAGE_GROUP variable was renamed to FEATURE_PACKAGES.
I added that fact to the description and pointed the reader off to
the new FEATURE_PACKAGES variable.
Added a new variable description for FEATURE_PACKAGES.
(From yocto-docs rev: f7a0a17c211cfc8f885771a5221bf3b59bc6bf95)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #1562]
In the dev-manual, I created a new section called "Using the
Error Reporting Tool" that describes how to use this feature.
The text was based on information I received from Andreea Proca.
In the ref-manual, I added a new variable entry for ERR_REPORT_DIR
in the glossary and a new report-error class in the class chapter.
(From yocto-docs rev: 70a5538fefcc1b77958fe4b2f29be00354f4137a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5442]
Updated the TMPDIR variable to call out the scenario where a user
might want to separtely set TMPDIR to a local drive and thus be
able to have the Build Directory on NFS.
Updated the "Build Directory" term with a note indicating that by
default, TMPDIR is inside the Build Directory and thus cannot be
on NFS. However, the user is able to by-pass that per setting
TMPDIR separately outside of the Build Directory.
(From yocto-docs rev: a5a308c512a3f4285bce16f17974dbf6b67432b2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5442]
Updated the description to note that TMPDIR cannot be on NFS
since it has issues that mess up the build process.
(From yocto-docs rev: a2fa1c8a23ee7a26fa362e089d84747b4cb4618b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2528]
The defaults for BB_NUMBER_THREADS and PARALLEL_MAKE are now
automatically set to the build host's number of processor cores.
I updated the "Building and Image" section in the Quick Start
to state that. I also updated the PARALLEL_MAKE variable.
(From yocto-docs rev: 2069c96d2410605c089da4eede2c7b4f9a7b704a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2424]
Some imgage names were cleaned up to have more meaningful names.
These doc changes here take care of changing "core-image-basic"
to "core-image-full-cmdline".
Five instances changed.
(From yocto-docs rev: b758f9645e66867b5728da1dd989bae70a216fcc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5410]
I updated the figure that shows what do_rootfs does to create
the image. The new addition is the creation of the .manifest file
that lists out package information in the image. Supporting text
was also added in the section.
The updated figure was needed in both the ref-manual and
mega-manual figures folders.
Also, part of the fix included a new variable description for the
IMAGE_MANIFEST variable.
(From yocto-docs rev: 770448e0e8ce2e2c517ced5e71f5a916fefe5cf2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5931]
Added descriptions for the following variables in the glossary:
* MODULE_IMAGE_BASE_NAME
* KERNEL_IMAGE_BASE_NAME
* PKGE
* PKGV
* PKGR
* PKG
The first two are for the bug. The remainder needed to be added
as they were referenced from the first two (except for PKG, which
I was told needed to be added anyway. I also fixed a couple formatting
issues in there for some other variables.
(From yocto-docs rev: c488b57a2ae5a5d1ef4b0da0ecaa9589c3106a45)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4072]
Added the new variable CONFIG_INITRAMFS_SOURCE, which points to the
initramfs source. I also added information to the
INITRAMFS_IMAGE_BUNDLE variable noting how its use can avoid
circular dependencies as described by the bug.
(From yocto-docs rev: 73267642299d1164eeee5866e7ca7006c56260e5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added more detail about this directory. I stated that it
is the top-level build directory and it is set when you
initialize your build environment with one of the init scripts.
(From yocto-docs rev: 839d704e7096dba039b17e5989cad7314732e6db)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5855]
Added this new variable to the glossary.
(From yocto-docs rev: 72e31962ecb3289c3f986ecb54a5590b5101067d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a typo and also added a bit of information to be sure
the user understands this affects the local host.
(From yocto-docs rev: 4111ac06276f2d1b134176683c0f4d446ba35ef9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5801]
First draft of this description.
(From yocto-docs rev: 412d0cc7dbb74ece45940c40fbb617217ab88d2d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Better wording. "holds" could be confusing for some.
(From yocto-docs rev: d94a1be421f39637b1d760dad401fdfb54e20b07)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5762]
Applied some more detail based on Laszlo's review comments.
(From yocto-docs rev: eb8d11504d6c22dfd9620422df3fc31cfcebb00c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5762]
Initial draft of this variable in the glossary.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: fb603925de6760f620f9f2832ad6cb4aad3acaae)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5755]
I added this variable to the glossary chapter.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 0ad0e2ca351ebc52c92404d71502455cf7c042c9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Noted that if these variables are not set, they both default
to the number of cores the build system has.
(From yocto-docs rev: 8654aeb91f734628bffda9d5de0cdc9ea27d3f67)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4942]
Added a note to the variable description stating that if the user
does not set TCMODE to "default", it is up to them to verify that
components are compatible with the toolchain.
(From yocto-docs rev: e67d7635c1d749e65aaef0d4cc6576a3ee312ddd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the machine-dependent and machine-independent descriptions.
Created matching description from the "Writing a New Recipe"
section.
(From yocto-docs rev: 89a00beb81be60668abfdd67b13f5ee5bdc7ea1c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor changes.
(From yocto-docs rev: e545ee26e7e6c827c5ee6d7061f01eda58c9c82b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These variable descriptions were identical in the ref-manual.
I found out some reasoning behind that and added a bit of
explanation to the entries.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 5c786b5b62fefb959ed7c13bb83e718a9eb22189)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4072]
Added a new description for the INITRAMFS_IMAGE variable. Also,
made a formatting fix to the INITRAMFS_IMAGE_BUNDLE variable.
(From yocto-docs rev: 87c5c0b1554233c3ce1c41291d852021ec62e0dc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4072]
Added that the kernel class sets the variable to a null string
by default.
(From yocto-docs rev: d00ea912ad9ad1558546496e72fca229b9b8081b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4072]
First draft of a new variable description for
INITRAMFS_IMAGE_BUNDLE.
(From yocto-docs rev: 4f1ac2840750fa35afa7584d28464fd539883399)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5684]
Added a clause to note that the tarballs saved to the DL_DIR area
include the Git metadata.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 76cbb8a149b9fda6879f9dfc6a17dab992325e94)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The directory is not a temporary thing.
(From yocto-docs rev: 4a10a64866e9e769a2113f95943d69cb79543d6e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Used a better word to describe the argument list.
(From yocto-docs rev: e31852ee32b2f5166cc766a2cdfe07616dd259db)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Three broken cross-references to the "qmake_base" class existed
in the variables chapter. The actual class "qmake_base" is
listed as part of the "qmake*" class so there is no tag taking
a user to the exact "qmake_base" class. Changed the tag to
"ref-classes-qmake*".
(From yocto-docs rev: c13e441e9bbe3a451a59e5123b772426d36183ae)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note at the bottom clearly stating TAR files are never
used as a substitute for RPM, DEB, or IPK files when generating
your image or SDK.
(From yocto-docs rev: 8d45ac58926de4fb01156eccd53cfa0f3eca4d9d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was pathetic and needed updating.
(From yocto-docs rev: 30996e88a8ca26d57f748fc8232bb26e0ff6c433)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I discovered some issues with this description. Should be
referencing the Build Directory for where the local.conf file
is and not the Source Directory. Also, the link to the
package.bbclass section was mis-titled.
(From yocto-docs rev: 38daa12eae5303a70cf210f8669e416b161b38bc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Sorting out who assumes what.
(From yocto-docs rev: f02312e300ce7749a7a5347538ece26f5cfa76bf)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed the links in the icecc class that linked into ICECC_CC,
ICECC_CXX, and ICECC_VERSION so they don't link anymore but rather
give a very brief explanation of what the variable does.
Removed the above three variables from the variable glossary.
These are not BitBake variables and we should not document them.
(From yocto-docs rev: f4f79d27c0d1417ff683381f18f165cda3a8a02e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor changes to the SYSTEMD_PACKAGES, SYSTEMD_SERVICE, and
SYSTEMD_AUTO_ENABLE variables.
(From yocto-docs rev: 838eb9088ec20a265e785d4203e4e5084fd4a7c4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Modifications to ccache, chrpath, clutter, cross, cross-canadian,
crosssdk, and debian classes.
Added a new variable to the glossary for LEAD_SONAME.
(From yocto-docs rev: f27b6315f839a731017866106578e664c6c86982)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also had to update four instances in the variables glossary where
links to the section for the class became misnamed due to
stripping out the excess stuff from the class section heading.
(From yocto-docs rev: d98d3848327950c5c5cfc8559379e56c97157ad2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note to the existing IMAGE_FSTYPES variable based on
using "live" as an image type. Need to be sure that appears
before inherit line in the recipe.
(From yocto-docs rev: 1fc45b2bc7c70f00882d495d659830b94eb7d2df)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Told where to set this variable.
(From yocto-docs rev: f95fb5821383721da6a63bb8eb74807e89e6b21d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created glossary entries for the GRUB_GFXSERIAL, LABELS,
APPEND, GRUB_OPTS, and GRUB_TIMEOUT variables.
(From yocto-docs rev: 31bcc25866525ef998bc01e11ab9ddb0601b8ded)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Due to the way in which IMAGE_FSTYPES is processed, it is not possible to
modify it using _append or _prepend. Therefore add a note to the manual to
warn users in case they stumble on this issue.
(From yocto-docs rev: 164aee65a6796ccc24c2734bb7440a8d6531f180)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I applied some review edits to the USERADD_PACKAGES and
USERADD_PARAM variables from Paul. Additionally, I added descriptions
for the GROUPADD_PARAM and GROUPMEMS_PARAM variables.
(From yocto-docs rev: 0c52a79efb2cf7c708ea989ab307be04f27484dc)
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: 4eb9a5c6df085e57e7885e12fdbdcc85f61c101d)
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: 6ace08dcbaa08fd13d4d8f49d34dd90240e65761)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This needed some work to be more descriptive.
(From yocto-docs rev: 2ea324c84f5aaaf3c30d1c71396fa3d5372669a0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Took care of some quoting for the "x11" feature and also a
messed up sentence in the second paragraph.
(From yocto-docs rev: ed71135edbdd8de02cbb6d7cc972aab0e269e4cb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I noticed that chapter 10 of the ref-manual still had
"Reference: Features" as the title. This is left over from way
back. I changed that chapter title to "Features." Next, I
noticed an inconsistency with some sub-section titles.
I changed the "Images" title into "Image Features." This affected
several links across the doc set so I had to update those
cross-references as well so they have the latest section title
as part of the reference.
(From yocto-docs rev: b68f009a92e0e24802e367d98cf66e15ba1cd364)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This term should always reference a users current working directory
and not be confused with the OpenEmbedded build system's "work
directory (WORKDIR). I found several instances where the term
"working directory" was not used correctly and fixed them.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 300c78c1d54b2a4fbb8ecca03faa7c8c67bdc54f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the MACHINE_FEATURES, DISTRO_FEATURES, and
COMBINED_FEATURES variable descriptions to better reflect what
they actually do. Also, fixed two occurences of IrDA in the
features lists section.
(From yocto-docs rev: af79b0b3bc88ca0811d488c7c5d6b5407de808a7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Very rough draft for this new variable. It will likely
change.
(From yocto-docs rev: b535542975ae469753cb27ce59f9f716167384fb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added glossary definitions for BUGTRACKER and
CLASSOVERRIDE.
(From yocto-docs rev: 79c10f1cf0f18429eb41b035ed60264b48549e9a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The BB_DANGLINGAPPENDS_WARNONLY variable seems to be able
to be set using "1", "yes", and "true". And, it is set using
these various methods throughout the poky metadata. I guess it
has caused a bit of confusion so I have added the fact to the
description.
Reporte-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 651e09aba67f9d62ce005529f16a776c0ab593f1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistent use of the way directory names were
handled throughout the YP documentation. I have scrubbed the
set and replaced many instances such as the following:
meta/<something> replaces /meta/<something>
poky replaces ~/poky (except in some very specific examples)
I basically got rid of leading slash characters.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ae2e451ed8f61484d04b30017021912c4493a441)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5408]
Some edits to remove a link to the YP Metadata definition.
The metadata referred to here is for opkg only.
(From yocto-docs rev: 777969fb3b74e638fedb638d161e2f92ac0a5f4c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5408]
As part of the fix for this bug, I have added a description of this
variable to the glossary.
(From yocto-docs rev: ad988c82b364bb0c629bcb2ce04f99e0e371622e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The formatting for the "Caution" boxes was poor. There was no
apparent reason in the style guide why these types of admonitions
should appear any different than "Notes" or "Tips", which look
fine. I could not devise a .css solution so I tricked the
formatting by using the <title></title> tags in combination with
a <note></note> pair. Basically dumped the <caution></caution>
tag pair. It looks okay now.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: a53d6f0b3a22cfd87f841c03452b5ebce2b1b474)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The etcdir string was replaced by sysconfdir.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 095a9226171189f17c0671b05196cef58da33732)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is only used when building an image using Hob.
The description implied otherwise. I clearly state this now.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 12b671aec1df367c107d906bbefb44da56b2adec)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5368]
Applied some review comments from Laszlo to the new description.
I added an example.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 5961cde05aff967f8db7cd10cd9b46c147c62f83)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5368]
The current explanation was ambiguous regarging the term
"subset". I have rewritten to be clear.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 3bf41e856c3d9828d5c9cd6d70467e88a4af575f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5214]
Applied some updates to better describe the variable's use
model.
(From yocto-docs rev: 9a66296f090f4ef023b3b5ae6f237676b6e9bd87)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5295]
Added three new variables to the glossary: UBOOT_MACHINE,
UBOOT_ENTRYPOINT, and UBOOT_LOADADDRESS.
(From yocto-docs rev: 48d52dfd4c395cdfeb95878cbd7f128adba8e398)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5063]
Provided a brief note that tells the user how to set BBPATH
if they are going to run BitBake from any directory outside of
the build directory.
(From yocto-docs rev: 89b31f252237113638acea4634a65ea9ff241b5e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Review edits from Paul Egglegon applied to the Migrating to
1.5 section.
Also, part of the review affected the COMPLEMENTARY_GLOB variable
entry in the glossary.
(From yocto-docs rev: 941a388f45c99403f5cb480bf3e5aae55a800994)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied review changes to the following variables:
IMAGE_NAME
DATETIME
SDK_ARCH
IMAGE_BASENAME
TUNE_PKGARCH
PACKAGE_GROUP
COMPLEMENTARY_GLOB
BUSYBOX_SPLIT_SUID
Also, reformatted some 1.5 package version requirements into a
list rather than a lazy literallayout tag.
Provided some new wording for the "Directory Layout Changes"
section in the Migration chapter.
(From yocto-docs rev: 60c3a905dd9212f1b4f6969341640a0726342d11)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. Created the first draft of the new migration section for
moving to the YP 1.5 release.
2. Created new variable glossary descriptions for the
SDK_NAME, IMAGE_NAME, and DATETIME variables.
(From yocto-docs rev: 26e6a7675183b49a0ee8059d81218dbc5cd14bd4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied a second round of review edits from Paul Eggleton
for the new "Performing Automated Runtime Testing" section.
I did some reorganization and some minor wording changes.
(From yocto-docs rev: fa8f8e5f0f6c1377a4fcafcd3d933af15ac01ff3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the glossary entry for DESTDIR as this is a Makefile
variable. Also, updated the reference sentence to DESTDIR
that was in the autotools.bbclass section.
(From yocto-docs rev: 16900d95dbbd406ac93cd22f2b14b2346668beb3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor word changes and formats.
(From yocto-docs rev: 82c096cd79e7de8cb8c4af4be02b6838e82f06d6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note indicating that the variable might be cleared out
if there are problems running Make.
(From yocto-docs rev: 861921b86c48de2267ccd32ab3f3424a98eb8ed1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-worded the first sentence.
(From yocto-docs rev: 1b6798a8de3d73418b4377cf3b9654dfea4caed8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
