Commit Graph

803 Commits

Author SHA1 Message Date
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
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
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
Scott Rifenbark
19e2b66838 ref-manual: Added title to kernel-dev manual as part of a section link.
(From yocto-docs rev: 5c0cb69ff1a565e037686f344269fe7238ce442e)

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
3be975ec1f ref-manual: Removed redundant link to INITRAMFS_IMAGE
(From yocto-docs rev: 62d835e0841cc19e644e79af22088880ff3eaac7)

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
f1555ad7fb ref-manual: Removed redundant link to Source Directory
(From yocto-docs rev: 9fb10f4f0ca5bed4804d77a1c224672866ee2b87)

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
aa46a82e54 ref-manual: Fixed link manual title for BitBake User Manual
(From yocto-docs rev: cad80681e72e7e22c3867961aeefe7f260c20f86)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:20 +01:00
Scott Rifenbark
3ed27b2b58 ref-manual: Removed manual title as part of a cross-reference.
The link was to a chapter in the existing manual.  I do not
include the manual title when that is the case.

(From yocto-docs rev: 1b7c65b4a2dde3f5d069cb5edc75728492639870)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:20 +01:00
Scott Rifenbark
38ca662531 ref-manual: Fixed broken link to TARGET_VENDOR
Link was going to TARGET_PREFIX.

(From yocto-docs rev: 424e8ea3168ab2e910919e6f70fc0b16332ca4f7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:20 +01:00
Scott Rifenbark
00fcff57d2 ref-manual: Removed redundant FILESEXTRAPATHS link.
(From yocto-docs rev: 74199d4a3d5fe5a9836e363522b052614a542e26)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:20 +01:00
Scott Rifenbark
13aaca36ee ref-manual: Fixed title for BitBake User Manual reference.
(From yocto-docs rev: 73249f903fcb68201937f05216bedd4fc25fb060)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:20 +01:00
Scott Rifenbark
316408a989 ref-manual: Corrected link title in DISTRO_FEATURES_BACKFILL
(From yocto-docs rev: 93c730199bb66fa6909bd0c0a2e75b5cca9534af)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:19 +01:00
Scott Rifenbark
7a91f0b4b6 ref-manual: Removed link to WORKDIR in the D variable description.
(From yocto-docs rev: edf989858c37dcdf19ec99dceb959061bc89be97)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:19 +01:00
Scott Rifenbark
267aa51859 ref-manual: Removed redundant links in COMBINED_FEATURES var.
(From yocto-docs rev: 7328ac66feebed290add2b122e12c2ea567f6bdf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:19 +01:00
Scott Rifenbark
266ed1c3de ref-manual: Updated example string for BUILDHISTORY_COMMIT_AUTHOR.
I replaced the "&lt;" and "&gt;" constructs with the tags
<replaceable> and </replaceable>.  This is the preferred formatting
for user-supplied values.

(From yocto-docs rev: 1fc32486483c545671ffb2142b553da75dbe54fe)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:19 +01:00
Scott Rifenbark
5a049e572c ref-manual: Provided more relevant link for Python documentation
In the BBMASK variable, a link to Python documentation was
going to a specific 2.6 release.  That release was probably the
most recent when the BBMASK variable was initially documented.
Python has many releases now (e.g. 3.6.5).  I re-worded the
description to be more generic and sent the user to the general
Python release area.  They can pick a release from that URL.

(From yocto-docs rev: 154aedf79625f37997bec18dba933c514072708e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:19 +01:00
Scott Rifenbark
adacc7639b ref-manual: Removed redundant link in BB_DISKMONS_DIR variable
Removed the first link to the BB_DISKMON_WARNINTERVAL variable.
The variable was linked later in the text.  No need to link
the output version of the variable... clunky looking.

(From yocto-docs rev: ec6cfc85ba2f1e2fc763b6b7c918a21cec00e203)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:19 +01:00
Scott Rifenbark
05195def10 ref-manual: Updated APPEPND variable.
Changed wording so I could reference the proper name of the
LABELS variable.

(From yocto-docs rev: 05e5f287bde8219d1f8125d71fd48a36a422009a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:19 +01:00
Scott Rifenbark
1b877bc9dd documentation: Updated everything for new overview-manual
This involved changing the root manual folder from
"getting-started" to "overview-manual".

Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was
changed to "YOCTO_DOCS_OM_URL".  Most manuals had several
occurrences of these links.

The makefile needed updating to process the new manual
and not process the old "getting-started" manual.

(From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:13 +01:00
Scott Rifenbark
982cce2d2c documentation: Fixed links to old concepts-manual
The concepts-manual is going away for 2.5.  I have fixed all the
links across the YP documentation set that were cross-referencing
into the concepts-manual so they now cross-reference into the
getting-started manual, where that concepts chapter will live
post 2.4x.

(From yocto-docs rev: e9145e9e7fef882a13c982d34514a94f864b3c12)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:12 +01:00
Scott Rifenbark
f91f4b9b36 documentation: Updated "OpenEmbedded-Core" terms.
Throughout the manual set, I made sure that "OpenEmbedded-Core"
and "OE-Core" appear with the hyphens.

(From yocto-docs rev: 1f570df3eccb74b9e2e60af94c0e0dd48e1489e9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01:00
Scott Rifenbark
cbe4169d4f ref-manual: Updated LAYERSERIES_COMPAT description.
Using "OpenEmbedded-Core" rather than "OpenEmbedded Core" in the
text.  The term as also fixed to reflect this change.  Also,
use of the phrase "OpenEmbedded-Core project" or "OE-Core project"
is not desirable.  Changing project to version.

(From yocto-docs rev: ec226fcd92847c96ea2e11d34513b597a35c9825)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01:00
Scott Rifenbark
7d62867874 ref-manual: Updated LAYERSERIES_COMPAT variable description.
Minor re-wordings from review.

(From yocto-docs rev: d4598e7e43a8bafa4ff6ddeec50febcedc41b411)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01:00
Scott Rifenbark
67158570bc ref-manual: Fixed two grammar errors.
(From yocto-docs rev: 23a0edc13f2306008c0bbb154fb0861f15d4e6de)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01:00
Joshua Watt
f2e51380fb ref-manual: Updated the SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS variable
Describes the new wildcard syntax

(From yocto-docs rev: e91db865686e7b1b9b21cb9aea892b0ed8884438)

Signed-off-by: Joshua Watt <jpewhacker@gmail.com>
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:05 +01:00
Scott Rifenbark
424f544ecd ref-manual: Added variable description for SPL_BINARY
(From yocto-docs rev: 00e579123540006c364f7751a37e29c74acf361b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:05 +01:00
Scott Rifenbark
dbf6a1f778 ref-manual: Updated the IMAGE_BOOT_FILES varaible.
Added a final paragraph that provides some cross-referencing to
the sections that describe how to use Wic and to the Wic
reference chapter.

Also, shortened the DOC info line.

(From yocto-docs rev: 4ba5d0119caa3696187537f5b4cc9c64ca00e205)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:05 +01:00
Scott Rifenbark
2bb3bcf49c ref-manual: Updated SERIAL_CONSOLE and SERIAL_CONSOLES variables.
Added a link to the "getty" term.

(From yocto-docs rev: d21fe1ea33353e15c135af7fc302ffe636310541)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:04 +01:00
Scott Rifenbark
efa4b3040d ref-manual: Updated IMAGE_INSTALL variable description.
Minor edits for clarification.

(From yocto-docs rev: fdef057927b7b0dba64b9b7f952108fdb9c97f34)

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