summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.rst
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* 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: fix for features_check class changePaul Eggleton2021-01-041-6/+20
| | | | | | | | | | | | | | 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-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: ref-manual: fix typosQuentin Schulz2021-01-041-1/+1
| | | | | | | | | | | 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: ref-manual: indentation, links and highlights fixesQuentin Schulz2021-01-041-465/+259
| | | | | | | | | | | 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>
* dev/test/ref-manual: Fix typosNaoki Hayama2021-01-041-1/+1
| | | | | | | | | | | | | | 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-041-1/+1
| | | | | | | | | | | | | | 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>
* 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: import docsNicolas Dechesne2021-01-041-0/+8899
The Yocto Project docs was migrated from Docbook to Sphinx in YP 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to' the docs in 3.2, we agreed to backport sphinx docs onto 3.1. This first patch brings all changes done in 3.2 until: 7f64574f7 README: include detailed information about sphinx There are other changes after this commit, but they will be selectively backported in individual patches. This patch was generated with the following command: git cherry-pick -n \ $(git log --reverse --oneline \ ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \ | cut -f1 -d' ') The following commits were applies in the dunfell docs, but not in master, so they were first reverted (and squashed into this change). A commit will reintroduce the content from these patches in the Sphinx files in a followup patch. 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 (From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>