aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2021-10-11migration: tweak introduction sectionpaule/migration-3.4Paul Eggleton
Ensure we have a brief introductory section and tweak the general migration considerations a little. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2021-10-11migration-3.4: add additional migration infoPaul Eggleton
Add migration instructions gathered by combing the commits in this release. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2021-10-11poky.yaml: add lz4 and zstd to essential host packagesPaul Eggleton
These are now required so update the corresponding distro-specific lists used in the system requirements documentation. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2021-10-11ref-manual: remove meta classPaul Eggleton
This was recently removed so remove the reference to it. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2021-10-11migration-3.4: tweak overrides change sectionPaul Eggleton
Minor grammar and readability improvements. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
2021-10-08dev-manual: warn about license compliance issues when static libraries are usedMichael Opdenacker
This partly addresses [YOCTO #14407] Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-08dev-manual: correct NO_GENERIC_LICENSE section titleMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-By: Quentin Schulz <foss@0leil.net>
2021-10-08overview-manual: simplify expressionMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-08dev-manual: remove errant /Jon Mason
Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-08documentation: use YOCTO_DL_URLJon Mason
Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-08documentation: replace http with https for URLsJon Mason
https has been the preferred way to access websites for many years now. Change all of the URLs with a _working_ https server/certificate to use that URL. Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-08manuals: introduce 'yocto_sstate' extlinkMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-07docs: add "make all" to build old types of docs (html, epub, pdf) at onceMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net>
2021-10-07overview-manual: SVG diagram for the git workflowMichael Opdenacker
Set in full-width mode to make it ready in PDF and EPUB outputs. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net>
2021-10-07conf.py: use PNG first in EPUB outputMichael Opdenacker
SVG directly included in EPUB output has multiple issues, in particular font size and alignment ones (tested on two EPUB readers). Instead, using PNG, generated from SVG when available as the primary format for images. GIF and JPEG are fine too. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net>
2021-10-07Makefile: allow epub and latexpdf outputs to use diagrams from SVG sourcesMichael Opdenacker
html output is great when directly using SVG epub output has to use exported PNG because of issues using SVG directly latexpdf output cannot use SVG, it needs exported PDF instead This adds rules to generate PNG and PDF formats from new SVG sources. Newly added diagrams have be stored in svg/ subdirectories so that PNG and PDF files generated from SVG can be "gitignored" without ignoring the original PNG diagrams that have no SVG source. Note: had to remove the dependency to "Makefile" in the final "catch-all" target, otherwise it was also catching the SVG to PNG and SVG to PDF targets. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net>
2021-10-07manuals: replace "apt-get" by "apt"Michael Opdenacker
Modern Debian based distros (such as Ubuntu) now use "apt" instead of "apt-get" Also make sure "apt" is invoked with root privileges (mandatory) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net>
2021-10-07documentation: update sources mirror URLJon Mason
The URL for the sources mirror no longer works. Update to the new location. Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-07ref-manual: document DEBUG_PREFIX_MAPMichael Opdenacker
Fixes [YOCTO #14433] Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-07manuals: font fixesMichael Opdenacker
This fixes font inconsistencies, mixing a ``text`` string with another string with the regular font, where the whole string makes more sense with a single font. The result is also much simpler and will make future searches easier. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-01overview-manual: delete bad backslashes in SSTATE_MIRRORS exampleRobert P. J. Day
Two inappropriate backslashes in the example for setting SSTATE_MIRRORS are apparently the result of an error by the transmogrification script for migrating XML to rST. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net>
2021-10-01ref-manual: add note about license implications of bundled initramfsDaniel Wagenknecht
Ensure users are aware that usage of INITRAMFS_IMAGE_BUNDLE is only appropriate for use with GPLv2 compatible software. Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-01common-tasks: add note about license implications of bundled initramfsDaniel Wagenknecht
Ensure users are aware that usage of INITRAMFS_IMAGE_BUNDLE is only appropriate for use with GPLv2 compatible software. Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-10-01ref-manual: mention INHIBIT_PACKAGE_DEBUG_SPLIT variableRobert P. J. Day
Following a detailed discussion of PACKAGE_DEBUG_SPLIT_STYLE, it seems only appropriate to refer the reader to INHIBIT_PACKAGE_DEBUG_SPLIT. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-28ref-manual: fix missed override syntax changeQuentin Schulz
Cc: Quentin Schulz <foss@0leil.net> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-28ref-manual: extend explanation of PACKAGE_DEBUG_SPLIT_STYLERobert P. J. Day
The current explanation of this variable seems incomplete, so be a bit more verbose to make sure the reader understands the packaging possibilities. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-27releases: update to include 3.1.11Michael Halstead
Adding 3.1.11 to documentation switcher and release list. Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
2021-09-18Merge branch 'master-next'Richard Purdie
2021-09-17releases: update to include 3.3.3Michael Halstead
Adding 3.3.3 to documentation switcher and release list. Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
2021-09-17dev-manual: update output of "wic list images"Robert P. J. Day
Output order from "wic list images" is in different order, and was missing a couple entries. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-17dev-manual: emphasize that new layers live outside of pokyRobert P. J. Day
Tweak the bblayers.conf example to encourage the reader to appreciate that any new layers should not share space with the official Poky checkout. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <foss@0leil.net>
2021-09-17ref-manual: update "devtool check-upgrade-status" outputMichael Opdenacker
This command now uses "INFO" insted of "NOTES" and output information in columns. Also good to show more recent versions of recipes. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-17ref-manual: improve documentation for RECIPE_NO_UPDATE_REASONMichael Opdenacker
This add a description of this variable to the variable index, and clarifies the explanations given in the devtool reference section. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-17ref-manual: improve "devtool check-upgrade-status" detailsMichael Opdenacker
- Mention "devtool latest-version recipe" to process a single version - Explain that the mechanism is controlled by the UPSTREAM_CHECK* variables, which are not referred to anywhere else in the manuals, except in the variable index. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Alexander Kanavin <alex.kanavin@gmail.com>
2021-09-17ref-manual: remove checkpkg taskMichael Opdenacker
It doesn't exist any more and its functionality is now taken care of by "devtool check-upgrade-status" Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net>
2021-09-17ref-manual: document UPSTREAM_CHECK_COMMITS and UPSTREAM_VERSION_UNKNOWNMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-17manuals: delete unmaintained history sectionsMichael Opdenacker
This deletes the history sections in each sub-manual, which didn't add any value, given that they didn't list the changes from one Yocto Project version to the next. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net>
2021-09-17manuals: replace Freenode by Libera Chat as IRC hostMichael Opdenacker
Fixes [YOCTO #14546] This also replaces the "#poky" channel (inactive) by "#oe", which is more actively used. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2021-09-17common-tasks: Add an example of using bbappends to add a fileTom Rini
Use the xserver-xf86-config_%.bbappend from meta-raspberrypi to provide an example of having a bbappend file add files to an existing recipe. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-17ref-manual: add overlayfs classVyacheslav Yurkov
Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-17ref-manual: couple minor tweaks to Chapter 1Robert P. J. Day
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>
2021-09-17ref-manual: add potential of parallelism to defn of "Task"Robert P. J. Day
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <foss@0leil.ṅet> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-17ref-manual: correct typo in "classes" section, "${BPN}/{PV}"Robert P. J. Day
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-17ref-manual: remove mention of obsolete devtool "--any-recipe" optionRobert P. J. Day
Running "devtool edit-recipe -h" produces, in part, the output: --any-recipe, -a Does nothing (exists for backwards-compatibility) so it seems of little value to continue referring to it. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-17ref-manual: render options in monospace to show quotes properlyRobert P. J. Day
It's important (at least for now) to mark up options with monospaced font to highlight the difference between single and double quotes. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-17dev-manual: update mailing list addressJon Mason
Signed-off-by: Jon Mason <jdmason@kudzu.us> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-03README: update manual list and names, online docs URLRobert P. J. Day
Minor tweaks to top-level README: - add missing line for overview manual - correct manual names to match their *actual* names - point reader at docs.yoctoproject.org for online docs Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2021-09-03ref-manual: update SYSROOT_DIRS_* variable entriesRobert P. J. Day
Both SYSROOT_DIRS and SYSROOT_DIRS_BLACKLIST have more current values. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <foss@0leil.net>
2021-09-03dev-manual: drop "three" since there are four requirementsRobert P. J. Day
Since there are actually four listed requirements, just drop the number to avoid future issues. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <foss@0leil.net>
2021-09-03dev-manual: various pedantic nitpickeryRobert P. J. Day
Some minor grammatical and structure tweaks. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <foss@0leil.net>