summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
Commit message (Collapse)AuthorAgeFilesLines
...
* ref-manual: variables: add example for SYSROOT_DIRS variableBELHADJ SALEM Talel2023-10-201-0/+29
| | | | | | | | (From yocto-docs rev: 65b62118da6f355e56c489c6be08ba9ea94b9f04) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: add TOOLCHAIN_OPTIONS variableBELHADJ SALEM Talel2023-10-201-0/+10
| | | | | | | | (From yocto-docs rev: 6f7bd97a6d3d6d8cfd149a7e07df35da4141e650) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: add RECIPE_SYSROOT and RECIPE_SYSROOT_NATIVEBELHADJ SALEM Talel2023-10-201-0/+35
| | | | | | | | (From yocto-docs rev: 8aa25e2a668d35bab2f79457248abcde92dc92aa) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: provide no-match example for COMPATIBLE_MACHINEQuentin Schulz2023-10-201-1/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | COMPATIBLE_MACHINE is used to forbid the use of a recipe or its packages for a specific set of machines. In some cases, it may make more sense to have the logic inverted and have the recipe always forbidden except for hand-picked machines. Such could be the case for pieces of software that only support some architectures. In that scenario, it is sometimes a bit easier on the eye and for maintenance to use the OVERRIDES mechanism but for that, a default should be set. COMPATIBLE_MACHINE:aarch64 = "^(aarch64)$" COMPATIBLE_MACHINE:mips64 = "^(mips64)$" wouldn't do much because if COMPATIBLE_MACHINE isn't set, the recipe is assumed compatible and therefore, if no default is provided we enter that case. Hence, we need to add COMPATIBLE_MACHINE = "^$" as default so that it only matches the empty string, which isn't possible for MACHINEOVERRIDES. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 52196d39bc85de267daffb0074eb59786751f57d) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fix PACKAGECONFIG term and add an exampleBELHADJ SALEM Talel2023-10-201-6/+36
| | | | | | | | | | | | | | PACKAGECONFIG's first and second flag value will be added to PACKAGECONFIG_CONFARGS and then it will be added to the appropriate variable (EXTRA_OECMAKE, or ...) So we need to only mention PACKAGECONFIG_CONFARGS and it will lead to other variables. I added a custom example that can help understanding very well PACKAGECONFIG. (From yocto-docs rev: 7f26b0c0a08d6be9810128369265b0c494e7191b) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: update list of supported machinesMichael Opdenacker2023-10-201-2/+1
| | | | | | | | | | The EdgeRouter machine is no longer supported. https://git.yoctoproject.org/poky/commit/?id=0c64d0e4317e3749f7f7ed9ecd5d08bbb0cedc9e (From yocto-docs rev: e600522f2d2514bdd888c91043b9c59563ee7a6d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: update linux-yocto append examplesMichael Opdenacker2023-10-201-6/+5
| | | | | | | (From yocto-docs rev: 0d195d66e434ddedd33bf8db89643fa5ab192e29) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Warn about COMPATIBLE_MACHINE skipping native recipesArne Schwerdt2023-10-201-0/+7
| | | | | | | | (From yocto-docs rev: fcc9b54cc46a0831f79a96e041cbe8deed58cf66) Signed-off-by: Arne Schwerdt <arne.schwerdt@elbbits.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document LICENSE_FLAGS_DETAILSRoss Burton2023-09-191-0/+17
| | | | | | | | | (From yocto-docs rev: 299c9b295a8476abdb32fba01ac2f45efacea6f1) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove AUTHOR variableMichael Opdenacker2023-08-301-4/+0
| | | | | | | | | Following https://git.openembedded.org/openembedded-core/commit/?id=9d5edd124b7dddb995ceddd79f8a7fc8cf44badf (From yocto-docs rev: e7da4d122313f369be1c680dadd76ea53ba8dd04) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document image-specific variant of INCOMPATIBLE_LICENSEAlexander Kanavin2023-08-031-2/+11
| | | | | | | | | | | | This has been around without being properly documented since 2019 (!!!), and is nowadays the preferred method for enforcing license restrictions, especially since meta-gplv2 is officially obsolete. (From yocto-docs rev: efa1c57ecec934998792b7851b4a162be92c8b23) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document CVE_STATUS and CVE_CHECK_STATUSMAPAndrej Valek2023-08-031-5/+29
| | | | | | | | | | | Deprecate CVE_CHECK_IGNORE with CVE_STATUS (From yocto-docs rev: 8b8054977f31e2d6090521a0102f066b6d563733) Signed-off-by: Andrej Valek <andrej.valek@siemens.com> Signed-off-by: Peter Marko <peter.marko@siemens.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix unnecessary double white spaceQuentin Schulz2023-06-241-2/+2
| | | | | | | | | | | There's no need for double white spaces here so let's just remove them. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: e41f6689157359777c3d86d9a7afed6f9e43782b) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: explicit variables accepting colon separated listsMichael Opdenacker2023-06-241-17/+22
| | | | | | | | | | | | [YOCTO 15128] (From yocto-docs rev: af5f4bfd213d2678c0f0463ddff321980d6c9669) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Reported-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* variables.rst: document OEQA_REPRODUCIBLE_TEST_TARGET and ↵Mikko Rapeli2023-06-161-0/+9
| | | | | | | | | | | | | | OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS They control which build targets to use when testing build reproducibility and which build targets can reuse sstate cache during the test. (From yocto-docs rev: d2a9f64dd24978a7baf31cf210cdb7f35dd3d15a) Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add clarification for SRCREVEd Beroset2023-06-161-1/+1
| | | | | | | | | | | | | It was not clear to me what a "full revision identifier" was in the context of the note documenting SRCREV. After clarification via IRC, this submission attempts to clarify what is meant to help future readers. (From yocto-docs rev: 484a2d039ffbdde4229cbe20f0ab2c5fc8217d88) Signed-off-by: Ed Beroset <beroset@ieee.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document SPLASH_IMAGES variableMichael Opdenacker2023-06-021-0/+32
| | | | | | | (From yocto-docs rev: a30204ade74a93077017e3c5e1167102a0213983) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document SPLASH variableMichael Opdenacker2023-06-021-0/+6
| | | | | | | (From yocto-docs rev: d32029dd3ce4a66e2fb403a778f748f4a1d52bcc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: improve documentation for kernel-devicetree classMichael Opdenacker2023-05-261-0/+35
| | | | | | | | | | | - Document the new KERNEL_DTBDEST and KERNEL_DTBVENDORED variables - Also document the related KERNEL_DEVICETREE_BUNDLE and KERNEL_PACKAGE_NAME variables (From yocto-docs rev: 19f128e725da35234ec2c234c667ee7ff3d67d8d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document uboot-sign class and variablesMichael Opdenacker2023-05-261-5/+116
| | | | | | | | | (From yocto-docs rev: 221bcf2e32fb42b6527ff0b4cfe0c4591ab89f78) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Jamin Lin <jamin_lin@aspeedtech.com> CC: Sean Anderson <sean.anderson@seco.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: improve description of kernel-fitimage variablesMichael Opdenacker2023-05-261-39/+66
| | | | | | | | | | | | | | - Mentioning that they are related to this class (for further information about their usage) - Replace "fitImage" by "FIT image" - Minor formating and style fixes (From yocto-docs rev: 07214a4ff2646efb143a02fc9381a029870e9b56) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Jamin Lin <jamin_lin@aspeedtech.com> Reviewed-by: Sean Anderson <sean.anderson@seco.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document devicetree class variablesPetr Kubizňák2023-05-261-0/+22
| | | | | | | | | | | Document the newly added DT_FILES variable and closely related DT_FILES_PATH. Also add DT_PADDING_SIZE to the glossary. (From yocto-docs rev: 8f3f187e2353c718c6fb4e224d13ba559ad2f85b) Signed-off-by: Petr Kubizňák <kubiznak@2n.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document FIT_ADDRESS_CELLSMichael Opdenacker2023-05-061-0/+26
| | | | | | | | (From yocto-docs rev: 81ee2e82a5bd0b7f1cb910bf266ceb808c05bba9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Jamin Lin <jamin_lin@aspeedtech.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: don't mention the INIT_MANAGER "none" optionMichael Opdenacker2023-05-041-5/+0
| | | | | | | | | | | | | As it is mainly used for internal purposes, so not necessarily useful for regular users. OE-core "nodistro" uses it as a fallback to the default setting. (From yocto-docs rev: aa4d4034707d7c74488678e77d4f45d65782b2a7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: document KERNEL_DANGLING_FEATURES_WARN_ONLYMichael Opdenacker2023-04-281-0/+14
| | | | | | | | (From yocto-docs rev: dc59b636bb4319a3af552bce84929ddb22a479fb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Bruce Ashfield <bruce.ashfield@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: expand init manager documentationMichael Opdenacker2023-04-281-7/+24
| | | | | | | | | | | | | | | | | | - Add details about INIT_MANAGER Correct the fact that "none" currently generates an image with "sysvinit", at least on Poky. This behaviour should probably be changed. - Expand the "Selecting an Initialization Manager" section. - Stop mentioning "rescue image" generation, as this is not detailed anywhere else. (From yocto-docs rev: fd99f2753b50b7ad6133b787b90331fcb3a35152) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document SPDX_CUSTOM_ANNOTATION_VARSMichael Opdenacker2023-04-281-0/+26
| | | | | | | | | (From yocto-docs rev: 5811f4eb3e73aa5f8ca90e40ec6559a6d4d58fa3) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Saul Wold <Saul.Wold@windriver.com> CC: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: add wikipedia shortcut for "getty"Michael Opdenacker2023-04-281-11/+8
| | | | | | | (From yocto-docs rev: 2f07fddce909d13a7175e713118af7730e2e5529) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev/ref-manual: Document INIT_MANAGERPaul Eggleton2023-04-221-0/+15
| | | | | | | | | | | | The INIT_MANAGER variable was added in 3.0 but it seems we didn't get around to documenting it yet. I have added a variable glossary entry and made the basic adjustment of the "Using systemd Exclusively" section in the dev manual, however I think the latter section still needs work. (From yocto-docs rev: 602c0e8f770516256dab04edfd887377303c06bb) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: move Initramfs entry from variables to termsPaul Eggleton2023-04-221-42/+0
| | | | | | | | | | It looks like this was accidentally added to the variable glossary instead of the terms list, so move it to the latter. (From yocto-docs rev: c9829dcae18cd2cb5f008081d841ca995b76b8bf) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add SDK_ARCHIVE_TYPEPaul Eggleton2023-04-221-0/+8
| | | | | | | | | | This appears to have been introduced back in 2019, but we missed documenting it. (From yocto-docs rev: 064a5d84890416362a1a7a337347abbe9afe485d) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add FIT_CONF_DEFAULT_DTBPaul Eggleton2023-04-221-0/+4
| | | | | | | | | New variable in 4.2. (From yocto-docs rev: 1228ce16a33bd6f00e5399e4c381be808a272281) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Remove references to package_tar classPaul Eggleton2023-04-221-33/+2
| | | | | | | | | This has been removed in 4.2. (From yocto-docs rev: a5dcaf95915deec5243ab2fd0711c63e98b2a661) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add BB_CACHEDIRPaul Eggleton2023-04-221-0/+3
| | | | | | | | | | New in 4.2 (pointer to BitBake manual, changes sent separately for that). (From yocto-docs rev: a2112eb3f1084040ad48e392075297b4630b93e1) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev/ref-manual: Remove references to INC_PRPaul Eggleton2023-04-221-37/+0
| | | | | | | | | | This technique is no longer used (nor necessary), let's just remove it to avoid any confusion. (From yocto-docs rev: 8f50d0bf22fea8064c112f52df06dbd6a85a7a83) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: update for IMAGE_MACHINE_SUFFIX additionPaul Eggleton2023-04-221-31/+50
| | | | | | | | | | | | | | | | | IMAGE_MACHINE_SUFFIX is a new variable in 4.2, and there were some associated changes to how IMAGE_NAME, IMAGE_LINK_NAME, INITRAMFS_IMAGE_NAME and KERNEL_ARTIFACT_NAME are set by default. As a result, instead of repeating how KERNEL_ARTIFACT_NAME is set by default, let's just direct people to the entry for that variable so we only have to update one place. At the same time I noticed INITRAMFS_IMAGE_NAME was not documented at all, so add that in. (From yocto-docs rev: d53bf2878a268fb71785c73053e3657436f3f5ba) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add new RUST_CHANNEL variablePaul Eggleton2023-04-221-0/+5
| | | | | | | | | Newly added for 4.2. (From yocto-docs rev: 89b583413e616aafa5f853a7631cac0f97d387db) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add new SDK_ZIP_OPTIONS variablePaul Eggleton2023-04-221-0/+5
| | | | | | | | | Newly added for 4.2. (From yocto-docs rev: e599d82cb3377900632182d216925a2aa44d3989) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: document VOLATILE_TMP_DIRMichael Opdenacker2023-04-131-0/+12
| | | | | | | | (From yocto-docs rev: 9e66f080b3609e5d51648feec4d6d7ff72644e9e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: update LAYERSERIES_COMPATMichael Opdenacker2023-03-201-25/+1
| | | | | | | | | | | | | - Replace by a reference to the description which was moved to the BitBake manual. - Also drop the reference to the Yocto Project Development Tasks Manual which doesn't add extra information on this variable. (From yocto-docs rev: 87cdda981fa6a3d05c559fb00e214214956346dc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify references to the BitBake User ManualMichael Opdenacker2023-03-201-42/+38
| | | | | | | | | | | | | | | | | | | | - Replacing :ref:`bitbake:bitbake-user-manual/...` by :ref:`bitbake-user-manual/...` Adding "bitbake:" as a prefix is not necessary as there is no naming conflict between the YP and the BitBake manuals (all documents are in "bitbake-user-manual/") - Explaining the rules in the README file - When necessary, fixing line length in the modified paragraphs. (From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: clarify explanations about feature backfillingMichael Opdenacker2023-03-201-17/+33
| | | | | | | | | | | (From yocto-docs rev: edae43e60230ad5f2384f0a518b42fc08efc699e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Joshua Watt <JPEWhacker@gmail.com> CC: Martin Jansa <martin.jansa@gmail.com> CC: Tom Hochstein <tom.hochstein@nxp.com> CC: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document COMMERCIAL_[AUDIO|VIDEO]_PLUGINS variablesMichael Opdenacker2023-02-241-0/+20
| | | | | | | | | | | | - Add COMMERCIAL_[AUDIO|VIDEO]_PLUGINS variables to the variable index. - Clarify that these plugins are still open-source - Improve line width (From yocto-docs rev: 8b161faad6b698b33165f02e1f5e78a693c7817b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: update DEV_PKG_DEPENDENCY in variablesFawzi KHABER2023-02-241-3/+3
| | | | | | | | | | | | | Since release 4.1, the variable DEV_PKG_DEPENDENCY sets RRECOMMENDS instead of RDEPENDS for the -dev package on the main package, this change fixes the documentation to match the actual state Reviewed-by: Yoann CONGAL <yoann.congal@smile.fr> (From yocto-docs rev: 0e0790e7bcf4ee2d31301b4351528eb124a1fe98) Signed-off-by: Fawzi KHABER <fawzi.khaber@smile.fr> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document meson class and variablesMichael Opdenacker2023-02-241-0/+25
| | | | | | | (From yocto-docs rev: aacd49e5c72ac1506fc09790902c6047ccf26a02) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes.rst: improvements to cmake class documentationMichael Opdenacker2023-02-241-0/+10
| | | | | | | | | | | | - Fix quoting for path to cmake modules - Document OECMAKE_GENERATOR variable - Style simplifications (From yocto-docs rev: ecdc1775e27717ec87442575f65b1f24ca2b0348) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: refer to MACHINE variable instead of KMACHINEUlrich Ölmann2023-02-241-1/+1
| | | | | | | | | | | | | Although in the example case of a "raspberrypi2" the variable KMACHINE has the same value as MACHINE, only the latter is an allowed override. So do not set the reader on the wrong track. Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> (From yocto-docs rev: 565ebcfe3ed68a9ea036f11cddafb36023f72099) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev,ref-manual: fix old override syntaxUlrich Ölmann2023-02-241-1/+1
| | | | | | | | | | | | | | Additionally use more common syntax to indicate that an actual machine name is supposed to be filled in for a concrete use case as has been suggested by Peter Kjellerstedt (and particularly no KMACHINE). Furthermore add missing quotes in the reference manual. Suggested-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> (From yocto-docs rev: b66c035970f860b65cf712285f2d5a023620e6c3) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace unnecessary uses of 'yocto_docs' by internal referencesMichael Opdenacker2023-02-101-1/+1
| | | | | | | | | | | | | These :yocto_docs: references were making external references to another section of the manual, using the https://docs.yoctoproject.org website. It's actually better to use internal references (:doc: for an entire document, and :ref: for a specific section, as they will cause an error in Sphinx if one day they are no longer valid. (From yocto-docs rev: 0beff9dea986a2ea4b496180b29a99490416eeeb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: fix broken hyperlinkMichael Opdenacker2023-02-101-1/+1
| | | | | | | (From yocto-docs rev: 048db4183ff314e1c6b51be4dc10f0dbc2aa8401) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>