Fixes [YOCTO_#3095]
A minor edit to the glossary entry. The fix for this bug spanned
two other commits:
418862011e79940ee378f64c6171618d29568014
7647cef96643b3723f80013c2c51ba6d7480122a
(From yocto-docs rev: 053e4558cc90eb1618e697394aff6d40edbeb3b1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These edits removed the .x eplanation at the end. Paul Eggleton
concluded they do not matter and are confusing.
(From yocto-docs rev: 3f3e0b65bbfbb8da3ba1ebbb8dc78c3adf5a1c98)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A re-write of this glossary item. The example provides more
detail and frames it in the context of a real example.
(From yocto-docs rev: 1a88abecf6ab5895d3c8ff801bd869a90a8a3fc1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the wording in the front to get rid of redundancy
and specifically state that this variable affects .bbappend
files only.
(From yocto-docs rev: 7647cef96643b3723f80013c2c51ba6d7480122a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the glossary description for the B variable. There
was some confusing "source directory" terminology in there.
(From yocto-docs rev: 72fbf86ca9612a0dca741f08315efed1d9efa0b1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added some clarifying edits to the explanation about suffix and
prefix names used with the PN variable.
(From yocto-docs rev: f42baf8ddb3da1ab8ba69d30581812646ce4dc83)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Checked and fixed all text surrounding the description and use
of the PN variable. This variable can mean a recipe or a resulting
package depending on context.
(From yocto-docs rev: 7ac52f6b184670db9cdab7c205126b62c60b0d29)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-write of the SRC_URI glossary entry so that proper terminology
for PN is used. This context the PN refers to the recipe name
and not a resulting package.
(From yocto-docs rev: fc371890d9797ba57e2ce848cd2f82f42dd6ac36)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#1939]
Added the option downloadfilename to the SRC_URI variable
glossary description.
(From yocto-docs rev: abc32d85a7f241766d1fcc52a251249f2172ea89)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#1939]
Expanded the definition for the SRC_URI variable in the glossary.
The new information includes protocol types and SRC_URI options.
(From yocto-docs rev: 033d58cd2ec2a579fa085bcca1e5d0ad4dd65708)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For 1.3 there is not longer a toolchain tarball. Instead, there
is a wrapper script that lets you install the tarball. This
fundamental usage model change caused several ripples throughout
the documentation set. I have changed wordings and examples
to reflect the new paradigm.
(From yocto-docs rev: afb2069daa91e04c0f78ba425a6b184cb820d888)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Slight wording change to the description of the
PACAGE_BEFORE_PN variable description based on feedback from
Paul Eggleton.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: 8f7dcdb8edf461133d2149eb4728ee3682affc98)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the variable from BB_ENV_WHITELIST to BB_ENV_EXTRAWHITE
in the text before the example line. I had the wrong variable
in there.
(From yocto-docs rev: f909a7336ae2f95baa751231beeae08081576e1f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the BitBake "Preferences and Providers" section to remove
references to these two Pimlico applications that have been removed,
and tweak the example slightly so it is technically correct.
(From yocto-docs rev: 744624a40d02a859b3c526f5ea6657d32edd39c6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* core-image-core was renamed to core-image-x11 and the editor and file
manager were removed.
* core-image-basic's description has been updated to reflect its
intended purpose
* core-image-lsb is intended to be standalone - should not be
associated with core-image-basic.
* The Pimlico applications have been removed so they are no longer
present in the Sato images.
In addition to Paul's patch, I removed the "etc." word. This word
is better replaced by "and so forth". Also, consistent with the
YP documentation.
(From yocto-docs rev: aba7ae60a38dfeda9ef52237b81f387984621847)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a short section about packagegroup.bbclass.
In addition to Paul's patch, I changed the title of the cross-reference
to be the actual title used in the YP Development Manual.
(From yocto-docs rev: bfd4db7e0ef61a2dd7159cdc841dcffc2d9c53d4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* For PE/PV/PR/PN these pertain to a recipe ("package" was used here
historically).
* References to variables should not be prefixed with $ in the text
* Add text about suffixing RCONFLICTS as per other package variables
* Make ALLOW_EMPTY example complete
* Clarify and add example for AUTOREV
In addition to Paul's patch, I re-worded two instances. One
to get rid of "package(s)", which is poor form. And a second
to get rid of "unstable/development", which is also poor form.
(From yocto-docs rev: 498349f8d82f46433626521d148ff6c1d72e2b1c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Clarifying who picks up files that would normally be included
in the default package. This is a wording change to try and
eliminate the ambiguous "they".
(From yocto-docs rev: 63f87b6616c1a93d39e198f0b02d01d36ac09467)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the "Reference: Images" section to "Images". This old
name was a hold over from when the book had appendices that were
reference-like. Along with changing the name I also fixed two
links to the section that were found in the variables chapter.
(From yocto-docs rev: e21a973cfe07d21acdfe02b49aa86c7672905968)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also add a definition for PACKAGE_BEFORE_PN since the default
value of PACKAGES now includes this.
In addition to Paul's changes I reformatted the default to be
<literallayout> to appear as code.
(From yocto-docs rev: 187390e2589b886e524700db9dc2e89cf28c6e90)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These file paths are no longer valid, instead point to the section
of the reference manual with more information on valid IMAGE_FEATURES.
In addition to Paul's patch, I provided the actual section name for
the cross-reference link he inserte.
(From yocto-docs rev: ad356708bfe3a14e82d678510df15cb93dc2f057)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* apps-console-core has been effectively replaced by splash
* apps-x11-core, apps-x11-games have been removed
* ssh-server-* were added quite a while ago, add these here
* x11 has been added
* x11-base has changed behaviour slightly
* doc-pkgs was added
* nfs-server never exported the entire /, so remove this comment
In addition to Paul's changes. I performed some general edits to the
list so that it is active voice and has a parallel structure for
all the list items. Changes involved some of Paul's stuff and some
of mine.
(From yocto-docs rev: fec6f162506a59124b137a7d1640944114ebb5c2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert P. J. Day pointed out a link in the development manual that
was for the BitBake User Manual. The link resolved to an old,
non-maintained version of BitBake documentation. According to
Richard Purdie, the BitBake docs referenced should be the ones
that ship in the bitbake/doc/manual directory of poky. The
YP docs had been using a variable named BITBAKE_DOCS_URL that
also resolved to the antiquated user manual site. Consequently,
there were many links that needed fixed across both the YP
Development Manual and the YP Reference Manual. Each of these
references now points in general to the bitbake/doc/manual
directory in poky for more information.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 12f77236b602e9ec43e845c8cec060ad342af19c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed "The" from all the titles of the books. This makes it easier
to reference to them and easier for the automated processing of the
mega-manual.
(From yocto-docs rev: af566d6d007cff642648698ea487a6eeaa8cc930)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I fixed several occurences of cross-references to whole manuals where
the formatting was split in the <ulink> statement. The <ulink> tag
and the manual title must be on one DocBook line in order for the
sed scripts to correctly process the links when the mega-manual is
created.
(From yocto-docs rev: 0dee12d518c892f59c0446e1c7b5d0f71b6ee22b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
the notes that say "Due to production processes..." at the start of
each manual contain links to manuals. the links needed to be formatted
such that the entire <ulink> code and manual name appeared on the same
line so that the sed script can effectively remove the link in the
resulting mega-manual.
(From yocto-docs rev: 0a41971c331ad1961e6ee1e067b59c36c9f048f6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The references to the YP Development Manual were inconsistant.
These references were fixed.
(From yocto-docs rev: f4ded0b965fcbce7b500ca21886ee9b755c38383)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way I refered to the YP Quick Start was inconsistant.
I have made edits to remove these.
(From yocto-docs rev: d9487c60db23861e8a9dd2c81ac46d4960abd462)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had to rename individual style.css sheets to have book-specific
names. So style.css for the ADT manual becomes adt-style.css and
so forth. Turns out, this isn't really necessary for the solution
to create the mega-manual but I am leaving the changes as a
separate commit because it makes sense. It causes no disruption
to making the six YP manuals.
(From yocto-docs rev: 8cbdae1fe86988243f91dfd611c14f8a37007886)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added clarification on how a user can hand-delete images from
the build/tmp/deply/images directory.
(From yocto-docs rev: 4655085d43b36b024a2e01cfcc7455e18d891ab8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the decision to create a single HTML file that has all
individual YP manuals, the need for including the BSP guide as
part of the YP Reference Manual goes away. I have removed this
guide as a chapter, removed the mention of it in the introduction,
and fixed the two links in the FAQ chapter to reference the external
manual.
(From yocto-docs rev: b0dbda9e09b73c2b26111bda118731dbb3090cae)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created a new glossary entry for the KMACHINE variable. I used
Bruce Ashfield as my resource for understanding this variable.
(From yocto-docs rev: 1069ddb3fe0b3bd00ba651b51419354258ae57d3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The string used for the link anchor for the "What You Need and
How You Get It" section in the YP QS used "resources". This
string is actually used as the chapter id for the resources
chapter in the YP ref manual. I changed the string in the QS
from "resources" to "yp-resourses" to make it unique. There was
one instance in the YP ref manual where a cross-reference to the
section occurred. I fixed that as well.
(From yocto-docs rev: 58c1e4e327cb489e037bbde170c4c495f4567392)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Converted the "Resources" appendix to a chapter. I also made sure all
the references to the chapter use proper term now, which is "chapter".
(From yocto-docs rev: bf7212b72d54a2696c16dcc1c0a19681f23fbc1c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "faq" appendix to a chapter and
made sure any references in the doc set use the proper term now
(chapter).
(From yocto-docs rev: 6e090132823e3b121d00d9116b0693c922156b32)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "ref-varlocality" appendix to a chapter and
made sure any references in the doc set use the proper term now
(chapter).
(From yocto-docs rev: d666a3f6581bb114c6c15d63ef850678c398b247)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "ref-varibales-gloss" appendix to a chapter and
made sure any references in the doc set use the proper term now
(chapter).
(From yocto-docs rev: 3f541c20c7aff1012eb4c06cb856bf9795124822)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "ref-imagese" and "ref-features" appendices
to chapters and made any references in the doc set use the proper
term now (chapter).
(From yocto-docs rev: 08117634034a5cd5567c971957583d986c9ee9a4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "ref-classes" appendix to a chapter and
made sure any references in the doc set use the proper term now
(chapter).
(From yocto-docs rev: 54991c7fb0a2d3a894249f8a253b1a974cf2e571)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
