(From yocto-docs rev: 76f4b5ded4aa04ca1404510f0232593a968e0f66)
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
[AG: add note on large CVE updates for linux-yocto]
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit be424bf52cd3ac9c83a4617d0b06afe8cde055be)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
- font fix
- missing word fix
(From yocto-docs rev: c7e020d278ded715fc24034b000fb93f554b606c)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a9bf37a1166120f8870422aceaf2f3d8cb53788a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Usage of semicolon as separator in ROOTFS/IMAGE_*COMMAND was deprecated
long time ago.
Code was changed to not include it anymore.
Update the example.
(From yocto-docs rev: 0ec798cecaae31e5bba13261d72dc8c5492b6b1f)
Signed-off-by: Peter Marko <peter.marko@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit fa0b3fc4218e75b88b7811a3f2bfefdb0ca6496e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
The current contents of deploy.bbclass is slightly different so update
the code snippet and the subsequent explanation of that snippet.
(From yocto-docs rev: b5cfd275cdd620b5260c5e66e254363be795e798)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit aec2a39ea648694bb5a30da216b721018e8bb670)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
"counterpart" is one word, not two -- this is the only example in all
the docs that needed fixing.
(From yocto-docs rev: 3511578f29e93702931883cd6537c57a5994d5cd)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 555061075725440d3aa6373624082bef6ee6e31f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Ensure the reader understands that patch files can be compressed.
(From yocto-docs rev: 39c5dff022620818bbbfeb4ad10f0f9e5b1e8d35)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a1070100ecdf600ca9468a4115f9f9a1bf94f448)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
The section "What Yocto Security Team does when it receives a security
vulnerability" duplicated information already found in the previous
section "Security Team Operations", so merge the sections and tidy up
the flow of the text.
While we're editing this, Mitre is now just one of the places you can go
to get a CVE assigned, many other CVE Numbering Authorities (CNAs) are
available. They also now have a web form for contact and requesting CVE
assignment so let's link directly to that.
Also drop "If an upstream project does not respond quickly" down a
heading level.
(From yocto-docs rev: ca6a21c7cf652fabd0d48fda735a9074f9fe8af7)
Signed-off-by: Paul Barker <paul@pbarker.dev>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 8efdc7df5c75e92449e74e4d40b763ee1df07adc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
A layer is not simply a collection of recipes; it can include any
combination of recipe files, machine and distro configuration files,
class file and more, so make that clear. In fact, a layer is not
required to contain any recipe files at all.
(From yocto-docs rev: 4050b1002e1d1273fb3e0908bd42308e4f95e355)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 9d2fe509ff2ab43ea73d6cb7feaa44669ad83f0d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Add a ":term:" reference for the phrase "Openembedded Build System",
to be consistent with the earlier reference for "Poky".
(From yocto-docs rev: 938bcb41cdc5337c9f662b113381ac1ba59fb87c)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 2a8bc4f1b25c818ddc517a6eee6a0c3ba653db6d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Those are defined in BitBake documented, and would be better documented
there. Add a link to the BitBake manual for these variables.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 3210b5375356ad7097ecbf27ffdb50189a0ea6fe)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit cec08390bad4f26b841ff6fc8752f6200acf31d3)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Given how Chapter 4 of the Overview Manual introduces so many of the
variables that define a build, briefly introduce the reader to the
"bitbake-getvar" command so they can examine those variables.
(From yocto-docs rev: ccd3b07fb7a24877aeea80d24456e41c93266015)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 33f57d154ad1ec950c59c5aab20e0a0323ef19cc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Update the section on describing the Beaglebone contents to reflect
the current content in the meta-yocto-bsp layer.
(From yocto-docs rev: 8ebcf1ea8e4add4045f643bde3bb48d5ff560497)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit bd5be9cc9d5aa7cca63877f3a22089c9dc02f135)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
In the intro to the BSP guide, mention that a BSP layer might also
contain content related to the bootloader and device tree files.
(From yocto-docs rev: ba48bdeee06522d7334ccb624053f4f363556a15)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a6eca1e7c67225de8b32638b4ba10aa73efe5030)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Minor rewording in two places.
(From yocto-docs rev: d08a1381231b068461f39de47154e971c71acd52)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 382f2cbea16efc13a1bcf14a3276add8aabeec4e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
The Recipe Style Guide makes it clear that you can't have hyphens in
the version part of a recipe file name.
(From yocto-docs rev: 935bdb0d03bdb3f186ffd36faf37d5255a5b9522)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b9c7aa835576f154dff1c565e835bffd298af7c3)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Obviously, this sentence should say "colon", not "semi-colon".
(From yocto-docs rev: f87c6ee9a2965b2978b93ccfd76dce0cb853bd9f)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 837e4de00f67b87c60faf21aab2dee913ba813b0)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Even though it's mentioned a little earlier on that same page, when
defining the properties of a "Distro Layer," remind the reader that
"meta-poky" is an example of such a layer.
(From yocto-docs rev: 27a3d7d4c30f2957661d00455c15f830e1281bb9)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 4c57f21b681ca92e89903a79b2404132d5b00f10)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Similar to :yocto_bugs: but directly create a hyperlink to the bug
displayed with its identifier. Use as :yocto_bug:`12345`.
(From yocto-docs rev: a84f0e63550c2c72497c5b563f72fcfa16c3ee8f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 24e227262df909353ef8874335cdeb114b9d4203)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Defines three new bitbake_path, meta_yocto_path, and oecore_path roles
that can be used to quickly reference a file or directory in one of
those repositories and link to our web interface for the path, e.g.
:oecore_path:`meta/conf/bitbake.conf`.
(From yocto-docs rev: cc2bb929002ed29fdb2601cf02f47de315656d27)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 89cf4b98686f6f353811d444f36848410ffd2929)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Use the extlinks extension to create new roles to quickly reference a
commit from openembedded-core, bitbake, or meta-yocto.
For example, use as: :oecore_rev:`437e0419608e`.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 54cd2278e9f72837013831b6ce6d4aff61982899)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 79552b4a764d16282a86c8e017270a258a26240e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Correct "maintainance" typo in recipe-style-guide.rst.
(From yocto-docs rev: f39ba5141cd518f08d491b2255a4acd74442e87b)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit d7376cca64a0784e59d4fd60b9baefb4da2ce289)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
As with "setup" versus "set up", the pedants at grammarist.com explain
that "checkout" is used as a noun or adjective, while the
corresponding verb is two words, "check out."
https://grammarist.com/spelling/checkout-check-out/
(From yocto-docs rev: 85852e0a1e5ddf034cff979329591af786967beb)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 1d5f0fea4e150be0ef9b10d5733eeaba06c78e6f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Tweaks:
- Update "Software Overview" link to go to "Technical Overview"
- use proper capitalization for "Git" when referring to the product
- numerous grammar adjustments to basic skills list
(From yocto-docs rev: 9b440c5116828f131a304b77f5da8c98c0d27c62)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit ffd69f11172c2b0d8f52bd967c7983220d133e0d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Tweaks:
- grammer adjustments
- hyphenation
- monospace font for layer and file names
(From yocto-docs rev: 8e98a7264bf9d0d975b5c8fb2062ed907273ff5c)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 801f719458d0d9670debad4ddc379e3ade4d85f9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Delete inconsistent periods in software versions list so it doesn't
look weird.
(From yocto-docs rev: a106dea889259a872fdbe69215fe4de740bc49f4)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 94ebe744d0e95672456b8157daf0ffba333397bd)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
When referring to buildbot, add a link to its home page.
(From yocto-docs rev: 40b6f86daea61e545d94e92b8eed11c8038573ad)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 7a9247175e1afc74371708d4bad629941477eb57)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
There seems to be be little value in continuing to point readers to
two references, one almost a decade old, the other almost 15 years
old, especially in the middle of a guide that ostensibly is part of
the introductory material.
(From yocto-docs rev: eb92a7cc3fe7772f202e9955974d79b359a257d7)
Signed-off-by: Robert P. J. Day <robday@acresecurity.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 5b4ffc020a9b0c7a877c119058cd43a51f91687f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Fix the title and link so it goes directly to the
Technical Overview.
(From yocto-docs rev: 1ba3a389b47188b6c664ae3a0bee7ca70e462650)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 0143b586572e15cac438f0fa6f3c1e7446597020)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
The description incorrectly stated that the sysroots are set up for
use during the packaging phase. In fact, do_prepare_recipe_sysroot
runs before do_configure, and the sysroots are consumed by
do_configure and do_compile.
Refer to do_configure and do_compile as the tasks that consume
prepared sysroots. Briefly describe the role of each sysroot.
Link do_configure, do_compile, and do_populate_sysroot via
:ref: to ease navigation.
Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com>
Suggested-by: Antonin Godard <antonin.godard@bootlin.com>
(From yocto-docs rev: 1c5e7f136d7460fa5ad4c8a49ab1de31bd670e59)
Signed-off-by: Dawid Bijak <bijak.dawid@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b50e8d36bdab53b004711ebc284d8ce8be593859)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
To properly fetch all the sources as suggested by the docs, one should
use "--runall=fetch".
(From yocto-docs rev: eb6a87177cec679eae9b2dfae86f49d9789c0ab1)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 0be8663d1f9e910c304e0960dd9e024e38646480)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Add that the RSUGGESTS variable would be processed only by a
supporting package manager when installing packages from a
package feed, and add a link to the appropriate section in
the Developers Manual.
(From yocto-docs rev: 2c80b891d85e0a7d9b70fc7b4a9c032325b56eca)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 48c832376cc3d33785d790a3e76b52ed2f8895bf)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Change the css rules of our theme to have a fixed-width documentation
instead of it taking the full width of the page. I believe this makes it
much more readable compared to having long lines with few line returns,
especially on high-resolution displays. Set the width to 1000px instead
of the previous 800px, which felt slightly too thin.
I think the removed comment here does not make that much sense for us.
It was added by commit 0c1e108bc6c4 ("sphinx: add CSS theme override"),
and I believe is a simply copy and paste of what was is set in the Linux
kernel, added by commit 9abaf979abb2 ("doc-rst: customize RTD theme,
table & full width") [1].
[1]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=9abaf979abb2
(From yocto-docs rev: 680edf7ffdf2286c64c32de74be5b6353294122f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 98234c9d3a0846d719630914bea8599da9f51374)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
The reference to STAGING_DIR* variables in the description of
DEPENDS was misleading, as it pointed at STAGING_DIR which is
unrelated in this context.
(From yocto-docs rev: 48d15a62ed7c004fd6e1dced03923bac529c435e)
Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 2da8e6334e3d3362c9177f78a1216156417903fc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Slightly reword to emphasize the sysroots' roles during the build.
Drop double back-quote from the uses of '-native' to make it a bit
easier on the eyes.
(From yocto-docs rev: e98b2231e76243734820efc28895ab11d20b0330)
Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 15bbfeee88eee706e06b63116c9bf0cbfb2fd91c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Slightly reword to emphasise the order of steps during staging.
Further clarify those variables' relation to STAGING_DIR* variables.
(From yocto-docs rev: 4b219d437a5674aa71b6b2544d1548987202203f)
Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit eeb22235d5310ed440692914851df0b7aac056a4)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Don't refer to it as temporary. Update the default value.
(From yocto-docs rev: 3786a02e4478c4e73531479d50d1be6e8dd8b4c7)
Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a1432f24c94a26b372164704cf18b3c6a73b34f5)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Make it more evident, that it is first populated by files from
some recipes, and later used as source of those files for the
others (staging and sharing files).
(From yocto-docs rev: 156c7c685b97943bcfa5309f9656a4b9e05e44a3)
Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit cad256411e2bc380e27e2fc4ea3140476596c823)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
STAGING_DIR is not in direct relation to recipe-sysroot*
directries. Also it does not participate in packaging, but rather
in staging and sharing files among recipes.
(From yocto-docs rev: 0838936ad05a8d5ed410767f389d4fd1a4e379b3)
Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 0ff189fcb82f5e845951c939197835d0a1daf87b)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
Classes can be located in three different directories since Langdale
(4.1), so let's update which directories you can find in a distribution
layer.
(From yocto-docs rev: 2141bc2b04ef4210e008752a97ed82979d817dae)
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit fd11d75980315d87ef375091efedad69a123f680)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
