summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2023-01-09[kirkstone] manuals: document SPDX_PRETTY variableyocto-4.0.7kirkstone-4.0.7Michael Opdenacker
Now that it has been backported to Kirkstone https://git.yoctoproject.org/poky/commit/?h=kirkstone&id=99483cff5c358d847ceb077349321eb57d5143e4 Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-06[kirkstone] docs: kernel-dev: faq: update tip on how to not include kernel ↵Quentin Schulz
in image Since commit f6d963fa6d0e ("kernel: make kernel-base recommend kernel-image, not depend"), present in Kirkstone 4.0, one should set RRECOMMENDS and not RDEPENDS to avoid including the kernel in the image, so let's update the documentation to reflect that. Reported-by: Konstantin Kletschke <konstantin.kletschke@inside-m2m.de> Cc: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-06[kirstone] docs: migration-4.0: specify variable name change for kernel ↵Quentin Schulz
inclusion in image recipe Since commit f6d963fa6d0e ("kernel: make kernel-base recommend kernel-image, not depend"), present in Kirkstone 4.0, one should set RRECOMMENDS and not RDEPENDS to avoid including the kernel in the image, so let's update the documentation to reflect that. Reported-by: Konstantin Kletschke <konstantin.kletschke@inside-m2m.de> Cc: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-01-05[kirkstone] manuals: add 4.0.5 and 4.0.6 release notesMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-12-02[kirkstone] SPDX and CVE documentation updatesyocto-4.0.6kirkstone-4.0.6Michael Opdenacker
Backporting from master the ones that are applicable to kirkstone. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
2022-12-01common-tasks.rst: fix oeqa runtime test pathMikko Rapeli
It's "runtime/cases" in master and kirkstone. If layer specific tests are in "runtime" directory, they will not be found. Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-10-06[kirkstone] dev-manual: fix reference to BitBake user manualyocto-4.0.5kirkstone-4.0.5Michael Opdenacker
Fix a wrong reference no longer tolerated by Sphinx 5.x (missing "bitbake:" prefix) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-10-06[kirkstone] migration-guides: add 4.0.4 release notesMichael Opdenacker
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-10-03[kirkstone] poky.yaml.in: update version requirementsMichael Opdenacker
According to meta/classes/sanity.bbclass in Poky Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
2022-09-13system-requirements.rst: Add Ubuntu 22.04 to list of supported distrosyocto-4.0.4kirkstone-4.0.4Steve Sakoman
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2022-08-30[kirkstone]: migration guides: add missing release notesMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-08-29[kirkstone] ref-manual: add numa to machine featuresJon Mason
numa is an existing machine feature, add it to the list so that users are aware of it. Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
2022-07-20[kirkstone] ref-manual: variables: remove sphinx directive from literal blockyocto-4.0.3kirkstone-4.0.3Michael Opdenacker
Literal blocks make sphinx take their text verbatim. This means that directives cannot be used in literal blocks. This means :term:`S` was printed as-is, without actually creating a link to the S variable definition as would be expected outside of literal blocks. Initially contributed to the master branch by Quentin Schulz. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss@0leil.net>
2022-07-20[kirkstone] docs: BB_HASHSERVE_UPSTREAM: update to new hostMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> --- Changes in V2: * Add missing "[kirkstone]" to the commit title
2022-06-27[kirkstone] manuals: switch to the sstate mirror shared between all versionsyocto-4.0.2kirkstone-4.0.2Michael Opdenacker
Following https://git.yoctoproject.org/poky/commit/?id=cf7d8894545b83f55420fa33f7848e1bfc6754ff Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-04-29[kirkstone] migration-guides: release-notes-4.0: mention LTS releaseyocto-4.0.1kirkstone-4.0.1Michael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-04-27[kirkstone] migration-guides: stop including documents with ".. include"Nicolas Dechesne
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> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2022-04-26set_versions: update for 4.0 releaseMichael Halstead
Uncomment langdale lines to bump the version. Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
2022-04-25releases: update for yocto 4.0Michael Halstead
Bump various versions and names. Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
2022-04-24migration-guides: release-notes-4.0: update 'Repositories / Downloads' sectionLee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22docs: migration-guides: release-notes-4.0: replace kernel placeholder with ↵Quentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22docs: migration-guides: release-notes-4.0: fix risc-v typoQuentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22docs: migration-guides: migration-3.4: mention that hardcoded password are ↵Quentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22docs: ref-manual: variables: add hashed password example in EXTRA_USERS_PARAMSQuentin Schulz
Add examples for hashed hardcoded passwords from extrausers.bbclass so that this feature is not hidden away. Cc: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22docs: conf.py: fix cve extlinks caption for sphinx <4.0Quentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22ref-manual: add ZSTD_THREADSPaul Eggleton
ZSTD_THREADS is new for kirkstone. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22ref-manual: Add XZ_THREADS and XZ_MEMLIMITRichard Purdie
XZ_THREADS and XZ_MEMLIMIT were introduced in dunfell. [RP improved an original patch from Paul] Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22migration-guides: add release notes for 4.0Paul Eggleton
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.) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22migration-guides: complete migration guide for 4.0Paul Eggleton
* 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 Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22ref-manual: add empty-dirs QA check and QA_EMPTY_DIRS*Paul Eggleton
This check is new in kirkstone. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22ref-manual: add KERNEL_DEBUG_TIMESTAMPSPaul Eggleton
New variable in kirkstone. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22ref-manual: add mention of vendor filtering to CVE_PRODUCTPaul Eggleton
Mention the vendor filtering functionality - prompted by OE-Core revision 45d1a0bea0c628f84a00d641a4d323491988106f. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22ref-manual: mention wildcarding support in INCOMPATIBLE_LICENSEPaul Eggleton
Add this since the INCOMPATIBLE_LICENSE wildcard support has changed in the 4.0 release. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22ref-manual: add a note about hard-coded passwordsPaul Eggleton
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. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-22migration-3.4: add missing entry on EXTRA_USERS_PARAMSPaul Eggleton
We missed noting this in 3.4 but I noticed the documentation was recently updated, so note the removal. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-20docs: sphinx-static: switchers.js.in: do not mark branches as outdatedQuentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-20docs: sphinx-static: switchers.js.in: fix broken switcher for branchesQuentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-20docs: sphinx-static: switchers.js.in: rename all_versions to switcher_versionsQuentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-20docs: set_versions.py: mark as obsolete only branches and old tags from ↵Quentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-20docs: update Bitbake objects.inv location for master branchQuentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19docs: set_versions.py: fix latest version of an active release shown as obsoleteQuentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-19docs: set_versions.py: fix latest release of a branch being shown twice in ↵Quentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-15docs: sphinx-static: switchers.js.in: improve obsolete version detectionQuentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
2022-04-15docs: set_versions.py: add information about obsolescence of a releaseQuentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
2022-04-15docs: sphinx-static: switchers.js.in: remove duplicate for outdated versionsQuentin Schulz
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> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
2022-04-14dev-manual: add command used to add the signed-off-by line.Abongwa Amahnui Bonalais
Signed-off-by: Abongwa Bonalais Amahnui <abongwabonalais@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-04-14documentation/brief-yoctoprojectqs: add directory for local.confAbongwa Amahnui Bonalais
Replacing local.conf by conf/local.conf Signed-off-by: Abongwa Bonalais Amahnui <abongwabonalais@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-04-13migration-guide: Kirkstone is now 4.0yocto-4.0kirkstone-4.0Richard Purdie
Update the docs to reflect that kirkstone is 4.0, not 3.5. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-31migration-guides: preliminary description for 3.5Michael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2022-03-31manuals: fix quoting of double dashesMichael Opdenacker
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. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>