Commit Graph

1680 Commits

Author SHA1 Message Date
Scott Rifenbark
4f27aa6e3a ref-manual: Updated the do_install reference section.
Fixes [YOCTO #9966]

Added quite a bit of detail to this task's description.

(From yocto-docs rev: c29d86813b9cb9bc1c9c02aeffb5cfd99fc5a542)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
781bff802b ref-manual: Updated the do_configure task.
Added more detail for this task.

Fixes [YOCTO #9965]

(From yocto-docs rev: e50207488b8262bb46e58c4b9f40e487c15abc67)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
8f2d8c2061 ref-manual: Fleshed out the do_compile task.
Fixes [YOCTO #9964]

Added more detailed information to the do_compile task.  Also, provided
some information about oe_runmake in the base.bbclass refrence.
Finally, put some detail in the "Shared State" section concerning
do_deploy[dirs].

(From yocto-docs rev: 5d0612a57cc8e035a2194ada21e65055ef2b8a2e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
04c611290c ref-manual: Updated RDEPENDS variable description with note.
Fixes [YOCTO #9963]

I created a new cautionary note to warn the user to use the correct
operator "+=" rather than "=" so that they do not destroy $PN.

(From yocto-docs rev: e6861ffe9400b1ee48cc46ccfc6e8d65efbbec8c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
818e439cf5 ref-manual: Applied review comments to logging mechanism section
Fixes [YOCTO #9950]

I Provided a suggested introductory sentence and a better link to
the logging.class file, which is near the end.

(From yocto-docs rev: 6f296266b35f17792510d6a01f5640ba30818a22)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
aae4c2a629 ref-manual: Updated the "Recipe Logging Mechanisms" section
Fixes [YOCTO #9950]

Added more detail on the functions for logging.

(From yocto-docs rev: b7ed4d84ae5221765201fe661af3741fb01da738)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:52 +01:00
Scott Rifenbark
451334a841 ref-manual: Applied review changes to the DEPENDS variable.
Updated the note with some formatting and grammar changes.

Fixes [YOCTO #9933]

(From yocto-docs rev: afef28ae894c313f85ddbaeef8b0abbc2700ba2c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:52 +01:00
Scott Rifenbark
bdf9003cfb ref-manual: Added review changes to BBCLASSEXTEND description
Fixes [YOCTO #9909]

Added some technical clarifications to the existing note to be clear
about what is causing the limitations in this case.  Applied some
formatting fixed to for the use of the include word.

(From yocto-docs rev: cbbd960d8665d9fb6b92698c14728d1c0bcc659f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:51 +01:00
Scott Rifenbark
acdfb5f3cc ref-manual: Added notes to the DEPENDS variable description.
Fixes [YOCTO #9933]

Added two notes to help clarify how DEPENDS works with pre-compiled
objects.  There are some details that trip people up.

(From yocto-docs rev: 06917e97adf24816b0aee6fdfdd14aa79d4c6ab2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:51 +01:00
Scott Rifenbark
640181cce8 ref-manual: Added clarifying note to the BBCLASSEXTEND variable.
Fixes [YOCTO #9909]

Added a note that talks about how the BBCLASSEXTEND mechanism
adds recipe variants.

(From yocto-docs rev: a05990ecb760519a685a1c5ddcf2ce3e048bfbf2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:51 +01:00
Scott Rifenbark
48336f5139 ref-manual: Added cross-referencing to tasks and dependencies
Fixes [YOCTO #9861]

Placed some section links into the "Tasks" and the "Dependencies"
sections of the BB manual from several areas:

 * The "Normal Recipe Build Tasks" section
 * The variable description for DEPENDS
 * The variable description for RDEPENDS

(From yocto-docs rev: d96347fdb4c3d5a34695f20e995f165c5ba91c32)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:51 +01:00
Scott Rifenbark
cf3b80b0c8 ref-manual: Added new glossary entry for REMOVE_PKG_SUPPORT.
Fixes [YOCTO #9899]

New variable description added.

(From yocto-docs rev: 95b740d719a7a6ffe3a06a1f152af4d877ee08c7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:51 +01:00
Scott Rifenbark
444a80a355 ref-manual: Added a new section on setscene task variants
Fixes [YOCTO #9251]

I added a new section on the task variants for setscene, which uses
the shared state cache.  The section describes the BitBake processing
that helps the build system to not have to build everything from scratch.

(From yocto-docs rev: 6aa0e6b837de14dd7d6c5ef34328bbf268dd6d71)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:49 +01:00
Scott Rifenbark
4fb1961acf ref-manual: Fixed typo in the "Shared State" section.
Fixes [YOCTO #9823]

The do_deploy[sstate-inputdirs] string was wrongly
do_deploy[sstate-inputsdirs].

(From yocto-docs rev: 49e7cb239f4f4f70dc5738686f1bca135772bcbe)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:49 +01:00
Scott Rifenbark
b67f865e67 ref-manual: Review edits to the PR variable in glossary.
Fixes [YOCTO #9843]

Some minor rewordings and removal of a stray comma.

(From yocto-docs rev: 0b0c8b0b1c4edb86eb2b20c73ffb83d640f6b916)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:49 +01:00
Scott Rifenbark
e5fabb90dc ref-manual: Updated the RDEPENDS variable description in the glossary
Fixes [YOCTO #9380]

Updated the shlibdeps description for this variable to try and
satisfy automatically added version restrictions.

(From yocto-docs rev: d94de0b24591206620c83a9022a9d813141a7637)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:49 +01:00
Scott Rifenbark
b66e84e19d ref-manual: Updated the PR variable description.
Fixes [YOCTO #9843]

The variable description was very brief.  These changes added some
substance to the description and how the OpenEmbedded build system
uses the variable.

(From yocto-docs rev: cc9117d4e16c56dd54f81804fda94561e61d91a7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:49 +01:00
Scott Rifenbark
77031ba572 ref-manual: Updated the flag descriptions for shared state details
Fixes [YOCTO 9823]

I added more details to the explanations of how shared state is
implemented.  Included a bulleted list of the various statements
of code to help explain flags and settings.

(From yocto-docs rev: 518352f88c8dda16f2915a7bb9901ffd7686d739)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:48 +01:00
Scott Rifenbark
fc518b5a48 ref-manual: Updated the DISTRO_FEATURES description of Bluez5
Edits to explain that by default, DISTRO_FEATURES backfills
bluetooth support with Bluez5.  If the user wants to use the
Bluez4 feature, they need to backfill consider Bluez5.

(From yocto-docs rev: 4e8b34c8c5841cdc1cae564decae4689ae4f2b11)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:48 +01:00
Scott Rifenbark
11b6dd1e81 ref-manual: Updated SSTATE_MIRRORS examples to match reality
Fixes [YOCTO #9773]

Updated two examples that set SSTATE_MIRRORS so that they match the
changes made by YOCTO #3220.

(From yocto-docs rev: e07674cd0665c485173eaa05c4072c287411b81f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:07 +01:00
Scott Rifenbark
fadcb31841 ref-manual: Fixed a typo for installing "python3-git"
Fixes [YOCTO #9712]

(From yocto-docs rev: 0ece224ec34b3b441af7a3a7a8c076d5cdce7c4d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:07 +01:00
Scott Rifenbark
6b3b444c35 ref-manual: Updated the UPSTREAM_CHECK_* variables.
Fixes [YOCTO #9671]

(From yocto-docs rev: 0f7e086e126d210cde0bd0cbe3e56d0808138e28)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:07 +01:00
Scott Rifenbark
52fc567988 ref-manual: Added note about installing Git-Python package
buildhistory-diff tool requires the Git-python package.
I added a note indicating this.

Fixes [YOCTO #9712]

(From yocto-docs rev: 2187df01f784b40608b30f62d19888cf183e67e9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:07 +01:00
Scott Rifenbark
f33db8b6eb ref-manual: Updates to the UPSTREAM_CHECK_* variables
I applied some grammar edits and re-wordings as directed by
technical reviews.

Fixes [YOCTO #9671]

(From yocto-docs rev: b5a5d3d3b311cb83ed61bfd247fbf802027fe5c4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:07 +01:00
Scott Rifenbark
cd7f787174 ref-manual: Edits to UPSTREAM_CHECK_* variables.
Fixes [YOCTO #9671]

Applied some review comments to these three variables.
Edits to be sure to qualify that the variables only to recipes
who inherit the distrodata class.

(From yocto-docs rev: 1b094b0567fa75d1c77da7ec04641d034f29272d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:06 +01:00
Scott Rifenbark
c735ade998 ref-manual: Added descriptions for three UPSTREAM* variables.
Fixes [YOCTO #9671]

Put in descriptions for the following variables:

 * UPSTREAM_CHECK_GITTAGREGEX_pn
 * UPSTREAM_CHECK_URI_pn
 * UPSTREAM_CHECK_URI_pn

(From yocto-docs rev: e00470cbf98714236f3197dd538371488d8f03fb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:06 +01:00
Scott Rifenbark
44f29bf89a ref-manual: Updated the INHIBIT_PACKAGE_STRIP variable
Fixes [YOCTO #9553]

Added detail to this variable description.

(From yocto-docs rev: 35407b9db582ebc23be89a6f9bc7b0ad9ab90979)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21 12:59:06 +01:00
Scott Rifenbark
ceb7c51746 ref-manual: Fixed *[doc] string for INHIBIT_PACKAGE_DEBUG_SPLIT
The string was a copy paste error.  It was using the string
for INHIBIT_PACKAGE_STRIP.

(From yocto-docs rev: d2efc36a7bc39b3fb596286dcde5efa1b8fead7c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-06 22:53:35 +01:00
Scott Rifenbark
6c5fea2171 documentation: Prepared manuals for a 2.2 release.
* Updated poky.ent to have the appropriate 2.2 variables
* Updated all manual revision tables to have a new entry for
  2.2 - used "Sometime in 2016" for the date.
* Updated the mega-manual.sed file to process internal links
  for 2.2.

(From yocto-docs rev: 2acd49ee197e3e3e725f4cb8cc432437afd8646b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-06 22:53:35 +01:00
Scott Rifenbark
8fc310c90f ref-manual: Added BlueZ version 5 feature to distro feature section.
(From yocto-docs rev: c7055f313a127bc8ed65a93ed7bea21775518567)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-06 22:53:35 +01:00
Scott Rifenbark
a1d67b2418 ref-manual: Added GObject Introspection to 2.1 migration section.
(From yocto-docs rev: 0b9ee8da66ff81e0724465f18b0323f1216cb9fa)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-29 07:48:22 +01:00
Scott Rifenbark
ab3147e995 ref-manual: Added new 2.1 migration misc. Change
Lists packages removed if package-management was not in
IMAGE_FEATURES.

(From yocto-docs rev: 45768d661b800782e32b76b4fa7efa0f70cb7e47)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-29 07:48:22 +01:00
Scott Rifenbark
d4c4b2f7b8 ref-manual: Applied 2.1 Migration section review edits.
(From yocto-docs rev: d641e8404d13aa96f23c537045d1ce165a0fe119)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-29 07:48:22 +01:00
Scott Rifenbark
3f55657134 ref-manual: Fixed a grammar consistency error
Referring to multiple options that function the same as
two separate options.  I had two successive sentences that were
inconsistent.

(From yocto-docs rev: 291fa846dba2bfcffae9d0538eba65df71c1092b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-29 07:48:22 +01:00
Scott Rifenbark
01df6a7c77 ref-manual: Applied review edit comments to the 2.1 migration section.
(From yocto-docs rev: 50eb2e0bcd4afaa2c097b4fa121051920cf21053)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-29 07:48:22 +01:00
Scott Rifenbark
9f970b6bc1 dev-manual, profile-manual, ref-manual: Purging Oprofile stuff
Fixes [YOCTO #9264]

Several occurrences of tools-profile and the like had to be dealt
with.

(From yocto-docs rev: 62f45579970f47d22dabe921a51c663059a04576)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:25 +01:00
Scott Rifenbark
1d93104d0e ref-manual: Added description for the testsdk.bbclass.
(From yocto-docs rev: 3eed6f3e244303de02cc52c16a0745b808d79e39)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:25 +01:00
Scott Rifenbark
db47094be5 ref-manual: Updated the remove-libtool.bbclass description.
(From yocto-docs rev: de35e72836ebc75aa1f9614fa034631dd7d2a611)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:25 +01:00
Scott Rifenbark
a16eecac5b ref-manual: Added gobject-introspection.bbclass description.
(From yocto-docs rev: e6c40815c2a6ea3c94126ef43e586a01cb721ea8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:25 +01:00
Scott Rifenbark
3e761b443f ref-manual: Added reference for npm.bbclass.
(From yocto-docs rev: 7bf6401ad16ad83743d82a3b7592f77237c453f8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:25 +01:00
Scott Rifenbark
5e50157034 ref-manual: Fixed typo in the nopackages.bbclass description
(From yocto-docs rev: c73d36e01b501471d24a174a8be77f1798d0ea5e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
f7b68c7102 ref-manual: Added description for bash-completion.bbclass
(From yocto-docs rev: a3b29e84b5d521d70585b8a2a7bd989c643cd310)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
ece900a6e8 ref-manual: Added nopackages.bbclass description. Fixed stray typo.
(From yocto-docs rev: aa34f219237d6490fc0061ecd0644d4093957729)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
9143e9ea25 ref-manual: Added description for the INSTALL_TIMEZONE_FILE variable.
(From yocto-docs rev: 768935078510bcf4300ff5e05e87c9bed10a0cde)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
6391dbfe48 ref-manual: Updated the PREFERRED_PROVIDER variable with a note.
(From yocto-docs rev: 5d3a3e9ea8670f784f9c06cb244a9d5981bb1e76)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
6d86f7a0a3 ref-manual: Dropped references to the autotools_stage class
(From yocto-docs rev: f13f1925f1ea47a87730844109ed224b16c1f587)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
4d5ff5e075 ref-manual, dev-manual: Scrubbed boot-directdisk and bootimg classes
These classes have been removed.  The bootimg class was sucked
into the image-live class.  I removed the reference sections to
both classes and fixed the references throughout the manual set
as needed.

(From yocto-docs rev: 649d56b54987580039cbd52f54642112f810ffad)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
cd2aaaa310 ref-manual: Updated the uninative.bbclass description.
Dropped the "experimental" verbiage and added real detail.

(From yocto-docs rev: ca63ab4bac2885037741afdc78ee307233159a2e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
e975d26e84 documentation: Converted "meta-yocto" to "meta-poky"
Occurrences in many manuals and one figure.

(From yocto-docs rev: 26d30cd162083c62216fb4ab526d0b231f453de1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:24 +01:00
Scott Rifenbark
e00a62c905 ref-manual: Added the migration section for 2.1
(From yocto-docs rev: ed1eec9139d8a9caf32f0cc896f651cafecece4f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:28:23 +01:00