Commit Graph

5389 Commits

Author SHA1 Message Date
Richard Purdie
2bd173f3b5 test-manual: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 33ba40c062ca081dbcffc5400fb49e56d6f7f25e)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
Mark Morton
444666faa4 New source files and Makefile update for Test Manual
(From yocto-docs rev: d7cff640569a5772f3c366b4136762628fca534d)

Signed-off-by: Mark Morton <mark.morton@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
04118df8b0 toaster-manaul: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 4e07e51e558cda76b870be98d9aeff1a6e7bb5b8)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
995d779d55 sdk-manual: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 5b88e5e0f7a71ffefdd5e9c21520bf20692521c6)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
411a22c6ec profile-manual: Add SPDX licence headers
[Yocto #13873]

(From yocto-docs rev: 551c4a7f75e2afeb22d2638cc1e9550ec18c8cb4)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
38dbf12426 kernel-dev: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 4609c3288be259fcc582fbe946ad6b411aa96e1a)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
9a644b0eeb dev-manual: Add SPDX License headers
[Yocto #13873]

(From yocto-docs rev: eaded98195eed8adf3bba89a6b49a45383955785)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
7621a05efe brief-yoctoprojectsqa: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 8bf1b566ddeaf6223ed065e9560cc096a18fe14d)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
d674526bac bsp-guide: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 0aa081c3f1839833043e116db1729a9de342f72e)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
2e9db79a7e adt-manual: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: b2d60520431ef71ed2d1decf33605797995cb8f4)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
2f9cf90ac8 yocto-docs: Add SPDX headers in scripts and Makefile
[Yocto #13873]

(From yocto-docs rev: b87c540a1a6c0dce4c6010b89d9831442e0e7f70)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-04 13:29:02 +01:00
Richard Purdie
109a501faf poky.ent: Update XXX_HOST_PACKAGES_ESSENTIAL to include mesa for other distros
(From yocto-docs rev: e187f0f858bd4ed2eda10a5140cbc5ec222d7092)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-04 13:29:02 +01:00
akuster
f4856db1e3 poky.ent: Update OPENSUSE_HOST_PACKAGES_ESSENTIAL to include mesa-dri-devel
(From yocto-docs rev: 3003075b29bee696f226533e24ab7121508ca99b)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-04 13:29:02 +01:00
Richard Purdie
18577c0e82 poky.ent: Update UBUNTU_HOST_PACKAGES_ESSENTIAL to match recent changes
(From yocto-docs rev: 7ed90c71caa6a23d2ef3b640a880069ca3ee3d24)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-30 12:33:26 +01:00
Michael Ho
392ba004f4 ref-manual: add PACKAGE_ADD_METADATA documentation
Add a basic variable definition and a small section to the development
tasks manual for using PACKAGE_ADD_METADATA to add custom metadata to
packages.

(From yocto-docs rev: c5e4d575a771ddd1c970389ce3ace6d6abe68769)

Signed-off-by: Michael Ho <Michael.Ho@bmw.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-27 11:05:04 +01:00
Quentin Schulz
1f9ebcf8af ref-manual: document new unlisted-pkg-lics insane-skip qa check
The new unlisted-pkg-lics INSANE_SKIP QA check was introduced and need
proper documentation.

This QA check makes sure all licenses listed for all packages built by a
recipe are declared in the recipe LICENSE variable.

(From yocto-docs rev: a50e0628f3d40f9103c9a6ecccde61ad6d7f21c6)

Signed-off-by: Quentin Schulz <quentin.schulz@streamunlimited.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-21 12:36:03 +01:00
Robert P. J. Day
ff9ac2b303 ref-manual: delete long-unused comments in variable glossary
As these comments have been around since 2015 and apparently unused,
get rid of hundreds of them.

(From yocto-docs rev: afec5770a22ac51c956e87567bf39e71064e9f04)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-17 22:37:19 +01:00
Robert P. J. Day
73a31df937 ref-manual: Remove long-dead PACKAGE_GROUP variable
This was, years ago, deprecated in favour of FEATURE_PACKAGES, so
remove all references, other than the entry in the migration section.

(From yocto-docs rev: 8e5469aadd31bc3de181848aae5733cd7835eefb)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-05 13:22:00 +01:00
Robert P. J. Day
2921941876 ref-manual: typo "SSTATE_MIRROR" -> "SSTATE_MIRRORS"
(From yocto-docs rev: d694ff63f4aee0fff6eac0541413c1a36b3b02e2)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-05 13:22:00 +01:00
Robert P. J. Day
c3884f4630 ref-manual: IMAGE_TYPES, add tar.zst, delete elf
Update list of legal IMAGE_TYPES to match what's in
image_types.bbclass.

(From yocto-docs rev: 7706a240d6dbbace9a76b4b55427f91bd4afc6da)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-05 13:22:00 +01:00
Robert P. J. Day
528c43e931 ref-manual: fix excessive command indentation
(From yocto-docs rev: a95b49eef8f6bfde153677dda8021ffadf29d8f7)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-05 13:22:00 +01:00
Mark Morton
f9e1127643 Updated patch for publishing
(From yocto-docs rev: ac352ad7f95db7eeacb53c2778caa31800bd7c26)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-24 15:21:14 +01:00
mmorton
cd25abf777 Added usrmerge to distro-features for Bug 13494
(From yocto-docs rev: 049832ea4c13b01c31911ad0a6f3e170781db6cd)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-24 15:21:14 +01:00
Robert P. J. Day
fe25ef9871 ref-manual: correct "script" dirname to "scripts"
(From yocto-docs rev: 43f042582675f89fcdf81c0cd2ac2602d4282cb3)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-24 15:21:14 +01:00
Maxime Roussin-Bélanger
a44b8d2856 dev-manual: remove postinst false statement
This outdated section contradicts the real behavior expressed in the next
paragraph

(From yocto-docs rev: 77e8a9e03b3bb6e6b6b2adf7796740fb362f189b)

Signed-off-by: Maxime Roussin-Bélanger <maxime.roussinbelanger@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-15 22:56:23 +01:00
Paul Eggleton
c31ddaba1f ref-manual: add migration section for 3.1
Migration information for the 3.1 release.

(From yocto-docs rev: dda13761733c7f3fe672f45b8d06f6c3fcf8cb30)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-15 22:56:23 +01:00
Paul Eggleton
545c067f9a dev-manual: basic updates for npm fetcher changes
Update the npm:// URL and the generated npm recipe, and remove
references to NPM_SHRINKWRAP, NPM_LOCKDOWN and lockdown functionality in
general.

(From yocto-docs rev: bc09233543abbf28adfcc1e214f85ef4c7c56639)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-15 22:56:23 +01:00
rpjday@crashcourse.ca
51ecc1069a ref-manual: update PACKAGECONFIG glossary entry
Update the glossary entry for PACKAGECONFIG in two ways:

1) Explain the recent sixth argument, which identifies conflicting
   features for a given feature.
