summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* documentation: prepare for 3.1.6 releaseSteve Sakoman2021-02-172-5/+5
| | | | | | | | | Bump the current version to 3.1.6 (From yocto-docs rev: 660684b1a1ece4bdedfd63b9fc65d14f05c226d5) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: prepare for 3.1.5 releaseSteve Sakoman2021-01-132-5/+5
| | | | | | | | | Bump the current version to 3.1.5 (From yocto-docs rev: b367b2ece436cdd86f8408fbec1b263e03ed4267) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: update link to bitbake docsNicolas Dechesne2021-01-042-2/+2
| | | | | | | | | | The Sphinx based Bitbake documentation for dunfell release is published to https://docs.yoctoproject.org/bitbake/1.46/. (From yocto-docs rev: b8a0f97563d9680786228ecd11fafb8a4c09ea0a) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* conf.py: set version to 3.1.4Nicolas Dechesne2021-01-041-1/+1
| | | | | | | (From yocto-docs rev: 488a421fea826a2cff27dd009768430769f25ab0) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: enable parallel buildNicolas Dechesne2021-01-041-1/+1
| | | | | | | | | | | | | | | >From sphinx-build man page: -j N build in parallel with N processes where possible (special value "auto" will set N to cpu-count) (From yocto-docs rev: f83b7921f99a1e1f448c2694184dd72e8f09c2d2) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 1847aeea8b88c84f821610803264955e51e31d2f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* conf.py: Improve TOC and Outline depth in PDF outputPaul Barker2021-01-041-0/+5
| | | | | | | | | | | | | | | | | | | | | | 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. (From yocto-docs rev: f74238d08163f6fc45939422ae96a3d69c0e4449) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 5db16d3b01da0a138b6413347fcf2321a1bfae08) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: remove unused variablesNicolas Dechesne2021-01-041-47/+0
| | | | | | | | | | | | | | | | | | 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. (From yocto-docs rev: 4c72a3b1a8e7b0d3164ef23cf47898834837b9d3) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit f1164d2e6401d93e0b4e484b090abbe0f72a6ac7) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Add Pipenv supportJoshua Watt2021-01-043-0/+22
| | | | | | | | | | | | | Adds a Pipfile so that Pipenv can be used to automatically install all the dependencies required to build the documentation (From yocto-docs rev: 5fc0a3011c47388d9c6447c3be00fefcbaf00f5c) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 31658ad30827d38dcd4ea83bcfb828441c7c3eca) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: delete obsolete ADT manual, and related contentRobert P. J. Day2021-01-0410-1184/+1
| | | | | | | | | | | | | | 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". (From yocto-docs rev: bdf601bfa07e05e3f834581d87105d0ebb4034d0) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (cherry picked from commit 64b2e83bddf6af0439ac7089ac95e60faa696cfc) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: "yocto-project-qs" -> "brief-yoctoprojectqs"Robert P. J. Day2021-01-041-9/+9
| | | | | | | | | | | | | Directory has been renamed, so fix README and add a bit more white space to keep everything lined up. (From yocto-docs rev: 98da73f772f5ad8edb47f7c6d1e1c55133d51fdd) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit cdd4c705f7271e31e44a94c79b050eda1fba5945) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: "PACKAGE_FEEDS_ARCHS" -> "PACKAGE_FEED_ARCHS"Robert P. J. Day2021-01-041-1/+1
| | | | | | | | | | | | Fix single misspelling. (From yocto-docs rev: b2c27374ccd7266a1296141ea409b57f2b3842c3) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit e1a47857f4ff3edb105e7fa80ff8d29dcc3ece03) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Add a note about prelink changing prebuild binariesRichard Purdie2021-01-041-0/+7
| | | | | | | | | (From yocto-docs rev: 515cfe544ff7a96c20b3f94061e54fb60a8725f7) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 6c023ee1328bb31ececd9e1daaac67351c8320e3) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add IMAGE_LINK_NAMEPaul Eggleton2021-01-041-0/+11
| | | | | | | | | | | | Add IMAGE_LINK_NAME to the variable glossary. (From yocto-docs rev: 83ec0ccbf1b5f58f730c739ee7bcfc3d4afabf1d) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 370551f961a291f7090a8a40a0beea3511274bc1) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add IMAGE_NAME_SUFFIX variablePaul Eggleton2021-01-041-0/+7
| | | | | | | | | | | | | Add a variable glossary entry for IMAGE_NAME_SUFFIX, which was added way back in krogoth. (From yocto-docs rev: 8158dd587b9ea0085bd9a4bde04d41ef4fdd7f62) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 78920a8ea5fb991606300c1fcb48aa6a7c20f8c1) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add IMAGE_VERSION_SUFFIX variablePaul Eggleton2021-01-041-8/+12
| | | | | | | | | | | | | | 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. (From yocto-docs rev: 0bf966138d4f042de4d5a2fea3b604165f596efe) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 1a02c4be8e348687d4f7e09aefc408aaed5f1be5) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/faq: Add entry for why binaries are changed in imagesRichard Purdie2021-01-041-0/+11
| | | | | | | | | (From yocto-docs rev: 33915ef51d0661c4dc76c572456a10a54fba960b) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 843a91187783b2e11512c45b8dd8302b19113569) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: fix for features_check class changePaul Eggleton2021-01-042-21/+46
| | | | | | | | | | | | | | 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. (From yocto-docs rev: 3d565c61086c235f77d967acf7599e64f5944cb4) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 274eb596582a22883e8b386a07cf32ed45a77d79) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add reference anchors for each QA checkPaul Eggleton2021-01-041-0/+36
| | | | | | | | | | | | Make it possible to link to the explanation for a particular QA check. (From yocto-docs rev: 4274fa0966f9870baaeeb43e693c612f9e9c5c87) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 3f6dc24e0a371feca8fe66c1be8c86e599307854) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: kernel-dev-faq: update outdated RDEPENDS_kernel-baseQuentin Schulz2021-01-041-1/+1
| | | | | | | | | | | | | Since 2.5 (sumo), RDEPENDS_kernel-base has been replaced by RDEPENDS_${KERNEL_PACKAGE_NAME}-base, so let's use this one instead. (From yocto-docs rev: 1eb4922610c8469af75a6efd9d4b505968d6e6a2) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 0639160185969a6761e9911a166b897a015f4d59) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: kernel-dev-common: add .patch file extension to SRC_URI filesQuentin Schulz2021-01-041-3/+3
| | | | | | | | | | | | | | | | | 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. (From yocto-docs rev: 80a01f141b3f09f42b53f3ef4d380fba6551fe90) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 0858e86ed8e3e3005207980041fe4f2117750663) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: kernel-dev: fix typos, highlights and linksQuentin Schulz2021-01-046-287/+211
| | | | | | | | | | (From yocto-docs rev: 35bf202fb725ce9f0ae28023e36bb8568ac3885d) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit a69247321ff34cb0a2b9a8cc62020ec7f3aad834) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: add 3.1.3 and 3.0.4 release in the switcherNicolas Dechesne2021-01-041-2/+2
| | | | | | | | | | (From yocto-docs rev: 3fa0e1c53dd7e40a11e0b1216b468e18cac20c18) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 64c7cb54e031b5b0babc8ee33dac0b9162a5f391) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Document wic --offset optionJoshua Watt2021-01-041-0/+5
| | | | | | | | | | | | | Adds documentation that describes how to use the --offset argument in a kickstart file (From yocto-docs rev: d993d9353fd27a9c9beebdef180a2adf36099514) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 0fbb2d71fe866b4ae7721f2f70d5b50dbc019030) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: bsp-guide: bsp: fix typos, highlights and linksQuentin Schulz2021-01-041-36/+40
| | | | | | | | | | (From yocto-docs rev: 2ce227fb131ae2052218a3008a80ba8a98a19cce) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit cb0e11170b34b332b41f8b533545c69b05c696c0) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: ref-terms: add links to terms in glossaryQuentin Schulz2021-01-041-24/+24
| | | | | | | | | | | | | | | | | 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> (From yocto-docs rev: b56c2d5bbf05e813656f2472f92f1f9b4db9bba2) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit fcbb267fba968834d4d9d011fc71cc371f910447) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-variables: Given example for naming sourcesJoshua Watt2021-01-041-2/+12
| | | | | | | | | | | | | 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 (From yocto-docs rev: 15d16cced2cccfc120975e5687c45b5aab3dd6eb) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 900af0addab7d6ea465922957f881a13012429ed) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: dev-manual: fix typos, highlights, indentation and linksQuentin Schulz2021-01-044-688/+566
| | | | | | | | | | (From yocto-docs rev: 97b9e0c8b7723b7daf1534ccd5cadf65ea03f724) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit ab244dcd48968ea6d0e328808c9aac4aef281032) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: dev-manual-common-tasks: update python webserver example to python3Quentin Schulz2021-01-041-3/+3
| | | | | | | | | | | | | | | 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. (From yocto-docs rev: a5922b045eca9aa96672f8d75a2f98e17d2280f7) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 75338f17b116afadb7360181d071875a68272708) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: dev-manual-common-tasks: remove paragraph about race when missing DEPENDSQuentin Schulz2021-01-041-16/+7
| | | | | | | | | | | | | | | | | 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. (From yocto-docs rev: 8547d2623b32d33758b326e735509dc0a13625fc) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 9aec42794846a4bca37b49a9f920fa2887974ddf) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: use built-in footnotesNicolas Dechesne2021-01-041-20/+13
| | | | | | | | | | | | | | 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. (From yocto-docs rev: ebac4486e711152962bb8cd22b55ddce332b07f6) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 5be36103ca1102c995915a20bf881e43920595e3) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: poky.yaml: fix identation in host packages variablesQuentin Schulz2021-01-041-7/+7
| | | | | | | | | | | | | This unfortunately makes the variables probably unusable for proper replacement in other indentation blocks. (From yocto-docs rev: 2f66f0bd7d9167fc49779d7b9ab1e4388bca4428) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit adf240b8db9597328324bbfb0095f573bea217f9) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: sphinx: yocto-vars: rebuild files when poky.yaml has changedQuentin Schulz2021-01-041-2/+41
| | | | | | | | | | | | | | | | | | | 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. (From yocto-docs rev: 3816a23462ad9eafbf49d455d06e64638de8ea26) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 59537c7fa49e3ea6918f45b3201ad16d56988b9b) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: ref-system-requirements: update requirements to build ↵Quentin Schulz2021-01-042-8/+17
| | | | | | | | | | | | | | | | | | | | | | | | | 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. (From yocto-docs rev: db2e97515636674a0b04d2fe3f35b433b49b6c0f) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 14da565986a573ac7e0b5c5943e55b7b74f99dd5) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: ref-classes: remove dropped tinderclient classQuentin Schulz2021-01-041-12/+0
| | | | | | | | | | | | | tinderclient class was dropped in dunfell. Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: cc7d66576a4c4cdfaa0643b8e0e7dc0549a25599) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 241059880bbfa61b61cf1843447e1b6d57c71ebe) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: migration-2.3: specify 2.3 version instead of DISTROQuentin Schulz2021-01-041-2/+2
| | | | | | | | | | | Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: c3e958c3b31c2288fd5e04b9f5efe22e8ccade3c) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 19b3ce7bc46b76207a6f3733881f3f16deab5a0d) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: fix typosQuentin Schulz2021-01-048-13/+13
| | | | | | | | | | | Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: 2d5206044db1885e8625721e1e48579d80b95852) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit f21e92f74c8357b23fd4059af6815fbba9487147) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: remove OE_INIT_FILE variableQuentin Schulz2021-01-045-7/+5
| | | | | | | | | | | | | | | | | 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> (From yocto-docs rev: 322b9a676b8897d93fe046b4c37a745d472cd4c6) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 6fd4421283005b0ecc980e9ef25770d383b93937) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: indentation, links and highlights fixesQuentin Schulz2021-01-0426-837/+509
| | | | | | | | | | | Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: 27f6527882d22f20641882018ca5b8a7a30092ae) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit f5688a74cd9d100dee270edb9a33c02015cfabda) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: poky.yaml: use HTTPS for linksQuentin Schulz2021-01-041-9/+9
| | | | | | | | | | | | | Manually tested, ran linkcheck on it too. Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: 9099cd175a65aedff03a43ed43de90217750dc3c) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 46912c4c7e429f01dba52071efa649e8c4fbaf06) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev/test/ref-manual: Fix typosNaoki Hayama2021-01-042-2/+2
| | | | | | | | | | | | | | Fix some typos. s/necesary/necessary/ s/overriden/overridden/ (From yocto-docs rev: 31f64af42474cbf965f9c9c216ad44939d9f498b) Signed-off-by: Naoki Hayama <naoki.hayama@lineo.co.jp> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit f4ce6ae80b1d96f9b8bead013642aeda0c776182) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UKRichard Purdie2021-01-0476-76/+76
| | | | | | | | | | | | | | When the license identifier tags were added, an incorrect string was used and the Share-Alike clause was lost. Fix this to match the license description in the files and add back the lost piece (its clear from the history it should be there) (From yocto-docs rev: ac9eede80f19c6e2138406209ab5700e89a244a0) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 8d30c3d792755a7bfdb74b331dad98f51d3516af) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: rename Makefile.sphinxNicolas Dechesne2021-01-042-4/+4
| | | | | | | | | | | | Now that the DocBook files are removed, we can rename the top level Makefile. (From yocto-docs rev: eb412a93ec93b3413e23f028f33bda88f82ac688) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (cherry picked from commit 25fefa9a91ba5d7b398443f543e2c46165e8a3f4) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: remove DocBook filesNicolas Dechesne2021-01-04202-98022/+0
| | | | | | | | | | | | The Yocto Project documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (From yocto-docs rev: abdb6b6bdfef3dc8e8cc13779e44a8d6df903469) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (cherry picked from commit 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: ref-variables: add links to terms in glossaryQuentin Schulz2021-01-041-581/+581
| | | | | | | | | | | | | | | | | Before the move to Sphinx, it used to be possible to get a direct link to a variable from the term glossary. It is very useful when pointing people to a specific variable when manually looking for it in the glossary. Let's add this "feature" back. (From yocto-docs rev: ee811e9f351eb79987dcdc2c2dbbd14ac52d92ca) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 9e468274eaad270efd5f50e58a523798fcb8097e) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: ref-variables: fix alphabetical order in glossaryQuentin Schulz2021-01-041-85/+85
| | | | | | | | | | | (From yocto-docs rev: 7b8763580813466d10efd0c0df90dc6403f18894) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 77aa3990cab4fb01706d0b6b0284c38e4d9dda56) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: ref-variables: fix one-letter pointer links in glossaryQuentin Schulz2021-01-041-8/+8
| | | | | | | | | | | | | | | | Since the move to sphinx, variables aren't linked with var- anchors but term-. Let's fix that so clicking on a letter will bring to the correct variable in the page. (From yocto-docs rev: 731d8b62ba588200d7d57cee0fd56256f32bd9a2) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 07718faa04a8b121be004afbc23b4c338f669413) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: fix up some trademark and branding issuesNicolas Dechesne2021-01-043-3/+15
| | | | | | | | | | | | | | | | | | | | | | | The following changes were required after a review of trademark and branding guidelines: 1. add (R) to 'Yocto Project' on the top left (above the logo) 2. Fix up the capitalization of the main page title 3. Add the copyright/legal blurb at the bottom of the page For 3. it turned out to be simpler to override the whole footer.html template, and maintain our own version. Also I took the liberty to remove the 'next' and 'previous' buttons since I believe they are not especially useful, given the navigation bar on the left side. Reported-by: Tracey Erway <tracey.m.erway@intel.com> (From yocto-docs rev: a29ee99f81aa5b3cc66493e79712a3b5dc31e23f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> (cherry picked from commit 6bae1372218e0b10258e4fa6fef72fc1708a329c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: remove test-manualNicolas Dechesne2021-01-0415-3166/+1
| | | | | | | | | This is a new manual in YP 3.2, let's remove it from the 3.1 Sphinx backport. (From yocto-docs rev: baf4410abad44b7f1fc6e4f1c445060b87c21c32) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: reintroduce changes for 3.1.1, 3.1.2, 3.1.3 and 3.1.4Nicolas Dechesne2021-01-0410-8/+110
| | | | | | | | | | | | | | | | | | | The following changes were undo'd when the Sphinx docs were backported in dunfell: 069c27574 Documenation: Prepared for the 3.1.1 release bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit 17cc71a8f Documenation: Prepared for the 3.1.2 release 1a69e2c02 Documenation: Prepared for the 3.1.3 release 8910ac1c7 Documenation: Prepared for the 3.1.4 release In this commit, we reintroduce the content related to these patches, but in the .rst files. (From yocto-docs rev: a6a1b8e9df26b4b4ccf5c5c9cc3c02fa156cf81f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: undo (ref-system-requirements: update supported hosts lists)Nicolas Dechesne2021-01-041-6/+4
| | | | | | | | | | | This change was made in Sphinx/master, but does not apply to dunfell. Since we inherited it from the Sphinx migration, we need to undo it. (From yocto-docs rev: f5132957398af9644188cf010acec55bca6e8a8e) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-15 00:47:17 +0000