Fix as many instances of unbalanced-inline-literals-delimiters as reported
by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get
tripped up randomly when references contain links to a heading which
contain literals enclosed in double-back-tics; especially in the cases
where a heading either contains multiple literals or when the literal is
not at the end of the heading. Not all of them can be "fixed" to pass both
building and linting.
(From yocto-docs rev: 3460177c46d360b0f2f852cdab23f21bd4ec6d5a)
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
By defining the manpages_url we can use the :manpage: role in the
documentation for providing links to manpages. See:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url
Replace existing manpages links to use this role.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 0d0115cb2d96960837678f775cf5c2297494c51c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 4e63cd74cd1a330ea5e96bb04243a90f607b2857)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Mention that UNPACKDIR is used as a location to unpack the source code,
and that S is the final location of the source code. This is
deliberately vague, because as there are multiple instances of how these
directories can be defined and used.
The proper explanation of how the UNPACKDIR and S directories interact
is left to the reference manual, under the UNPACKDIR variable
description.
(From yocto-docs rev: 76361ae37bd45c9ce5190fb6c7c400bf2fc14003)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
PR was removed by cc83e4548465 ("bitbake.conf: Drop PE and PR from
WORKDIR and STAMP") on OE-Core.
(From yocto-docs rev: 569c707c69a7a858553e40b26cb36db18f2a42fc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Convert the png file to an SVG file
- Add the UNPACKDIR reference.
- Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf:
Drop PE and PR from WORKDIR and STAMP") on OE-Core.
- Change S value to BP (equal to ${BPN}-${PV}, but more accurate).
(From yocto-docs rev: 6fd6af3ea9e556e481cc3c0358c0357b6060798f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Convert the png file to an SVG file
- Add the UNPACKDIR reference.
- Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf:
Drop PE and PR from WORKDIR and STAMP") on OE-Core.
- Change S value to BP (equal to ${BPN}-${PV}, but more accurate).
(From yocto-docs rev: f24b00200ac49cda07e4c77e3e1b161a5b78b006)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Convert the png file to an SVG file.
- Add the new UNPACKDIR directory to the image.
- Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf:
Drop PE and PR from WORKDIR and STAMP") on OE-Core.
- Change S value to BP (equal to ${BPN}-${PV}, but more accurate).-
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 73b6c0c5e5470d4a929fd3d5cde6d4fb0ace53b8)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Convert the png file to an SVG file.
- Add the new UNPACKDIR directory to the image.
- Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf:
Drop PE and PR from WORKDIR and STAMP") on OE-Core.
- Change S value to BP (equal to ${BPN}-${PV}, but more accurate).-
This fixes [YOCTO #15730].
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 9fc105137d54523b1f9a477fe7b52587a6bcb6c8)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[YOCTO #13417]
devtool is not directly tied to the Extensible SDK anymore, and
instructions in there can be split and added to the development manual.
This patch is a simple bulk move, except for the following:
- Intro added to the devtool.rst document (mostly copy-pasted from the
devtool quick reference in the ref-manual).
- Figures renamed to remove "sdk-" from filenames.
- References to sdk-manual/extensible replaced by dev-manual/devtool.
Reported-By: Paul Eggleton <bluelightning@bluelightning.org>
(From yocto-docs rev: 044d3185b858fce1febcfe3a6834b883f9a598fa)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The package splitting section of the overview manual currently lacks any
explanation of how package splitting is implemented and redirects to
the package class, which is not really understandable for newcomers to
the project.
This patch adds a short explanation of what is done:
* How the PACKAGES variable is defined.
* How the FILES variable is defined.
* How the two work together.
* How to add a custom package.
This should give enough details to a new user on what package splitting
achieves and how to add a custom package.
Adresses [YOCTO #13225]
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 143c3cacdec36c9d7ab81c89bbcc12c0c3936bd9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The SDKPATH variable seems mistakenly identified as the
default path where the SDK will be installed by the generated
installation script, unless option '-d' or a manual input
overrides this default.
The intended variable is SDKPATHINSTALL. SDKPATH indicates
where the SDK is being composed and built.
The definitions have been added/updated.
(From yocto-docs rev: d5b9c4b9c443cc728a11fd1e0a26a11aac8ee2c5)
Signed-off-by: Johan Bezem <jbezem.extern@arri.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
To simplify the style, replace "Following is" and "Following are"
by "here is" and "here are", sounding more natural.
In some cases, also go further by simplifying "Here are/is xxx"
by "xxx are/is" when the "are" or "is" are not two far at
the end of the sentence.
In some cases too, completely remove the sentence, when
it's redundant with the preceding title.
(From yocto-docs rev: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Create a Map to detail how BitBake handles a recipe's tasks
and its compile/runtime dependencies along with detailed comments.
(From yocto-docs rev: 7f0ab56aa302babab6c9d600a8d8a91708cf75f7)
Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adds an additional note about some of the side effects that can occur if
recipes are not reproducible and hash equivalence is enabled.
(From yocto-docs rev: 1ccc8eefe21bc432c903bb245bd0dab06e67cc14)
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There's no need for double white spaces here so let's just remove them.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: e41f6689157359777c3d86d9a7afed6f9e43782b)
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>
This has been removed in 4.2.
(From yocto-docs rev: a5dcaf95915deec5243ab2fd0711c63e98b2a661)
Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- 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>
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>
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>
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>
Doing this, fix the odd identation of the corresponding paragraphs
(From yocto-docs rev: e319b3bf4eb6420949372e699d60c7383945e513)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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>
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>
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>
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>
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>
The explanations which precede and follow are sufficient.
The removed text seemed to suggest to use conf/site.conf to specify
the location of another conf/site.conf file.
Another issue was that the way to override conf/site.conf settings
through conf/local.conf was described before explaining that
conf/site.conf is processed before conf/local.conf.
(From yocto-docs rev: d477a2044e7b53977daf4d0c0d45cad29c2006fb)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
