aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2020-11-20ref-manual: replace labels with references to section titleNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20sdk-manual: replace labels with references to section titleNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20what-i-wish-id-known: replace labels with references to section titleNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-13sphinx: releases: add link to 3.1.3Nicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-13conf.py: Improve TOC and Outline depth in PDF outputPaul Barker
The default PDF output shows only chapter headings in the table of contents and in the outline (aka PDF bookmarks). We should override these defaults to set something more suitable. With a depth of 2 for the TOC we see both section and subsection headings which is enough to get the list of classes in the reference manual and the list of topics under "Common Tasks" in the development manual. Going to a deeper level would make the TOC unwieldy but we do want to make sure we can navigate more precisely using the outline (commonly shown in a left tab in PDF viewers) so we set the depth to 5 for the outline. Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-12poky.yaml: updates for 3.2Nicolas Dechesne
Updates global variables for 3.2 / Gategarth release. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-12poky.yaml: remove unused variablesNicolas Dechesne
There are plenty of variables in poky.yaml which are not used anywhere in the docs. So let's remove them. We can always add the one we need later. Note ORGEMAIL could be used in boilerplate.rst, however this file is not parsed but included, and somehow the yocto-vars.py exenstion does not process this file, so we cannot use a variable there. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-12documentation: Add Pipenv supportJoshua Watt
Adds a Pipfile so that Pipenv can be used to automatically install all the dependencies required to build the documentation Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-09overview-manual-concepts: Fix the compiler bootstrap processRichard Purdie
gcc-cross-initial and glibc-inital were removed a while ago and this flow is incorrect anyway. Fix it to match what happens (adding libgcc and libgcc-initial which are now important in this context). Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-09conf: update for release 3.2Nicolas Dechesne
switchers.js: * add 3.2 release * update 'dev' to 3.3 Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-30adt-manual: delete obsolete ADT manual, and related contentRobert P. J. Day
Since the ADT manual has long been superseded by the SDK manual, remove the entire adt-manual directory, and the references to it in the two top-level files "conf.py" and "poky.yaml". Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-10-30README: "yocto-project-qs" -> "brief-yoctoprojectqs"Robert P. J. Day
Directory has been renamed, so fix README and add a bit more white space to keep everything lined up. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-29ref-manual/ref-variables: "PACKAGE_FEEDS_ARCHS" -> "PACKAGE_FEED_ARCHS"Robert P. J. Day
Fix single misspelling. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-29dev-manual: Add a note about prelink changing prebuild binariesRichard Purdie
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-29ref-manual: add migration info about MLPREFIX changesPaul Eggleton
Add a migration subsection on the need to add MLPREFIX to conditional package dependencies in gatesgarth. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-29ref-manual: add migration info for image-artifact-namesPaul Eggleton
Add some info on the image-artifact-names class change in gatesgarth. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-29ref-manual: add IMAGE_LINK_NAMEPaul Eggleton
Add IMAGE_LINK_NAME to the variable glossary. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-29ref-manual/faq: Add entry for why binaries are changed in imagesRichard Purdie
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-29ref-manual: add migration section for 3.2Paul Eggleton
This covers most of the changes that would require action on the part of the user that I was able to see by scouring the commits. Some of the text was borrowed from commit messages and edited. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-29ref-manual: add IMAGE_NAME_SUFFIX variablePaul Eggleton
Add a variable glossary entry for IMAGE_NAME_SUFFIX, which was added way back in krogoth. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-29ref-manual: add IMAGE_VERSION_SUFFIX variablePaul Eggleton
Add an entry to the variable glossary for IMAGE_VERSION_SUFFIX (which was added in thud) and update the IMAGE_NAME and KERNEL_ARTIFACT_NAME entries whose defaults use this variable. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-29ref-manual: add PSEUDO_IGNORE_PATHSPaul Eggleton
Add a brief variable glossary entry for the new PSEUDO_IGNORE_PATHS variable. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-28ref-manual: QA check updatesPaul Eggleton
* Update for changes to messages * Add missing QA checks - some added recently, others several releases ago Some of this was borrowed from commit messages (with editing) - in particular thanks to Alexander Kanavin for the writeup on patch-fuzz. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-28ref-manual: fix for features_check class changePaul Eggleton
distro_features_check was renamed to features_check and extended to support MACHINE_FEATURES, COMBINED_FEATURES and ANY_OF_*_FEATURES in dunfell, but the documentation still needed to be updated. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-28ref-manual: add reference anchors for each QA checkPaul Eggleton
Make it possible to link to the explanation for a particular QA check. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-27dev-manual/dev-manual-common-tasks: fix typos and use extlinksNicolas Dechesne
* fixed a couple of typos * added a 'nicer' link to the repo using :yocto_git: Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-26docs: kernel-dev-faq: update outdated RDEPENDS_kernel-baseQuentin Schulz
Since 2.5 (sumo), RDEPENDS_kernel-base has been replaced by RDEPENDS_${KERNEL_PACKAGE_NAME}-base, so let's use this one instead. Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-26docs: kernel-dev-common: add .patch file extension to SRC_URI filesQuentin Schulz
Patches provided in SRC_URI are only applied if their extension is .diff or .patch. The examples do not use those extensions and would probably result in user confusion as to why the patches aren't being applied to the sources. Let's fix this by giving them a .patch file extension. Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-26docs: kernel-dev: fix typos, highlights and linksQuentin Schulz
Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-26sphinx: add 3.1.3 and 3.0.4 release in the switcherNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-26dev-manual/dev-manual-common-tasks: fix warningNicolas Dechesne
A new warning was introduced in 59908cecb528 (docs: Updated the status of spdx module.) The code-block section belongs to the #3 item in the enumerated list. While at it, also fixed a typo in the text. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-26ref-manual: Document wic --offset optionJoshua Watt
Adds documentation that describes how to use the --offset argument in a kickstart file Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: bsp-guide: bsp: fix typos, highlights and linksQuentin Schulz
Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: ref-manual: ref-terms: add links to terms in glossaryQuentin Schulz
Everything declared in a glossary has a "term-" link that is usable as an HTML anchor. The link already works, one just cannot get a link from within the ref-terms page. Let's make this possible. Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19ref-variables: Given example for naming sourcesJoshua Watt
Adds an example to SRC_URI that explains how to name sources in SRC_URI and how to associate SRCREVs and checksums with the names Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: dev-manual: fix typos, highlights, indentation and linksQuentin Schulz
Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: dev-manual-common-tasks: update python webserver example to python3Quentin Schulz
SimpleHTTPServer is python2 only, the module in python3 is http.server. Let's use this one since everything in Yocto Project is using python3 nowadays. Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: dev-manual-common-tasks: remove paragraph about race when missing DEPENDSQuentin Schulz
Missing DEPENDS were an issue before rocko (2.4) because of a shared global sysroot. Since then, every recipe has its own sysroot, it is not possible to build successfully a recipe without all DEPENDS. Therefore, races in tasks possibly triggered by missing DEPENDS are a thing of the past. This paragraph is misleading and can be safely removed. Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19sdk-manual: use built-in footnotesNicolas Dechesne
The current HTML output is bogus, because we have a fix of * and \. Sphinx has built-in footnotes that can be used in this specific example. let's use that instead. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: poky.yaml: fix identation in host packages variablesQuentin Schulz
This unfortunately makes the variables probably unusable for proper replacement in other indentation blocks. Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: sphinx: yocto-vars: rebuild files when poky.yaml has changedQuentin Schulz
poky.yaml changes aren't detected by Sphinx by default. In order to detect changes in poky.yaml, its md5sum is stored in the app.outdir (BUILDDIR/html when building html) and checked against the md5sum of the poky.yaml under use. If the md5sum has changed, find all rst files in app.srcdir that have at least an occurence of `&.*;` and mark them as requiring a rebuild. Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: ref-manual: ref-system-requirements: update requirements to build ↵Quentin Schulz
Sphinx docs Tested with containers on all supported distributions. Debian 8 (Jessie) still has Python3.4 and an old pip3, which makes it impossible to build typing module which is a requirement of "new" Sphinx python module. One cannot update to latest pip3 from within pip in Jessie's version. One cannot get a newer pip from upstream because newer pip don't support Python3.4 anymore. One cannot build with python3-sphinx package from Jessie because the package is too old (1.2.3) and does not have sphinx.ext.autosectionlabel module which appeared in 1.4 version. Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: ref-manual: ref-classes: remove dropped tinderclient classQuentin Schulz
tinderclient class was dropped in dunfell. Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: ref-manual: migration-2.3: specify 2.3 version instead of DISTROQuentin Schulz
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: ref-manual: fix typosQuentin Schulz
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: remove OE_INIT_FILE variableQuentin Schulz
There's probably no need for such a variable (the name of the script is unlikely to change any time soon) and not all instances of oe-init-build-env were actually using this variable. For consistency sake, let's just remove the OE_INIT_FILE variable. Suggested-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: ref-manual: indentation, links and highlights fixesQuentin Schulz
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-19docs: poky.yaml: use HTTPS for linksQuentin Schulz
Manually tested, ran linkcheck on it too. Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-12docs: Updated the status of spdx module.leimaohui
- Deleted content about old spdx.bbclass. - Added usage of meta-spdxscanner. Signed-off-by: Lei Maohui <leimaohui@cn.fujitsu.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-12dev/test/ref-manual: Fix typosNaoki Hayama
Fix some typos. s/necesary/necessary/ s/overriden/overridden/ Signed-off-by: Naoki Hayama <naoki.hayama@lineo.co.jp> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-06-13 05:18:16 +0000