2) Use a different example, as the librsvg "croco" feature no
   longer works that way.

(From yocto-docs rev: af9bf61a54c059e72c807ca8061a57d6fe74c5fa)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-07 22:00:10 +01:00
Robert P. J. Day
c063e37425 overview-manual: fix obvious typo "ORHNAME"
(From yocto-docs rev: d40485a7eecb8d54179b562f05b4d7b044bb03b2)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-07 22:00:10 +01:00
Robert P. J. Day
4a115c52cf dev-manual: clarify how to select "read-only-rootfs"
For stylistic reasons, clarify the use of both IMAGE_FEATURES versus
EXTRA_IMAGE_FEATURES when configuring a read-only rootfs.

(From yocto-docs rev: 4111e4e70a87400671455ddd873d802d40d6b587)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-07 22:00:10 +01:00
rpjday@crashcourse.ca
9a5aa31870 dev-manual: use "git", not "apmd", to explain checksum names
The apmd recipe is no longer appropriate to demonstrate the use of
SRC_URI checksum names as it has only a single SRC_URI URL, so pick a
more illuminating recipe.

(From yocto-docs rev: 7f391a0656442e7ee2f3dd48b848befb7f461aec)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 16:53:24 +01:00
rpjday@crashcourse.ca
43ad3f54ea dev-manual: use "strace" for PV example, not cdrtools
Section 3.3.5, "Fetching Code", uses the cdrtools recipe as an example
for showing the use of PV, but that's a bad example since the current
cdrtools recipe file contains:

  SRC_URI = " \
  ${SOURCEFORGE_MIRROR}/project/cdrtools/cdrtools-${REALPV}.tar.bz2 \
  ...

  PV = "3.01a31+really3.01"
  REALPV = "3.01"

which is not exactly the point the dev manual is trying to make, so
replace with simpler strace recipe.

(From yocto-docs rev: d865b0288a4162a8d4df9a2abde43875e3dc2ced)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 16:53:24 +01:00
Tim Orling
3b718dbdae brief-yoctoprojectqs: buildtools changes
Bump tar, Python versions and add new gcc requirement.

Update reference from 'required-git-tar-and-python-versions'
to 'required-git-tar-python-and-gcc-versions'

(From yocto-docs rev: ca6334c1653d5e2abfe77865391509a8cd516d88)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
edaad681fb dev-manual: buildtools versions and changes
Bump tar, Python versions and add new gcc requirement.

Update reference from 'required-git-tar-and-python-versions'
to 'required-git-tar-python-and-gcc-versions'

