summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* manuals: fix name capitalization issuesMichael Opdenacker2022-05-1020-36/+36
| | | | | | | | | | | | - Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the title of the "BitBake User Manual". - Using "OpenEmbedded" instead of "Openembedded" - Using "Python" instead of "python" (From yocto-docs rev: 0b893e2a15aefedd7100445fc9d7eeed07b6afc6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc/Makefile: fix epub and latexpdf targetsMichael Opdenacker2022-05-101-0/+2
| | | | | | | | | Fixing "make clean" followed by "make epub" or "make latexpdf" (From yocto-docs rev: 0dac10fc3d170fb162f4df6547541071bfa7a94e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: further gdb usage simplificationsMichael Opdenacker2022-05-101-12/+8
| | | | | | | (From yocto-docs rev: 701d9af89c0de25b84f110ed9f4b627ea339195b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: set_versions.py: show release name in switchers.jsQuentin Schulz2022-05-101-3/+3
| | | | | | | | | | | | | | | | | | Also show release names in the dropdown menu so that people have knowledge of both the version number and release name of whatever they're using or planning to use or upgrade to. This patch will make the dropdown menu show the following entries: Unstable (dev) Kirkstone (4.0) Honister (3.4.3) Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 83867cd979810a023eb7e2d243782e6202873273) 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>
* dev-manual: improvements for gdbserver configurationSundeep KOKKONDA2022-05-101-6/+5
| | | | | | | | | | | | [Yocto #13722] The Yocto bug reports a few improvements in the gdbserver configuration which makes the configuration of gdb easier for novice users. (From yocto-docs rev: 48c96378fd5edd587025f3ca138bc5114e927f2f) Signed-off-by: Sundeep KOKKONDA <sundeep.kokkonda@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: fix a forgotten linkArkadiusz Drabczyk2022-05-101-2/+2
| | | | | | | | (From yocto-docs rev: c164ebbb057470130170fd6fedaf8f474abde39d) Signed-off-by: Arkadiusz Drabczyk <arkadiusz@drabczyk.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: set_versions.py: remove hardknott from active releases listQuentin Schulz2022-05-101-1/+1
| | | | | | | | | | | | | | Hardknott 3.3.6 is the last release of the series and the release is now obsolete. Let's remove hardknott from the list of active releases. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 4ecce89b6a5d5feb0d31c735a39619e73eeb5e44) 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>
* releases: update to include 3.1.16Michael Halstead2022-05-051-0/+1
| | | | | | | (From yocto-docs rev: e33a626774034a833a92108c2adf6799098685c0) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.3.6Michael Halstead2022-04-271-0/+1
| | | | | | | | | Adding 3.3.6 to release list. (From yocto-docs rev: 1f845c499bbf78809cb4155c3e72db53b7ed2021) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: release-notes-4.0: mention LTS releaseMichael Opdenacker2022-04-271-0/+2
| | | | | | | (From yocto-docs rev: ff1fe93313410242eaecf97b84d1214f68fb79fd) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: stop including documents with ".. include"Nicolas Dechesne2022-04-275-10/+19
| | | | | | | | | | | This prevented variables from being substituted through the code in yocto-vars.py, at least in the files included this way. Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> (From yocto-docs rev: b7375ea4380e716a02c736e4231aaf7c1d868c6b) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: refer to "YP Compatible" layers instead of "curated" onesMichael Opdenacker2022-04-273-5/+5
| | | | | | | (From yocto-docs rev: dce5dd78d3bc7510e06cf5748033ee9c2888a405) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: correct and improve descriptions of AutotoolsMichael Opdenacker2022-04-272-5/+6
| | | | | | | (From yocto-docs rev: c7cb693673566ec12b95c568945b514ed0e18522) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: licensing section fixesMichael Opdenacker2022-04-271-6/+2
| | | | | | | | | | | | | | | | | | Remove the reference to the GPL license, unnecessary in this part of the manual and pointing to a wrong link (LGPL instead of GPL). Anyway, we have no authority to say that the MIT license is compatible with the GPL. Also provide details about the MIT license through Wikipedia, instead of just the raw license text with no explanations through opensource.org. (From yocto-docs rev: a09fcd9d850d2b52f40d953b11412c9568a77db7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* set_versions: Add a getlatest command to obtain the latest release branch nameRichard Purdie2022-04-261-0/+5
| | | | | | | | | This will allow the autobuilder-helper run-docs-build script to obtain the latest release name. (From yocto-docs rev: 733b7f301e44010579e1315f19eff737628d635e) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* set_versions: update for 4.0 releaseMichael Halstead2022-04-261-5/+4
| | | | | | | | | Uncomment langdale lines to bump the version. (From yocto-docs rev: e0016979413ab27f2e5db88ae1de180507c759c2) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update for yocto 4.0Michael Halstead2022-04-262-6/+12
| | | | | | | | | Bump various versions and names. (From yocto-docs rev: 7c617e7e956696842c03a7b18baff931b72d70db) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: release-notes-4.0: update 'Repositories / Downloads' sectionLee Chee Yang2022-04-251-1/+68
| | | | | | | (From yocto-docs rev: e814a998cc0a7c451a77df0304d0a69a27ac08ae) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: migration-guides: release-notes-4.0: replace kernel placeholder with ↵Quentin Schulz2022-04-251-1/+1
| | | | | | | | | | | | | | | | | correct recipe name If I am not mistaken, the only kernel recipe to have a new PACKAGECONFIG option is linux-yocto-dev, in commit 1bac831fbaafb "linux-yocto-dev: introduce dt-validation PACKAGECONFIG". Therefore, let's replace (kernel) by the one kernel recipe that has this change. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 1882954924cef9f17caad0f83973afe08f4db764) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: migration-guides: release-notes-4.0: fix risc-v typoQuentin Schulz2022-04-251-1/+1
| | | | | | | | | | | It's RISC-V and not RiscV, c.f. https://riscv.org/ (yes, no dash in the domain name...). Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 1a5fd51a50fe39d8095bb5a4f34d6b953e59c58f) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: migration-guides: migration-3.4: mention that hardcoded password are ↵Quentin Schulz2022-04-251-0/+2
| | | | | | | | | | | | | | supported if hashed Plaintext/clear passwords are not supported anymore but hashed passwords still are. Mention that in the migration guide and point to the appropriate location of documentation. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: f8b9697ec7bcc188db5ce9e5067bc82c023b79d9) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: variables: add hashed password example in EXTRA_USERS_PARAMSQuentin Schulz2022-04-251-0/+31
| | | | | | | | | | | Add examples for hashed hardcoded passwords from extrausers.bbclass so that this feature is not hidden away. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 5db73c7c5668144ed4629f95378e44f0bd8c8256) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: conf.py: fix cve extlinks caption for sphinx <4.0Quentin Schulz2022-04-251-1/+1
| | | | | | | | | | | | | | | | | | | extlinks captions support using %s substitution but only from sphinx 4.0 onwards. c.f. https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html#confval-extlinks Weirdly enough, on older sphinx versions, the caption is just a prefix to the actual text passed to the extlink. Therefore, in that specific case, CVE- or CVE-%s are identical in meaning for sphinx >=4.0 and since only CVE- caption works on sphinx <4.0, let's go with CVE- caption prefix. Fixes: b311070d866cf "manuals: add 3.4 and 3.4.1 release notes after migration information" Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: c9922076f5c1285d9cfd6aff8ce5b6635d88222f) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add ZSTD_THREADSPaul Eggleton2022-04-251-0/+13
| | | | | | | | | ZSTD_THREADS is new for kirkstone. (From yocto-docs rev: b970936b89bebb184c82be3a9514a9eba7c04f9b) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add XZ_THREADS and XZ_MEMLIMITRichard Purdie2022-04-251-1/+20
| | | | | | | | | | XZ_THREADS and XZ_MEMLIMIT were introduced in dunfell. [RP improved an original patch from Paul] (From yocto-docs rev: 96defb66b775093b5270bd1ebad0461c2bba1e5b) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 4.0Paul Eggleton2022-04-252-0/+867
| | | | | | | | | | | | | Generated from commits in the kirkstone branch, as well as a few entries from the migration guide. (Note that the "Repositories / Downloads" section still needs to be filled in.) (From yocto-docs rev: 0c66638e61d3e16ac8d4b7ebc4ec6fb35625bf4f) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: complete migration guide for 4.0Paul Eggleton2022-04-251-125/+221
| | | | | | | | | | | | | * Make some corrections to preliminary set of entries * Move out entries that were more appropriate for the release notes (i.e. that are more additions rather than changes that require the user to make changes) * Add new entries based on commits in the kirkstone branch (From yocto-docs rev: bea2da80e7c5338dc5abefe95ce27b80ed4ee98a) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add empty-dirs QA check and QA_EMPTY_DIRS*Paul Eggleton2022-04-253-1/+37
| | | | | | | | | This check is new in kirkstone. (From yocto-docs rev: baa483e75538013be3261f8c115b8a5364b24c60) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add KERNEL_DEBUG_TIMESTAMPSPaul Eggleton2022-04-251-0/+5
| | | | | | | | | New variable in kirkstone. (From yocto-docs rev: 2c5d4938a09fd35f9e86f682cde89d4693762725) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add mention of vendor filtering to CVE_PRODUCTPaul Eggleton2022-04-251-0/+7
| | | | | | | | | | Mention the vendor filtering functionality - prompted by OE-Core revision 45d1a0bea0c628f84a00d641a4d323491988106f. (From yocto-docs rev: 13ff5a49f14a26772b4775d9ecd08627e6becd4d) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: mention wildcarding support in INCOMPATIBLE_LICENSEPaul Eggleton2022-04-251-0/+8
| | | | | | | | | | Add this since the INCOMPATIBLE_LICENSE wildcard support has changed in the 4.0 release. (From yocto-docs rev: c7946863e5a9d62a49131b92cc9549da9b799bbd) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add a note about hard-coded passwordsPaul Eggleton2022-04-251-0/+8
| | | | | | | | | | | | It seems prudent to point out that hard-coding passwords in the manner detailed in the example is not a good idea in production. This type of mistake has unfortunately been made by many device vendors (outside of the Yocto Project context) leading to security vulnerabilities. (From yocto-docs rev: 1d07dba9423ae0a841eccb58c297e31b63c3965d) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-3.4: add missing entry on EXTRA_USERS_PARAMSPaul Eggleton2022-04-251-0/+7
| | | | | | | | | | We missed noting this in 3.4 but I noticed the documentation was recently updated, so note the removal. (From yocto-docs rev: f661e62d6faf48dbb6c6fd9a61a6448ec339d2bf) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: sphinx-static: switchers.js.in: do not mark branches as outdatedQuentin Schulz2022-04-201-1/+1
| | | | | | | | | | | Branches can never be outdated so let's check the release is not a branch (branches end with .999). Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 4755961bbb5f674a7532b91cca20ea44a1e22ae7) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: sphinx-static: switchers.js.in: fix broken switcher for branchesQuentin Schulz2022-04-202-0/+15
| | | | | | | | | | | | | | | | | | The switcher expects URL subpath to match the "release" used by sphinx to build the documentation. Branches, however, are put in a subpath after their name (e.g. dunfell) while sphinx sets the "release" to X.Y.999. This means the switcher cannot replace correctly the path to switch between releases/versions. Let set_versions.py inject the list of release names into the switchers.js.in file so it can check whether the subpath is one of the release names in which case it needs to be stripped. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 5ef3d129b8d0d8ae98a694103930988a46285525) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: sphinx-static: switchers.js.in: rename all_versions to switcher_versionsQuentin Schulz2022-04-201-3/+3
| | | | | | | | | | | | | | This array only contains versions that can be selected through the dropdown menu for switching between supported versions. Therefore, let's rename it to switcher_versions to make its usecase clearer. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 5c3d67751bf3f572a0788d3a4734b80e3453d084) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: set_versions.py: mark as obsolete only branches and old tags from ↵Quentin Schulz2022-04-201-1/+1
| | | | | | | | | | | | | | | | | | | | obsolete releases Branches are identified by their .999 version suffix which means they will never be matched in the forloop above this git context. Therefore, branches will match the condition. However, branches are not necessarily obsolete (e.g. dunfell, honister and kirkstone today), so let's mark as obsolete the branches which are from obsolete releases. Old tags of currently supported releases are not defined as obsolete but outdated, therefore using the series to which they belong like it is done for branches is enough for obsolescence detection. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 7181a432da18b47608784363d243ea39b80be1ed) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: update Bitbake objects.inv location for master branchQuentin Schulz2022-04-202-5/+3
| | | | | | | | | | | | master branch of Bitbake is now located at docs.yoctoproject.org/dev instead of docs.yoctoproject.org so let's update the switchers and set_versions.py to reflect that change. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 18338292d99ed236e2bac6e73a5152ef11c4a9e5) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: set_versions.py: fix latest version of an active release shown as obsoleteQuentin Schulz2022-04-191-5/+2
| | | | | | | | | | | | | | | ourseries can be an active release and therefore shouldn't be marked as obsolete. By adding ourseries to activereleases, it is impossible to know if ourseries is actually an active release or not. Instead let's loop on the active releases with ourseries too (only if it's not active release, otherwise it'd appear twice). Fixes: 6f40ef56054ec "docs: set_versions.py: add information about obsolescence of a release" Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: f16b633211b97b2cdf2c65d83c99cd3853d2bb5c) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: set_versions.py: fix latest release of a branch being shown twice in ↵Quentin Schulz2022-04-191-5/+5
| | | | | | | | | | | | | | | | | | | | switchers.js versions array is supposed to store the latest version of all active releases. However, in the loop it is reassigned and therefore, the check on whether our version is already in the versions array will always return false (except for the latest version of the last active release) and write our version again in the list. By using a local variable for the logic instead of versions array, the check now works properly. Fixes: f2b069be8c307 "set_versions: Various improvements" Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 36a088c8c99dd37f5ca07ec8f90f2c51ef8b36f2) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: sphinx-static: switchers.js.in: improve obsolete version detectionQuentin Schulz2022-04-191-7/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | Based on additional information per release, specifically with the obsolescence status of a release, the obsolescence detection can now be much smarter than just checking if the release is older than dunfell. This is required because with LTS (dunfell for example) releases, it is now possible to have LTS releases that are older than obsolete releases. This means obsolete releases need to be tracked and only the release version cannot be used as an indicator of obsolescence. Let's use the obsolete field of the per-release data in the all_versions dictionary to display correct warning messages. The warning message is first about outdated version if there's a newer one available (*even* if it is for an obsolete release, e.g. 3.0.1 will say it's outdated and should select 3.0.4 version instead), then if the version is the last of the release, show a warning message if the release is obsolete. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 6986baa0d3b544bbad8a7e23ee447abc6f2769f6) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: set_versions.py: add information about obsolescence of a releaseQuentin Schulz2022-04-192-9/+9
| | | | | | | | | | | | This adds support for marking releases as obsolete to make the detection algorithm smarter (in a later commit) than just checking if it's older than dunfell. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 6f40ef56054ecbd3d8b7310d748c1af78a689add) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: sphinx-static: switchers.js.in: remove duplicate for outdated versionsQuentin Schulz2022-04-191-3/+0
| | | | | | | | | | | | | | | | | | | | | | Since commit f2b069be8c307 "set_versions: Various improvements", an outdated version will always appear in all_versions, meaning there'll always be an exact match in the loop (just above the git context of this patch) so there's no need to add the current_version to the dropdown menu manually. This issue showed up only for outdated versions of obsolete releases, e.g. 3.2.3. In that case, 3.2.4 (latest version of the obsolete release) will appear in the all_versions array in addition to 3.2.3, which means the check on release series (3.2) will be matched twice, and 3.2.3 will be printed once in the 3.2.4 loop because version != current_version and once in the 3.2.3 because it is an exact match to an entry in all_versions. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 05065fa1f3855e8b7d9e8af0502b4ae402273400) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: add command used to add the signed-off-by line.Abongwa Amahnui Bonalais2022-04-191-1/+2
| | | | | | | | (From yocto-docs rev: 0520831118ab0f3287d1a6cde4fa26062e55ee74) Signed-off-by: Abongwa Bonalais Amahnui <abongwabonalais@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/brief-yoctoprojectqs: add directory for local.confAbongwa Amahnui Bonalais2022-04-191-1/+1
| | | | | | | | | | Replacing local.conf by conf/local.conf (From yocto-docs rev: 0f8c773d4ef79f7a8281c5743337c0504d7a786e) Signed-off-by: Abongwa Bonalais Amahnui <abongwabonalais@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guide: Kirkstone is now 4.0Richard Purdie2022-04-132-3/+3
| | | | | | | | Update the docs to reflect that kirkstone is 4.0, not 3.5. (From yocto-docs rev: a6f571ad5b087385cad8765ed455c4b4eaeebca6) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: preliminary description for 3.5Michael Opdenacker2022-03-311-1/+53
| | | | | | | (From yocto-docs rev: 2c24dd801b8d9fa4b81726dcde34a69fde309e4a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix quoting of double dashesMichael Opdenacker2022-03-317-13/+13
| | | | | | | | | | | | | | | | | | | Otherwise rendered as "en" dashes by sphinx, for example: git pull –rebase instead of git pull --rebase Readers could confuse them with normal dashes. Exception: replace by \-\- in italic text (*text*) as Sphinx cannot nest italic and quoted text. For consistency, also update quoting in strings in the same code hunks. (From yocto-docs rev: 4e7ce372e37f76148f623a5295a15e08bc2603ff) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: add poky.yaml and sphinx-static/switchers.js to "make clean"Michael Opdenacker2022-03-311-1/+1
| | | | | | | (From yocto-docs rev: 36d1be3db5f0c9c72aafdb414916ce5abc483f43) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: add missing upper caseMichael Opdenacker2022-03-311-1/+1
| | | | | | | (From yocto-docs rev: 9de52ac713c89e3e7023148889c234d4ec4c6246) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>