| Age | Commit message (Collapse) | Author |
|---|
|
Just a collection of:
- grammar tweaks
- space fixes
- font changes
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
|
|
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Without this, readers could think that "devpyshell" is a script,
at least until they read the remainder of the section.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
|
|
In the example in section 3.9, the call to d.getVar() needs to have
the additional argument of "False" so that the output is not expanded.
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Specifically, the actual recipe now has LICENSE=MIT.
Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
This was broken in a previous commit which broke doc generation.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
Signed-off-by: Jon Mason <jdmason@kudzu.us>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
Document which units are accepted as parameters for the four options
that accept units. Also be pedantic about using binary instead of
decimal prefixes so readers don't have to wonder.
Signed-off-by: Olaf Mandel <o.mandel@menlosystems.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
To prepare to add another example bbappend, rename the current "Using
.bbappend Files in Your Layer" section to "Appending Other Layers Metadata
With Your Layer". Name the current example as "Overlaying a File Using
Your Layer".
Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
|
|
Try and make it clearer what the final result of this bbappend example
is.
Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
|
|
Fix dunfell typo for releases 3.1.9 and 3.1.10.
Signed-off-by: Daniel Gomez <daniel@qtec.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
There are many more instances of "filename" or "filenames" than
of "file name" or "file names".
The winner takes it all!
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
BBHASHDEPS was removed from bitbake in April 2014, with the following
commit:
92526eadd09d "bitbake-worker: Drop BBHASH variables"
so let's remove mentions from the docs.
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Fix bits missed by the migration script.
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Updated with openembedded-core/scripts/contrib/convert-overrides.py
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Updated with openembedded-core/scripts/contrib/convert-overrides.py
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Updated with openembedded-core/scripts/contrib/convert-overrides.py
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Updated with openembedded-core/scripts/contrib/convert-overrides.py
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Updated with openembedded-core/scripts/contrib/convert-overrides.py
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Updated with openembedded-core/scripts/contrib/convert-overrides.py
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Adding 3.1.10 to documentation switcher and release list.
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
|
|
This adds details about the actual implementation
of vulnerability checks, about how to fix or ignore
vulnerabilities in recipes, and documents the
CVE_CHECK_PN_WHITELIST and CVE_CHECK_WHITELIST variables.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
|
|
Previously, the license for the manuals was only
stated in the SPDX headers at the beginning of source files
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Add a note about documenting where a layer doesn't support 'core'
functionality.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Adding 3.3.1 to documentation switcher and release list.
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
|
|
Thanks to closing yocto bug #3388, there is now a simple way
to build the perf manpages for use on the target
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
These files are not used to build to documentation
and were updated and moved to the "meta-skeleton" layer
(except "mtd-makefile" which is broken and no longer
worth maintaining there, as a recipe for more recent
versions of "mtd-utils" exists).
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
This starts to document vulnerability management
and the use of the CVE_PRODUCT variable
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
|
|
Signed-off-by: Stefan Wiehler <stefan.wiehler@missinglinkelectronics.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
The standard :term:`VARIABLE` will refer to the
description of the variable in the YP variable index. If it
doesn't exist, it will refer to the description of the variable
in the BitBake manual.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
|
|
Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`"
by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name`"
when the reference description is the same as the section name.
In this case, that's unnecessary to repeat the section name in the description part.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
|
|
Removing the ":ref:`-D <bitbake:..." syntax as it's not necessary
Adding more and simpler ways of making references to the BitBake
manual.
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>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
The file 'meta/classes/core-image.bbclass' seems have nothing about
the 'IMAGE_FEATURES' variable, using 'meta/classes/image.bbclass' instead.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Mingrui Ren <jiladahe1997@gmail.com>
|
|
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Tony Battersby <tonyb@cybernetics.com>
|
|
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
A few occurences appeared between the time the original patch was sent
and it was applied, this fixes it.
Also, the original patch didn't take into account lowercase terms, this
is now fixed, see module_autoload for example.
Finally, as is often the case with regexp, there was a typo in it that
didn't make it match as much as it should have.
The script that is used to do the replacement of ``FOO`` by :term:`FOO`
is the following Python code:
import re
from pathlib import Path
from runpy import run_module
import contextlib
import io
import sys
re_term = re.compile(r'variables.html#term-([a-zA-Z_0-9]*)')
terms = []
new_terms = set()
with contextlib.redirect_stdout(io.StringIO()) as f:
run_module('sphinx.ext.intersphinx', run_name='__main__')
objects = f.getvalue()
match = re_term.search(objects)
while match:
if match.group(1):
terms.append(match.group(1))
match = re_term.search(objects, match.end())
for rst in Path('.').rglob('*.rst'):
with open(rst, 'r') as f:
content = "".join(f.readlines())
for term in terms:
content = re.sub(r'``({})``(?!.*\s+[~=-]{{{:d},}})'.format(term, len(term)), r':term:`\1`', content)
with open(rst, 'w') as f:
f.write(content)
This script takes one argument as input: an objects.inv. Bitbake's can
be gotten from https://docs.yoctoproject.org/bitbake/objects.inv. The
objetcs.inv from the current git repo can be gotten from
documentation/_build/html/objetcs.inv after running `make html`.
Note that this excludes from replacement terms that appear in section
titles as it requires refs to be changed too. This can be automated too
if need be but right now it looks a bit confusing to have an anchor link
(for sections) also have a term/reference link in it. I am not sure this
is desired today.
This is the result of two runs of the aforementioned script, once with
Bitbake objects.inv and once with this repo's.
Fixes: ba49d9babfcb "docs: replace ``FOO`` by :term:`FOO` where possible"
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
The image-mklibs bbclass was removed from OE-Core with
commit 908df863b419d1cad7317153101fc827e7e3a354 and
corresponding changes to local.conf.sample were made
in meta-yocto with c8c8f284eb2abe7e1352850a885454487cc01986.
Remove all references to image-mklibs from the documentation
as it is no longer supported.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
Adding 3.1.9 to documentation switcher and release list.
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
|
|
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
Fix missing reference and styling issues found thanks
to trailing dots (only non black character in a line)
Matches (and multiple false positives) found with the below command:
git grep "\s\.$"
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
|
This variable is no longer documented in Bitbake's manual
as it's not in use any more.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
|
Robert P. J. Day
Michael Opdenacker
Ross Burton
Richard Purdie
Jon Mason
Olaf Mandel
Tom Rini
Daniel Gomez
Quentin Schulz
Michael Halstead
Stefan Wiehler
Joshua Watt
Patrick Williams