(From yocto-docs rev: 18b11662c7c9ab7828d2709eed4090116a751e14)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
07aaa69d57 ref-manual: add install-buildtools and -extended
Add instructions to use 'install-buildtools' and
'buildtools-extended-tarball'.

Add gcc 5.0 requirement and call out how to
use above to prepare host development system.

(From yocto-docs rev: c6dbd9bf6860ffea1bc025907343373439d91737)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
e75301e018 ref-manual: fix debian-8 system reqs
jessie-backports is no longer supported, so python3-git and
pylint3 are not installable via apt-get (or at least not
without disabling security checks by using archive.debian.org)

Add note to use pip3 to install instead.

(From yocto-docs rev: 19a02c5c6ef9a317c2339c2ec71200e51335e32f)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
2888172856 ref-manual: bump tar and python min versions
* tar min version is now 1.28
* python min version is now 3.5

(From yocto-docs rev: 96dfaee63f84c21fc2bf460ded642b853a5317cf)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
cdca9b23c9 ref-manual: split CentOS-7 and CentOS-8 reqs
CentOS-7 has different requirements than the much
newer CentOS-8. Add a section for CentOS-8 and
make the old section CentOS-7 specific.

NOTE: at the time this was written, the 'fop'
package is not yet available in epel-8. As
a Fedora packager, that will change.

(From yocto-docs rev: caf08811a23a29965ec915459019796a0c882d4d)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
cb6bb9d914 poky.ent: split centos-7 and centos-8
Update Centos-7 to require python3, not python.

CentOS-8 has different installation requirements than
either CentOS-7 or Fedora (although it is closer to
Fedora).

Allow for differentiation between CentOS versions.

(From yocto-docs rev: 615fc45108d10e842679b3d8a38b53074d3eed4b)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
85cc7cb4df poky.ent: recommend python36-pip for CentOS
'python3' in EPEL7 is now Python 3.6, so we
should be recommending python36-pip

Python 3.4 is EOL [1]

[1] https://www.python.org/downloads/release/python-3410/

(From yocto-docs rev: 817ca8adc91d9975b9ec57e7fead7fdff4001854)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
akuster
24dab56884 documentaiton: Change author info
Update the author indo and use variables for author and email to make it
easier to change in future.

(From yocto-docs rev: 4fdf2a060705fa00b11b5a9d270f4ffa506c9927)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
d4a3a121ed BSP Guide: numerous tweaks/grammar/wording/clarification
(From yocto-docs rev: 3a87e5900b603f124ce7f63fd072415762f63212)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
284af91476 kernel-dev: fix explanation of KBUILD_DEFCONFIG
KBUILD_DEFCONFIG is meant to refer to an *in-tree* defconfig file, not
an external one.

(From yocto-docs rev: 34202eee3fc2bb4e0b92374822bff87fd3af1ebc)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
0096b10efe correct mention of "postinst_intercept delay_to_first_boot"
Migration to YP 2.5 contains incorrect description of routine for
delaying to first boot.

(From yocto-docs rev: 08f71ec137822c0c19b56956d7045dfb73a544d7)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
4f58e37e17 ref-manual: minor rewording/clarification in chapter 2
(From yocto-docs rev: a9a3248b12b85f3637ebe5eddd4b1a29268d5598)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
77f6e7bb4e ref-manual: minor rewording in chapter 1
(From yocto-docs rev: 5582f01fc4774e7d21af24627bbd47a77463d272)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
5486dd3680 ref-manual: update PROVIDES example, clarify use of "+="
Update the example used in explaining the PROVIDES variable to one
that actually exists, and point out that "+=" is unnecessary, a simple
assignment is sufficient.

(From yocto-docs rev: 80cd888ee81757bc5281f174b26974391ee45522)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
f63d44ab32 ref-manual: various touchups, rewordings, corrections to Ch 5
Minor tweaks to chapter 5 of reference manual, including:

 - grammar
 - adding slashes to directory names for consistency
 - collapse trivial paras into one

(From yocto-docs rev: 96b75e723bff042183f70a858d09df4aad094578)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
a5ac4b6fca use defined entity "YOCTO_DOCS_URL", not "YOCTO_HOME_URL"
Given the defined DocBook entity:

  <!ENTITY YOCTO_DOCS_URL "&YOCTO_HOME_URL;/docs">

replace numerous instances of the more verbose
"&YOCTO_HOME_URL;/documentation", which is a redirect, anyway.

rday

(From yocto-docs rev: 53fa17321624028b12d880bc4236fbef46675eb4)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
b31daa130a dev-manual: minor tweaks, rewording, grammar for chapter 2
(From yocto-docs rev: 706386ac094479916e1cc482e56a6433caa85e1a)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00