Commit Graph

1832 Commits

Author SHA1 Message Date
Michael Opdenacker
85bfe72efe migration-guides: release-notes-4.2: add doc improvement highlights
(From yocto-docs rev: 66b5f10bf0747b6ae0a8fbb05103e2f1070b6474)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-26 17:32:50 +01:00
Michael Opdenacker
1db44f2242 dev-manual: init-manager.rst: add summary
Comparing init managers by features

(From yocto-docs rev: 1039bbe55b5b7375e8dd969940bbd656115a5ab0)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-03 10:00:32 +01:00
Michael Opdenacker
b01a12a135 manuals: expand init manager documentation
- Add details about INIT_MANAGER
  Correct the fact that "none" currently generates
  an image with "sysvinit", at least on Poky.
  This behaviour should probably be changed.

- Expand the "Selecting an Initialization Manager" section.

- Stop mentioning "rescue image" generation, as this
  is not detailed anywhere else.

(From yocto-docs rev: fd99f2753b50b7ad6133b787b90331fcb3a35152)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-28 14:46:17 +01:00
Michael Opdenacker
9b6a25606e manuals: document SPDX_CUSTOM_ANNOTATION_VARS
(From yocto-docs rev: 5811f4eb3e73aa5f8ca90e40ec6559a6d4d58fa3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Saul Wold <Saul.Wold@windriver.com>
CC: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-28 14:46:17 +01:00
Michael Opdenacker
aa6c2cc60e overview-manual: update section about source archives
Except the "yocto" and "uninative" directories, everything
under https://downloads.yoctoproject.org/releases/, in particular
"bitbake".

Point to https://downloads.yoctoproject.org/releases/yocto/
instead for people interested in tar archives.

Simplify the description too, unnecessarily verbose.

(From yocto-docs rev: 502b00003b1c84d7b419f01b87a6ab6a121a7ad9)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-28 14:46:17 +01:00
Paul Eggleton
7508711b38 dev/ref-manual: Document INIT_MANAGER
The INIT_MANAGER variable was added in 3.0 but it seems we didn't get
around to documenting it yet. I have added a variable glossary entry and
made the basic adjustment of the "Using systemd Exclusively" section in
the dev manual, however I think the latter section still needs work.

(From yocto-docs rev: 602c0e8f770516256dab04edfd887377303c06bb)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:54 +01:00
Paul Eggleton
62031fbfce dev/ref-manual: Remove references to INC_PR
This technique is no longer used (nor necessary), let's just remove it
to avoid any confusion.

(From yocto-docs rev: 8f50d0bf22fea8064c112f52df06dbd6a85a7a83)

Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-22 10:42:53 +01:00
Michael Opdenacker
311c76c8e8 manuals: improve and fix target for supported distros
- Fix the location of the target for supported distributions
- Improve the name of this target

(From yocto-docs rev: 40f0cf9302b9f0ce01a1270977644b1b2fdfc650)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-06 14:35:18 +01:00
Michael Opdenacker
3525a67b0c manuals: add "LTS" term
(From yocto-docs rev: 70536fa188101c8fdd6bbca8343829c4f798ef47)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-03 14:48:47 +01:00
Michael Opdenacker
71b964b0dc manuals: add rm_work disk space data
(From yocto-docs rev: 8121a02cde6b0149aef441926c5b8e89cb9854df)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-03 14:48:47 +01:00
Michael Opdenacker
8355326ffa manuals: simplify references to the BitBake User Manual
- Replacing
  :ref:`bitbake:bitbake-user-manual/...`
  by :ref:`bitbake-user-manual/...`

  Adding "bitbake:" as a prefix is not necessary
  as there is no naming conflict between the YP
  and the BitBake manuals (all documents are in
  "bitbake-user-manual/")

- Explaining the rules in the README file

- When necessary, fixing line length in the modified paragraphs.

(From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-03-20 13:16:52 +00:00
Michael Opdenacker
a354dc9c62 dev-manual: new-recipe.rst: add references to subsections in Examples section
Making it possible to jump right away to the desired example

Rename a section title to make it more suitable for a link title.

Using short references (`Section Name`_) instead of
:ref:`dev-manual/new-recipe:Section Name`) as we are in the same
document.

(From yocto-docs rev: 4058998dbeba4262ccced8999be338c04c324b48)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:25 +00:00
Michael Opdenacker
f279a84ee7 dev-manual: new-recipe.rst: add Meson example recipe
(From yocto-docs rev: 30cded4e59020a98205877970c530de35da46a60)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:25 +00:00
Michael Opdenacker
efc97fe720 manuals: document COMMERCIAL_[AUDIO|VIDEO]_PLUGINS variables
- Add COMMERCIAL_[AUDIO|VIDEO]_PLUGINS variables to the
  variable index.
- Clarify that these plugins are still open-source
- Improve line width

(From yocto-docs rev: 8b161faad6b698b33165f02e1f5e78a693c7817b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:25 +00:00
Michael Opdenacker
fdc5849e3c dev-manual: sbom.rst: add link to FOSDEM 2023 video
(From yocto-docs rev: 05f3c98e83830ccdde4289727d0bab563b8ea900)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:25 +00:00
Michael Opdenacker
1e14e7cc79 dev-manual: new-recipe.rst: restructure examples
To make it possible to add more examples (CMake, Meson, Go, Rust...)
- Change section title names
- Adjust paragraph line length
- Have the Autotools example after the one with a custom Makefile,
  corresponding to an increasing level of complexity.
- Clarify that GNU make and the Autotools are used to build
  the applications, not by these applications.

(From yocto-docs rev: 6f313e673fe4d2878c8166619c27c4958af73615)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:25 +00:00
Michael Opdenacker
6445a38285 manuals: update patchwork instance URL
https://patchwork.openembedded.org/ has been since long discontinued
Also better to mention https://patchwork.yoctoproject.org/
than the patchwork home page.

(From yocto-docs rev: 15e2f662c9c519f54cd2c8b99c817725ed4c357b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-24 15:43:24 +00:00
Ulrich Ölmann
ba0be66d39 dev-manual: fix old override syntax
(From yocto-docs rev: d578d6e09466dee26d30ccef5fdb3ce9b0d350f7)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-02-10 11:03:36 +00:00
Michael Opdenacker
8b1909aa6f manuals: simplify references to classes
Now that .bbclass is removed from class section titles.
We can now have, for example, :ref:`ref-classes-insane`
instead of :ref:`insane <ref-classes-insane>`.

Then, when necessary, rework paragraphs so that they
have lines of even length, not exceeding 80 characters.

(From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-01-06 17:39:09 +00:00
Michael Opdenacker
6846d4d00b manuals: define proper numbered lists
Using "#." instead of "1.", "2.", "3.", etc.

(From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
766a44b8e3 manual: improve documentation about using external toolchains
- Remove the redundant FAQ entry about this topic,
  already covered in a specific section of the Development Tasks manual

- Document the TOOLCHAIN_LOCATION variable

- Expand both the Development Tasks manual and
  the TCMODE variable description using details from the FAQ entry.

- Mention the "meta-arm-toolchain" layer too.

(From yocto-docs rev: 53faa54a8e6311b4d3d41d96cb1a497d0f6502fb)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
01e5d22507 manuals: fix double colons
Fixing double colons appearing alone on a line, while
they could be put at the end of the previous line.

Sometimes placing a note after the quoted text
to avoid such a situation. It's more natural too
not to have a note between the introduction text
and the quoted section.

(From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
f417d3274c manuals: add missing references to variables
[YOCTO #14508]
(From yocto-docs rev: 7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Mikko Rapeli
891dfba7a0 dev-manual/runtime-testing.rst: fix oeqa runtime test path
It's "runtime/cases" in master and kirkstone.
If layer specific tests are in "runtime" directory,
they will not be found.

(From yocto-docs rev: 8d0d56cea5373c928feaaba316038c84130b52e7)

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
0825238c3d dev-manual/sbom.rst: minor corrections
(From yocto-docs rev: 56bf7a3e521e7368e620685354aa89f540bb7564)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
945c669138 manuals: split dev-manual/common-tasks.rst
A 500 KB source file is always harder to manage,
and can have section title conflicts.

So, the "Common Tasks" document is gone and all
its constituents are moved up one level.
You now have 40 chapters in the Development Tasks Manual.

(From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
4d01625794 manuals: fix paragraphs with the "inherit" word
Nothing wrong with this word, but instances of "inherit"
were looked for while looking for class names without references.
Fixing alignment and sometimes syntax.

(From yocto-docs rev: c418c645a360e74ebb91765a3041336f03097e0d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
55621c31f1 manuals: add missing references to classes
Sometimes fixing line length in modified paragraphs too.

[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Atanas Bunchev
7ecd9877e6 qemu.rst: slirp port forwarding details
Explain the default behavior of `runqemu slirp`.
Explain how to forward ports from the guest to the host machine.

(From yocto-docs rev: 239314da5998f27d0e3a0f2e538216e852bb19d8)

Signed-off-by: Atanas Bunchev <atanas.bunchev@konsulko.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Atanas Bunchev
e39e68053f qemu.rst: audio: reference to Command-Line options
The previous statement can cause confusion, because this is the
first time when the `audio` argument is mentioned.

(From yocto-docs rev: c8aa98a4b21d056ebf49b8ab43838989e9185c81)

Signed-off-by: Atanas Bunchev <atanas.bunchev@konsulko.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-10 22:12:56 +00:00
Michael Opdenacker
3a7dd1d368 manuals: add shortcut for Wikipedia links
(From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Michael Opdenacker
a4dee23387 dev-manual: common-tasks.rst: add section about SPDX / SBOM generation
Also stop refering to the meta-spdxscanner class, no longer
relevant.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Ulrich Ölmann
7f3e02fe74 dev-manual: common-tasks.rst: fix typos
(From yocto-docs rev: 680f48a94cec063779797c55a9bfe461289a98e3)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Michael Opdenacker
b44fbe5b1b manuals: use references to the "Build Directory" term
Replace instances of "Build Directory" and "build directory"
(when applicable) by :term:`Build Directory` as already
done in most places.

Doing this, fix the indentation of the paragraphs with
this term.

(From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Michael Opdenacker
6f4ccc4dad manuals: stop referring to the meta-openembedded repo from GitHub
(From yocto-docs rev: de6e7c05fbcff99a6f1fe2a2bf889b559b9b576b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Michael Opdenacker
4def515eeb manuals: replace "_" by "__" in external links
(From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Mikko Rapeli
e12050dcad dev-manual: common-tasks.rst: refactor and improve "Checking for Vulnerabilities" section
Add sub section to how Poky and OE-Core handle CVE security issues. This
is a generic intro chapter. Also add note that this is a process which
needs quite a bit of review and iteration to keep products and SW stack
secure, a process not a product.

Then change "Vulnerabilites in images" chapter to
"Vulnerability check at build time" since the process applies to
anything compiled with bitbake, not just images.

Explain details of how to work with cve-check.bbclass, especially
the states Patched, Unpatched and Ignored in the generated reports.

Rename recipe chapter to "Fixing CVE product name and version mappings"
since CVE check has some default which works for all recipes
but generated reports may be completely broken. Fixes are then done with
CVE_PRODUCT and CVE_VERSION.

Give some hints how to analyze "Unpatched" CVEs by checking what happens
in other Linux distros etc.

(From yocto-docs rev: 77a9c1a9fe651bf11f1d5a723b0741dd1764b2c8)

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Mikko Rapeli
aa5fd56b9a dev-manual: common-tasks.rst: add regular updates and CVE scans to security best practices
Regular security scans and updates to fix issues and updates from
upstream maintainers are best practices.

(From yocto-docs rev: 24d3337b6cbb38297877f6ce6ec78896ce93e8b2)

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Michael Opdenacker
3a3a9728ec manuals: updates for building on Windows (WSL 2)
- Use the Wikipedia naming scheme: WSL 2 instead of WSLv2
- Take into account Windows Server 2019 and 2022 which are
  supported too.
- Improve some explanations

(From yocto-docs rev: 35c5fb01d3543ef5e1f4edf337a2ab080b4e7956)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-25 13:41:36 +01:00
Michael Opdenacker
d09132d130 manuals: fix misc typos
(From yocto-docs rev: 988efd0d1663e4369043c5b53d7e1dcd9e54d3cd)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
b1d1777865 Update documentation for classes split
* Make reference to meta/classes* instead of just meta/classes
* Update each reference to the path where the class has moved
* Add a brief explanation to the classes reference explaining the split
* Add a note to INHERIT, INHERIT_DISTRO, IMAGE_CLASSES and USER_CLASSES
  variable glossary entries mentioning where the specified classes must
  be located. I contemplated adding the same note to PACKAGE_CLASSES
  but decided against it, as it has a very specific usage and such a
  note might distract from the narrative of that entry.
* Also trim the IMAGE_CLASSES entry which was quite outdated.
* INHERIT += no longer works with testimage so drop the note about that

(From yocto-docs rev: e76bed00b452d3049f6c22afbfb980b557a141bd)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Paul Eggleton
c29eb10e31 ref-manual: remove reference to testimage-auto class
testimage-auto was removed in the thud release.

(From yocto-docs rev: 618351169c09470280aeee53a63aba88788efc4b)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Michael Opdenacker
40b7725212 manuals: add references to the "do_rootfs" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 926c836e5184243fb1aee113962e11c01f0297ee)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
b42af6aa4a manuals: add references to the "do_bundle_initramfs" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 84c024455a36f4b40cd8401715f30b0af74af8a7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
6660c0603a dev-manual: common-tasks.rst: add reference to "do_listtasks" task
(From yocto-docs rev: 4352e14f82a45444acb2d8df11552b2265471ab1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
ba478645a3 manuals: add references to the "do_devshell" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 53141101fc1a8dc8b4007adcded3c7c6b9738f48)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
66a523d7e7 manuals: add references to the "do_cleanall" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 4c815875b7c716f421bbcd11ce26703867f11741)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
c99fdab612 dev-manual: common-tasks.rst: add reference to "do_clean" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 68261dc8b8c26df7aad19b37c2300ec5174525c9)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
c9c7ace795 manuals: add references to the "do_unpack" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 1ca57f8ec322d5777bf31829e659d62e82986be1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
a8b6712dfd manuals: add references to "do_populate_sysroot" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: a010e2eafa6754c46faac6f6dfd02dc6152d274f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
ec31647110 manuals: add references to "do_package_write_*" tasks
Using a reference to "do_package_write_deb", the first entry
in the list.

[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 237cebcfa6215d75bbe28df677f18ebf7e1bb4f6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
a6a7676910 manuals: add references to the "do_patch" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 1e38ceafb25aac13bb9dd45626fd39ad1b68852d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
b3dc55b051 manuals: add references to the "do_package" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 179139e6710f6dde0de25200c372705ed8ef13bc)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
3c6b2798a0 manuals: add references to the "do_image" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 2f53d0a52a48f828f00d3bc3f887fd537692a256)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
6ade5d2d0e manuals: add reference to the "do_compile" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: e88f11002032e30bbe2dd0049e307a431a70aaef)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
5d1e8104cd manuals: add reference to "do_configure" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 5ddc1a40c9004d814472bdd385f456afa7a9c4e3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
edaa121c7b manuals: add references to the "do_build" task
[YOCTO #14508]
(From yocto-docs rev: c8efd2eeb329344c48935f8998e9a689d66348ca)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
9fece9c361 manuals: add reference to the "do_install" task
[YOCTO #14508]
(From yocto-docs rev: 933ad27b81dfc4a28e7c48ca7bb2d1363e8c037f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
84251f8d24 manuals: add references to the "do_fetch" task
[YOCTO #14508]
(From yocto-docs rev: 17f2041647010d885f18f889c740588586c60d3a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
9dbd27a48a manuals: improve initramfs details
- Create a new entry in the glossary
- Add implementation details
- Replace the mention of "init ramdisk" by "initramfs¨
  whenever possible
- Remove obsolete and duplicate information
- Fix spacing issues in the Sphinx code

(From yocto-docs rev: 952c7e6dee49532705b2c162f4728e635c38df3f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
6a6a67b572 dev-manual: common-tasks.rst: refer to Python functions in BitBake manual
(From yocto-docs rev: a3ef2ac954d89432715a204bf293586c733690c6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:56 +01:00
Alexander Kanavin
cec7d36a8a dev-manual: common-tasks.rst: rewrite the section about configuration templates
This now includes a description about how to create a template
with the newly added tooling, and drops the description
of .templateconf as a way to point to a custom template
(which is not correct: .templateconf is used only to point to a default
template in poky or core when TEMPLATECONF is not specified).

(From yocto-docs rev: d8e43d4ff4d6a0a4557d5dcedf11c1e45a223e72)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:56 +01:00
Alexander Kanavin
63e3fc7a4d dev-manual: common-tasks.rst: describe the newly added layer setup and template config commands
(From yocto-docs rev: 3a5af296eb1492492ba60beabe888527d0dda49a)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:55 +01:00
Alexander Kanavin
6bb49fe02f common-tasks.rst: describe the layer setup tooling
(From yocto-docs rev: 2b56daf38ea9049e6d98be338b95a191360c3b32)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:55 +01:00
Alexander Kanavin
4be1b24621 dev-manual: common-tasks.rst: drop the output of 'bitbake-layers --help'
This is really not needed as the sub-commands are described in
greater detail just below, and is prone to become outdated.

(From yocto-docs rev: 70735edb17c3c855a77318d3ae44d24d8aa8eb75)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:55 +01:00
Mikko Rapeli
f54b2789d9 common-tasks.rst: remove SRC_URI:append from examples
Using SRC_URI:append without recipe, machine or architecture specific
limitations makes the :append'ed text more difficult to override than if
the "+=" operator was used. This makes it hard for example to override
SRC_URI completely in a bbappend to update the full recipe to a newer
version. Thus common, reusable layers which users are meant to re-use
and customize should not use SRC_URI:append but SRC_URI += instead.

(From yocto-docs rev: 34533ac2ee5d85a41330dd865062dce1e46b83fc)

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:55 +01:00
Ulrich Ölmann
05270ae200 manuals: fix paths to default templates & clean up whitespaces
The templates have recently been moved by meta-yocto's commit [1].
Clean up some whitespace issues along the way.

[1] 29608bd03e1b ("meta-poky/conf: move default templates to conf/templates/default/")

(From yocto-docs rev: 661c554224dd79e79afd22b84608e248d3336aac)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-12 08:35:17 +01:00
Michael Opdenacker
8bb753d585 dev-manual: use proper note directive
For correct rendering of the note

(From yocto-docs rev: cc765028a7cd3dda6942450b3d59d283bf73a8f7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-08-12 23:11:28 +01:00
Michael Opdenacker
012c046628 dev-manual: improve screenshot resolution
Screenshot from executing an NPM package built by npm.bbclass

(From yocto-docs rev: 57acf2f65e5e5798f369a24c4a0cc9b5cdb8e1db)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-30 17:09:51 +01:00
Michael Opdenacker
df1904a85f dev-manual: update section about creating NPM packages
From running the instructions using Poky master

In particular, update command output and the contents
of generated files.

The "cute-files" example application can now directly be run,
without having to run it through "node".

(From yocto-docs rev: a100fb1e25e3f2e144d771d31e952deae2fe3302)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-30 17:09:51 +01:00
Michael Opdenacker
d9adf28c10 manuals: replace hyphens with em dashes
Fix some hyphens being improperly used as em dashes.
See https://www.grammarly.com/blog/hyphens-and-dashes/

Using em dashes may also allow Sphinx to hyphenate
and break lines in the best way.

Note that the first character after an em dash not
supposed to be capitalized, unless a specific
rule applies, typically when what follows is a proper noun.

Fix a few misuses of parentheses in following text.

(From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-27 14:55:08 +01:00
Michael Opdenacker
17d0d15be1 dev-manual: NPM packages: minor grammar fix
(From yocto-docs rev: ab3758fbb422895c31417e2c4c41937995ec8d7e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-27 14:55:08 +01:00
Michael Opdenacker
f7f4444e36 manuals: update host tool requirements
As enforced by meta/classes/sanity.bbclass:
- at least GNU make 4.0
- at least GNU tar 7.5 (instead of 5.0)

(From yocto-docs rev: 6480aa0f8338ef192c666b9445bc0baff47d9248)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:17 +01:00
Michael Opdenacker
9f3ba94bfa dev-manual: fix references to BitBake user manual
Fix a wrong reference no longer tolerated by Sphinx 5.0.1
(missing "bitbake:" prefix)

Add missing double quotes in a reference to a chapter title

(From yocto-docs rev: 9a797dedf6708da3e7ce789c5c8735e5d891cde4)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:16 +01:00
Richard Purdie
a7c0424467 ref/dev-manual: Update multiconfig documentation
Multiconfigs now work from layers. Update the documentation to match this change.
Also fix a incorrect reference to different distros working within the same TMPDIR,
that is incorrect.

[YOCTO #13566]

(From yocto-docs rev: cb35f75bfc98c9098f9af64b9dd040b25779da36)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:16 +01:00
Michael Opdenacker
c91b04679f dev-manual: mention the new CVE patch metrics page
(From yocto-docs rev: 42bfcb2d3a13e71264e5f29b07615c2da9866273)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:16 +01:00
Michael Opdenacker
b192b80593 manuals: add documentation for WKS_FILES
Fixes [YOCTO #14590]

(From yocto-docs rev: e736ff92b5b09f2028f3e8a5152973941d25dae4)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-24 13:58:47 +01:00
Thomas Epperson
e8d6e05000 dev-manual: fix documentation for bmaptool usage
(From yocto-docs rev: 4d4e2b023e569bff466a8e7b07f1b7e8e2334df0)

Signed-off-by: Thomas Epperson <tepperson@briskheat.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-24 13:58:47 +01:00
Michael Opdenacker
51cb0db138 manuals: add missing space in appends
(From yocto-docs rev: aa122d28298596a3b91a8f6650163785a3cfa831)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-24 13:58:47 +01:00
Michael Opdenacker
76ae677313 manuals: improve documentation for TEMPLATECONF
Add it to the variable index
Misc improvements to the documentation for this variable

(From yocto-docs rev: fb460a7c7aba1ad5754806f9cfad9ef591420317)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10 12:52:35 +01:00
Michael Opdenacker
14c7cd24a5 manuals: improve the width of diagrams
Better for EPUB output in particular
- Make some diagrams wider when necessary
- Remove ":align: center" when we have ":width: 100%"
- Update the standards.md files to mention this

(From yocto-docs rev: 848ba7bd8984cc3f4bf6b818259865011cde0476)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10 12:52:35 +01:00
Michael Opdenacker
eae7c2a0c2 manuals: fix name capitalization issues
- Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the
  title of the "BitBake User Manual".
- Using "OpenEmbedded" instead of "Openembedded"
- Using "Python" instead of "python"

(From yocto-docs rev: 0b893e2a15aefedd7100445fc9d7eeed07b6afc6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10 12:52:34 +01:00
Michael Opdenacker
739058fc54 dev-manual: further gdb usage simplifications
(From yocto-docs rev: 701d9af89c0de25b84f110ed9f4b627ea339195b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10 12:52:34 +01:00
Sundeep KOKKONDA
f09f1de84c dev-manual: improvements for gdbserver configuration
[Yocto #13722]
The Yocto bug reports a few improvements in the gdbserver configuration
which makes the configuration of gdb easier for novice users.

(From yocto-docs rev: 48c96378fd5edd587025f3ca138bc5114e927f2f)

Signed-off-by: Sundeep KOKKONDA <sundeep.kokkonda@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10 12:52:34 +01:00
Abongwa Amahnui Bonalais
c6421fce9d dev-manual: add command used to add the signed-off-by line.
(From yocto-docs rev: 0520831118ab0f3287d1a6cde4fa26062e55ee74)

Signed-off-by: Abongwa Bonalais Amahnui <abongwabonalais@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19 12:37:42 +01:00
Richard Purdie
33083dd825 poky.yaml: Drop POKYVERSION and YOCTO_POKY references
We don't publish tarballs using this version any more, it has been
removed everywhere. Remove the obsolete references in the docs,
adapting references accordingly. The tarballs now are just created
with their sha256 checksum which we don't want or need to reference
in the docs.

(From yocto-docs rev: c7a0ac88b01c48f3d9209536542bf43ae7a7937f)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-21 15:18:24 +00:00
Nicholas Sielicki
2fd4d2cb70 dev-manual: note on using journald without syslog
journald is not a syslog provider, so using journald exclusively amounts
to just preventing a syslog provider from being specified on a system
where journald is active.

Various spots where this has popped up:
* https://stackoverflow.com/q/48746397
* https://lists.yoctoproject.org/g/yocto/topic/82883035#53548

(From yocto-docs rev: aba38d5dc2db708ed6e8fc6dca4d869fe7fe855c)

Signed-off-by: Nicholas Sielicki <nicholas.sielicki@legrand.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-21 15:18:24 +00:00
Michael Opdenacker
61f3805d0e dev-manual: details about using firewalls and limiting fetch threads
Fixes [YOCTO #13235]

(From yocto-docs rev: cf76420c50f13762fb800a19931a8af5ae3567cf)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:01 +00:00
Michael Opdenacker
809b96e931 manuals: inclusive language updates
Changes identified by OE core's
scripts/contrib/convert-variable-renames.py script

Original variable names are kept in old migration notes,
but references to the new ones are provided.

(From yocto-docs rev: 1a35380ca80509fee036018a2bbb22ba9b44d47a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:01 +00:00
Michael Opdenacker
bafbbd53c4 docs: update examples to add branch info to git URIs
Branch information is now mandatory for git:// and gitsm:// URIs

(From yocto-docs rev: b862655d812e358dd15b06c0548a276a90666423)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:01 +00:00
Tony McDowell
d59439a3fb dev-manual: add instructions for compacting WSLv2 VHDX files
Using DiskPart for the systems which lack optimize-vhd

(From yocto-docs rev: c692b77065e6bd8eda789a88fa8fae1351a7274d)

Signed-off-by: Tony McDowell <svet.am@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-16 14:25:01 +00:00
Michael Opdenacker
6df5aa3475 documentation: remove references to prelink support
Fixing documentation and updating examples containing "prelink"
in their output.

(From yocto-docs rev: 8927b8fff55fac1bd1fefcff2d16141dbd1ebc51)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00
Peter Kjellerstedt
865e150599 manuals: Update LICENSE vars in examples to use SPDX license identifiers
This is similar to the recent change in meta to only use SPDX license
identifiers in the recipes.

(From yocto-docs rev: 147ce973d08f0bfb59b7b87fec8c8cc997d57112)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-04 09:39:37 +00:00
Quentin Schulz
4dbb515327 docs: point to renamed BB_BASEHASH_IGNORE_VARS variable
Since commit 98b3ed1b2e "meta/scripts: Handle bitbake variable
renaming", the new name of the variable is BB_BASEHASH_IGNORE_VARS
so let's update it so that Sphinx can resolve the Bitbake reference.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: a6c6283e9cc30ca580f1719d8e22fca5f79c1e50)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-23 18:12:10 +00:00
Alejandro Hernandez Samaniego
552ff6e3d5 documentation: Add multiconfig initramfs configuration:
dev-manual/common-tasks.rst: Add section to create an initramfs
image from a separate multiconfig.

ref-manual/variables.rst: Add new variable definitions for
INITRAMFS_DEPLOY_DIR_IMAGE and INITRAMFS_MULTICONFIG

(From yocto-docs rev: 7853ab3df82c27ba309879a66a084b2e597dc1e5)

Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-18 17:58:02 +00:00
Christian Eggers
b6c1329501 dev-manual: update example from kernel.bbclass
Since f748564653 ("kernel: provide virtual/kernel for all kernels"),
all recipes which inherit kernel.bbclass provide "virtual/kernel",
independent of the value of `KERNEL_PACKAGE_NAME`.

(From yocto-docs rev: da69e75c7f84f51c8fa95e9217e11b4b36af52d6)

Signed-off-by: Christian Eggers <ceggers@arri.de>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-18 17:58:02 +00:00
Michael Opdenacker
3a6185404e manuals: improve references to classes
- Simplify references to class sections, by replacing references such as
  :ref:`image.bbclass <ref-classes-image>`
  by
  :ref:`ref-classes-image`

  That's equivalent, because the class sections always called <class>.bbclass

- Adding references to class sections, by replacing strings such as
  ``image.bbclass``
  by
  :ref:`ref-classes-image`

- Simplifying a few class section links

(From yocto-docs rev: 29d66aaa898390c19f121baf0f4fdcc178e4cd80)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-03 13:47:50 +00:00
Michael Opdenacker
a9fdd010b9 dev-manual: new "working with pre-compiled libraries" section
This explains how to deal with versioned and unversioned
pre-built libraries from vendors.

Content and examples adapted from
https://wiki.yoctoproject.org/wiki/TipsAndTricks/Packaging_Prebuilt_Libraries,
originally written by Henry Bruce in 2016.

(From yocto-docs rev: 5e46cad9e4b4ab03e33f4d5aea34e56f6b15fe27)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-03 13:47:50 +00:00
Michael Opdenacker
3f27dfa9c9 dev-manual: stop mentioning the Angstrom distribution
Now defunct

(From yocto-docs rev: 52f7aedda58becb081eeca4a1bc02068f72d7c4a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-03 13:47:50 +00:00
Robert Joslyn
f299005d66 dev-manual/common-tasks: Fix typo
direction -> directory

(From yocto-docs rev: 441151bfdeda6eccf46a7829d1a3181e83d441a8)

Signed-off-by: Robert Joslyn <robert.joslyn@redrectangle.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-02-03 13:47:50 +00:00