Commit Graph

1845 Commits

Author SHA1 Message Date
Kristi Rifenbark
25d3577a61 ref-manual: Removed the do_rm_work_all Task
(From yocto-docs rev: 74a90f766a38c425a6ceb8a50ad24b23460f9640)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-28 09:22:58 +01:00
Kristi Rifenbark
2a74e8fb94 dev-manual, ref-manual: Documented NO_GENERIC_LICENSE
FIXES [YOCTO #12734]
Added a new variable description and created a new
section in the dev-manual.

(From yocto-docs rev: 854e641482171585c96ee5b9387b3e64146072b9)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-28 09:22:57 +01:00
Scott Rifenbark
985d863023 documentation: Set up the 2.6 version of the docs
poky.ent - Edited for new variables.
<manual>.xml - Manual revision tables updated
mega-manual.sed - swapped out 2.5 for 2.6

(From yocto-docs rev: 2bae8fa18ae82a325785276acdeb1394e110d2cf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:36 +01:00
Scott Rifenbark
9a37a3d568 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:16:35 +01:00
Kristi Rifenbark
bd4438f4a4 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:16:35 +01:00
Scott Rifenbark
1fc547845e 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:16:35 +01:00
Scott Rifenbark
51c74acdad 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:16:34 +01:00
Scott Rifenbark
c72b126bc0 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:16:34 +01:00
Kristi Rifenbark
6da15e51a8 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:16:34 +01:00
Scott Rifenbark
50c83e8b70 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:16:33 +01:00
Kristi Rifenbark
8d751c065d 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:16:33 +01:00
Scott Rifenbark
d96c451901 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:16:33 +01:00
Scott Rifenbark
63d56741ed 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:16:33 +01:00
Scott Rifenbark
4cd96b295e 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:16:32 +01:00
Scott Rifenbark
8436b7a6a9 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:16:32 +01:00
Scott Rifenbark
7815287d6b 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:16:31 +01:00
Scott Rifenbark
8a2291f5e7 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:16:31 +01:00
Scott Rifenbark
6cc546ca61 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:16:31 +01:00
Scott Rifenbark
0b99c7dd2a 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:16:31 +01:00
Scott Rifenbark
b6f84351f3 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:16:30 +01:00
Scott Rifenbark
445e13ae35 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:16:30 +01:00
Scott Rifenbark
d77de6b09f 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:16:30 +01:00
Peter Kjellerstedt
27fb732a64 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:16:30 +01:00
Scott Rifenbark
8dabbc9ff3 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:16:30 +01:00
Scott Rifenbark
3391d1d8e2 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:16:29 +01:00
Scott Rifenbark
083353b73b 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:16:29 +01:00
Scott Rifenbark
588e353a1e 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:16:28 +01:00
Scott Rifenbark
4559692ae1 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:16:24 +01:00
Scott Rifenbark
085e6c96df 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:16:23 +01:00
Scott Rifenbark
98affc3ef5 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:16:23 +01:00
Scott Rifenbark
6382d33501 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:16:23 +01:00
Scott Rifenbark
804ce3031d 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:16:23 +01:00
Scott Rifenbark
b7ee4ab92d 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:16:23 +01:00
Scott Rifenbark
d7d05b717d 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:16:23 +01:00
Scott Rifenbark
0a340732de 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:16:22 +01:00
Scott Rifenbark
4a64457555 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:16:22 +01:00
Scott Rifenbark
e1a17f030a 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:16:22 +01:00
Scott Rifenbark
0bd0b588f5 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:16:22 +01:00
Scott Rifenbark
dce3b0a5ef 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:16:22 +01:00
Scott Rifenbark
d13d95ab89 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:16:22 +01:00
Scott Rifenbark
1797b6f5fd 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:16:22 +01:00
Scott Rifenbark
74cefbb5f7 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:16:22 +01:00
Scott Rifenbark
0a166133ff 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:16:22 +01:00
Scott Rifenbark
541038201b ref-manual: Removed redundant link to DEPENDS
(From yocto-docs rev: ddd59a0ae4eda76c9e9c284ce9db4428a925e610)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:21 +01:00
Scott Rifenbark
bf2d20e8fa ref-manual: Removed redundant link to OVERRIDES variable.
(From yocto-docs rev: b336d7f504bb931d9b2743ee86ff104080692bec)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:21 +01:00
Scott Rifenbark
c685be48ae ref-manual: Updated PACKAGECONFIG_CONFARGS variable description.
Several redundant links and wordings in this description.

(From yocto-docs rev: bb9dd8ab6ef9cad387cdddada4f2be093551e38a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:21 +01:00
Scott Rifenbark
a219a33178 ref-manual: Removed redundant link to DEPENDS variable.
(From yocto-docs rev: 6ecf6a692d759c783355581e227ff861e9492115)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:21 +01:00
Scott Rifenbark
6ad191158f ref-manual: Fixed broken link.
A migration item had taken the original section for the target of
the link out.  I had not changed it.

(From yocto-docs rev: 10cfaee50455bf10450540f1b381d33f9babf985)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:21 +01:00
Scott Rifenbark
0dc75ba3de ref-manual: Fixed capitalization in section title link
(From yocto-docs rev: 945038155d9941dc94001325416221f77726015d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:21 +01:00
Scott Rifenbark
5414ac6875 ref-manual: Added kernel-dev title to links
Two instances where links were going into the kernel-dev manual
but the manual title was not being used in the text.  Added it.

(From yocto-docs rev: 1922f8c79d1667db1fc9b5fe57030302469ca09c)

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