Commit Graph

1852 Commits

Author SHA1 Message Date
Scott Rifenbark
5b5ebab299 documentation: Updated for a 2.5.1 release
poky.ent - updated variables for 2.5.1
mega-manual.sed - updated string from "2.5" to "2.5.1"
<manual>.xml - updated manual revision tables for 2.5.1
               and September 2018 date

(From yocto-docs rev: a47382f00ad1a5a1df02ffa3dead7a0bd597bf45)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:12 +01:00
Scott Rifenbark
be203dd40c ref-manual: Removed non-existant variable from PACKAGE_WRITE_DEPS description
Took out an occurrence of PACKAGE_WRITE_DEPENDS

(From yocto-docs rev: e983c3215139b566ea02df6e6160b05fdcbce081)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:12 +01:00
Scott Rifenbark
c90bfdf5d4 ref-manual: Updated DISTRO_NAME variable description.
I provided some real detail on this variable.  It was woefully brief.

(From yocto-docs rev: 6b40243984b7cc69a291b6f90ed04b45b7ce3ac5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:12 +01:00
Scott Rifenbark
84178b1fd5 ref-manual: Updated the DISTRO variable description
I added a cross-reference to the "DISTRO_NAME" variable as it is
the long version of the distribution name.

(From yocto-docs rev: c707da8121171cc81e0d07ac14369b0045de5119)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:12 +01:00
Scott Rifenbark
b679ee1519 ref-manual: Fixed cross-reference wording in SDK_LOCAL_CONF_WHITELIST
Wording did not match that of similar SDK variables.

(From yocto-docs rev: 6fab0bbc62e7f9caf020718a4a8fd047b9fb450f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:12 +01:00
Scott Rifenbark
af9c2c5565 ref-manual: Fixed grammar error in SDK_INHERIT_BLACKLIST description
(From yocto-docs rev: 4ead5a0a8b9ca862ba86e285a7981036018dfb70)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:12 +01:00
Scott Rifenbark
9abadbb3c6 ref-manual: Added cross-reference to SDK_LOCAL_CONF_BLACKLIST var
Put in a cross-reference to the section in the sdk-manual where it
talks about customizing the configuration of the extensible SDK.

(From yocto-docs rev: 23e4a2d0f461a8c672aa3780965ca4e30d1aac50)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:12 +01:00
Scott Rifenbark
4b47d39d77 ref-manual: Updated the SDK_INHERIT_BLACKLIST variable description
Added information on the class in which the default is set.  Also,
put in a reference for more information on customizing the
extensible SDK configuration.

(From yocto-docs rev: 1ca9f8dd90cccb4692c16d7757b80bfd50237495)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:12 +01:00
Scott Rifenbark
6745cc9b8a ref-manual: Updated the SDK_LOCAL_CONF_WHITELIST variable description
Enhanced this description by indicating the class that it is set in
and by including a pointer back into the sdk-manual where filters
are described for extending the extensible SDK.

(From yocto-docs rev: 22dcaf2c75532f45111b79db067edfc92212441e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:11 +01:00
Scott Rifenbark
b298bb586e ref-manual: Updated the SDK_LOCAL_CONF_BLACKLIST variable description
Added more detail including the class that sets the default variables
for exclusion and the list of actual variables that are excluded by
default.

(From yocto-docs rev: 7764a54add2911c2da8174e48e4d3166a873d63a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:11 +01:00
Scott Rifenbark
a9bdc538e6 dev-manual: Moved "Speeding Up the Build" and renamed it.
Renamed to "Speeding Up a Build" and moved out of the setting up
chapter to the common tasks chapter. Fixed a couple links in the
ref-manual.

(From yocto-docs rev: c53fddd353230c8ef1abc21c7a2d2b1f492f034a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:05 +01:00
Kristi Rifenbark
9ec257403e ref-manual: Finalized edits on the 2.5 Migration section
(From yocto-docs rev: 54259a4d4d69be73e7c614baa2a8d87faa2e3ea5)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:05 +01:00
Scott Rifenbark
802df60c97 dev-manual: Changed "Working With Yocto Project Source Files" title
Changed to "Locating Yocto Project Source Files".  I am moving the
sections on cloning repositories out from under this section.

(From yocto-docs rev: 3889aadab9b603097b6cc5b7afb9d0066021106c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:05 +01:00
Scott Rifenbark
15fa336a1f overview-manual, dev-manual: Moved licensing how-to stuff to dev-manual
The section on licensing in the overview-manual was really "how-to"
information.  I moved this to a new section in the dev-manual for
"working with licenses".  I fixed some references in the ref-manual and
in the bsp-guide as well.

(From yocto-docs rev: f150a1ea2da900aae88fc5fa60f4115cc213ba2d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:04 +01:00
Scott Rifenbark
4e2918d17e ref-manual: Chanaged a link to Wayland topic.
The Wayland and Weston topic moved from the overview-manual to the
dev-manual.  The lone link to this topic was in the ref-images
chapter.  I updated the link.

(From yocto-docs rev: 6c335f8d3618e3285f91fe20aea33a1c1f1c0ddf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:04 +01:00
Kristi Rifenbark
56a780bf26 ref-manual: Formatting pass of 2.5 Migration section
(From yocto-docs rev: 50308cc7f04d3fc54c06766f85e15e76a99f0b4b)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:04 +01:00
Scott Rifenbark
372e47e927 documentation: Removed release date ENTITY
Now that 2.5 has released, I replaced the ENTITY variable used for
the moving month and year with the actual release month and year
(i.e. May 2018).

(From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:04 +01:00
Kristi Rifenbark
1c36ba246d ref-manual: Added 2.5 Migration Section
(From yocto-docs rev: 5d6c1b69e5559eced5142f46421302f61c95404c)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:04 +01:00
Scott Rifenbark
f0c51b94cc ref-manual: Updated the SDK_OUTPUT variable
Added more realistic information on how this variable is set.

(From yocto-docs rev: 47e6cb7d00eeb8001c4a53c13600feb5ef4d4660)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:03 +01:00
Scott Rifenbark
dae0aa5a9a ref-manual: Updated SDK_HOST_MANIFEST variable.
Grammar fix.

(From yocto-docs rev: aa5a60c8e3bf3f243678169b323e7ea5df7a6c19)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:03 +01:00
Scott Rifenbark
08ccc9c864 ref-manual: Updated PACKAGE_CLASSES variable note.
The note about the TAR backend not working was changed to soften
the warning.  It has "limited functionality" rather than
"broken".

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:03 +01:00
Scott Rifenbark
ce95b0483a ref-manual: Updated the STAGING_DIR variable description.
This variable plays a much smaller role since recipe-specific
sysroots were implemented.  I have rewritten the description to say
that STAGING_DIR helps construct the recipe-sysroots directory.

(From yocto-docs rev: c1ad18abe67111738efc18725c4f7706b55738cb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:02 +01:00
Scott Rifenbark
a6cec71d97 ref-manual: Updated the PKGDATA_DIR variable description
Added a reference to the STAGING_DIR_HOST variable, which is part of the
default directory used as the shared, global-state directory holding
data generated during the packaging process.

(From yocto-docs rev: d68dcec327e96f1da0879681dcde43d4f1769af0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:02 +01:00
Scott Rifenbark
461dba44fa ref-manual: Updated STAGING_DIR_HOST variable description.
Fixed some grammar issues.

(From yocto-docs rev: 5d19e2102d1251dd4fa561995c29191c1489f7fc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:02 +01:00
Scott Rifenbark
3f21849152 ref-manual: Revision updates to BUILDHISTORY_FEATURES variable.
Re-oredered the four options to be alphabetical.

(From yocto-docs rev: 7976ee05c935fd6c24abea99f71436003656cc73)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:02 +01:00
Scott Rifenbark
7cbf582ac1 ref-manual: Updated the FILESPATH variable description
Added some key references to the patching areas of discussion across
the manual set.

(From yocto-docs rev: f198529b3072a4a03fd368ea307e8e004c46a344)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:01 +01:00
Scott Rifenbark
e0b42062a2 ref-manual: Added a link to the patching section in the SRC_URI variable
The file:// protocol is primarily used for digging out patch files that
are local with the metadata (layer).  I put a link in the paragraph that
is talking about them to the "Patching" section in the overview-manual.

(From yocto-docs rev: 18a7b4b81d192fb2cfd96763de4cfabd61c3a0ea)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:01 +01:00
Scott Rifenbark
e73f2204fb ref-manual: Review edits added to do_patch task
Mentioned the role of SRC_URI earlier in the description as it is key.
Replaced "some_recipe" with "some_package" as the emphisis is not on
the recipe at that point in the example.

(From yocto-docs rev: f7f86941fdf866a693386335374f835078db3ddf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:01 +01:00
Scott Rifenbark
30f70172bf ref-manual: Updated do_patch task description
I added more content to this task description to help describe how
patching is performed and how the task uses the "apply" parameter
that can be provided with the SRC_URI variable.

(From yocto-docs rev: 6717a3326b0005f6a57be4cc026693b7cd9e8d08)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:01 +01:00
Peter Kjellerstedt
3b33767b75 ref-manual: Updated the BUILDHISTORY_FEATURES variable description
Added a new feature (task) to the list of available features you
can use with the variable.  The "task" feature saves output file
signatures for sstate tasks.

(From yocto-docs rev: 0669580ce40c46f0b5f8204a6b00e11f725a383c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:01 +01:00
Scott Rifenbark
e392813249 ref-manual: Added "Patching" section reference to do_patch task
(From yocto-docs rev: 48335f99d896994283042752bd9ec4d20bd6d363)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:01 +01:00
Scott Rifenbark
b57adc5531 ref-manual: Updated the TARGET_OS variable description
Provided a more complete and clear description.

(From yocto-docs rev: 65505debfb82536e7e2d4ff7e5bc14c6af1a7cf6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:00 +01:00
Scott Rifenbark
e918f3b194 ref-manual: Updated PACKAGE_ARCH variable description.
I added a link to the BUILD_ARCH variable.  The variable is part
of the glossary but for some reason there was no link to it.
I also added a note for a link to the SDK_ARCH variable, which
was described inline.  By convention, I do not like to link to
variables inline as the underlining used to indicate a link messes
with with underscore characters that are usually a part of a
varible's name.

(From yocto-docs rev: a2f487141375ee7ce226eece85424e709ddc67a3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:00 +01:00
Scott Rifenbark
92de2a42c3 documentation: Added ENTITY variable to track a release date and year
(From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:00 +01:00
Scott Rifenbark
b0ede7711c ref-manual: Updated the sections pointing to the YP Release Notes.
The method for accessing the YP Release Notes for YP 2.5 forward
is to go to the "DOWNLOADS" page of the main YP website and then
click on the "RELEASE INFORMATION" button.  No longer does a user
need a simple URL.  I updated the two spots in manual where this
information existed for accessing Release Notes.

(From yocto-docs rev: 1e171d3add1048fb81c5a05a11c8ddbaf88e0ecd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:55 +01:00
Scott Rifenbark
2c4b4f9ff7 ref-manual: Updated the Bugzilla section
Provided a link to the YP implementation of Bugzilla.  Added a final
paragraph noting the Bugzilla website if you want general information
on Bugzilla.

(From yocto-docs rev: 78c99c8f42edfee377431cacc10b9ccd4b25c4cf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
cd41bc3eeb ref-manual: Removed redundant TMPDIR link.
(From yocto-docs rev: d4f09d3d0facdd5045a6c46b9658427227a79efc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
6275a8060c ref-manual: Fixed link to the kickstart chapter
Link was not going to the top of the chapter.

(From yocto-docs rev: 52da20604a54d16645b4bb4e5e9efa748a00d2f5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
5427738178 ref-manual: Fixed TARGET_ARCH formatting.
(From yocto-docs rev: 01d4e8be38514dfd05920305c2fdd71ad1cd4925)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
1932a50543 ref-manual: Removed redundant link to CXXFLAGS variable.
(From yocto-docs rev: 67c3b32c5e6d98f530bb27b81847aeb77c1de1d5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
c5d630c915 ref-manual: Removed some redundant links.
Removed redundant link to CFLAGS in the TARGET_CFLAGS variable
description.

Removed redundant link to CPPFLAGS in the TARGET_CPPFLAGS
variable description.

(From yocto-docs rev: aa95485d44f92b831cd111dbc5bf75526d239db4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
e21e2874a1 ref-manual: Added "class" as part of a link to a class.
(From yocto-docs rev: e6ee6d5b32fa8a9945b23279c3403e14dac7165b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
2501e84f9a ref-manual: Added "class" as part of a link reference to a class.
(From yocto-docs rev: d563458d4f10ead158c54736098e6c601ed305c3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
8fe2c674d0 ref-manual: Created better wording for link ambiguity
The wording to two links (one a variable and one a section in a
different manual) was ambiguous.  I added phrasing to remove that
issue.

(From yocto-docs rev: 3b70b4287ca8b2583e0ef559125f1531a2bb6a67)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
960fafddb6 ref-manual: Removed redundant links to the WORKDIR variable.
(From yocto-docs rev: 9a12678b14d9870b4ef983f5a9b47cfa3184d4a6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
57dcb02359 ref-manual: Removed the link to SDK_DIR in the example.
(From yocto-docs rev: 414b74da4afac77f231770f2746f1c2d3947d340)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:54 +01:00
Scott Rifenbark
9332007f1f ref-manual: Fixed formatting in SDK_DIR example.
Removed the link to WORKDIR to begin with.  Also, removed the
<filename> formatting that was within the example, which is buried
in a <literallayout> tag set.  Doing that screws up the formatting.

(From yocto-docs rev: 0d13dabaa13e5426da35b5d8147f51efa349b5bb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:53 +01:00
Scott Rifenbark
f765e8d7a3 ref-manual: Updated SDK_DEPLOY variable description.
Added "class" as a modifier after refering to the "populate_sdk_base"
class.

Removed link to the TMPDIR variable in an in-line example.

(From yocto-docs rev: 7733a4464ba2893a2363f47996f48587a86eaa82)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:53 +01:00
Scott Rifenbark
4e833ce95e ref-manual: Removed redundant link to PACKAGES.
(From yocto-docs rev: d9482b43c1166ef2fd663c903a15222c66faf979)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:53 +01:00
Scott Rifenbark
ce55c5bdb4 ref-manual: Removed redundant link to the distutils class.
(From yocto-docs rev: 5a097baecff0e0cabf1749abcc3697210ab63b47)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:53 +01:00