summaryrefslogtreecommitdiffstats
path: root/documentation/migration-guides
Commit message (Collapse)AuthorAgeFilesLines
* release-notes: use oe_git and yocto_git macrosMichael Opdenacker2022-11-1012-61/+61
| | | | | | | | | | | | | | As in the rest of the manuals; this is more future proof than using hard coded URLs. While doing this, also replacing https://git.yoctoproject.org/git/<repo> links (used by mistake instead of https://git.yoctoproject.org/<repo>) by :yocto_git:`/repo`. (From yocto-docs rev: ac844062400a7bf4732ea6ee639a478b1b77b83e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration guides: add release notes for 4.0.5Lee Chee Yang2022-11-102-0/+197
| | | | | | | | (From yocto-docs rev: f464b17b8c2cd29d6c1a9417c3b9d0956323ab0e) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add shortcut for Wikipedia linksMichael Opdenacker2022-11-073-5/+5
| | | | | | | (From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document "mime-xdg" class and MIME_XDG_PACKAGESMichael Opdenacker2022-11-071-1/+1
| | | | | | | (From yocto-docs rev: dabd2e95cf8ba8ed620bfd135deb6cfcf5d74b16) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: use references to the "Build Directory" termMichael Opdenacker2022-10-285-10/+8
| | | | | | | | | | | | | | Replace instances of "Build Directory" and "build directory" (when applicable) by :term:`Build Directory` as already done in most places. Doing this, fix the indentation of the paragraphs with this term. (From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides/release-notes-4.1.rst: update Repositories / DownloadsLee Chee Yang2022-10-251-2/+0
| | | | | | | | (From yocto-docs rev: 8e0841c3418caa227c66a60327db09dfbe72054a) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides/release-notes-4.1.rst: update Repositories / DownloadsLee Chee Yang2022-10-251-0/+55
| | | | | | | | (From yocto-docs rev: 99dac0ecc497d50be652a47c8a2ce8855975e360) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-4.1.rst remove bitbake-layers subcommand argumentTakayasu Ito2022-10-211-1/+1
| | | | | | | | (From yocto-docs rev: 0f088df1027b38a47f4161fe0910150ff42c1861) Signed-off-by: Takayasu Ito <ito@lineo.co.jp> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: use contributor real nameMichael Opdenacker2022-10-192-2/+2
| | | | | | | (From yocto-docs rev: e0dc444cc1807a36f0e83f025bbf212b741d01f8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix misc typosMichael Opdenacker2022-10-191-1/+1
| | | | | | | (From yocto-docs rev: 988efd0d1663e4369043c5b53d7e1dcd9e54d3cd) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides/release-notes-4.1.rst: add more known issuesRoss Burton2022-10-191-3/+11
| | | | | | | | | | Clarfify the eSDK issue, and document the externalsrc issue. (From yocto-docs rev: 25cbbe19c935293e0549d89b6716a0fae229113c) Signed-off-by: Ross Burton <ross.burton@arm.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add known issues for 4.1Ross Burton2022-10-191-1/+11
| | | | | | | | (From yocto-docs rev: 34ad768a05d6ba87aab64f0aa85e63d4233e0696) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: use contributor real nameMichael Opdenacker2022-10-197-7/+7
| | | | | | | | | From the "Signed-off-by" information from his commits (From yocto-docs rev: 7a2416b8d920f2af6d98df7aeb10d51268a15cd6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add 4.1 migration guide & release notesPaul Eggleton2022-10-194-0/+909
| | | | | | | | | This currently does not include known issues or download information. (From yocto-docs rev: a5c991235e2c063a065d610b3d2a96f5ac534a01) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove reference to testimage-auto classPaul Eggleton2022-10-192-2/+2
| | | | | | | | | testimage-auto was removed in the thud release. (From yocto-docs rev: 618351169c09470280aeee53a63aba88788efc4b) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-general: add section on using buildhistoryPaul Eggleton2022-10-191-0/+33
| | | | | | | | | | Add a short section recommending the use of buildhistory to compare the build output before and after migration. (From yocto-docs rev: e4a83dadbda563e08302055538203c9b1ac9e992) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add reference to the "do_shared_workdir" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | (From yocto-docs rev: a549b39a56c69beecd309ae0621ca673537a467e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_rootfs" taskMichael Opdenacker2022-10-072-5/+5
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 926c836e5184243fb1aee113962e11c01f0297ee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_unpack" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 1ca57f8ec322d5777bf31829e659d62e82986be1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add reference to the "do_populate_sdk" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 6d262b676ed1e8b6b404050dad20e85e7ceb28c2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_patch" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 1e38ceafb25aac13bb9dd45626fd39ad1b68852d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_package_qa" taskMichael Opdenacker2022-10-072-2/+2
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: af27370fd4ffd0e0455187aa9fc5349d39403ae7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_deploy" taskMichael Opdenacker2022-10-071-2/+2
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: b607a0578e8edd3e4ee013b4438481cb82bc106e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add reference to "do_configure" taskMichael Opdenacker2022-10-073-4/+4
| | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 5ddc1a40c9004d814472bdd385f456afa7a9c4e3) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_build" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [YOCTO #14508] (From yocto-docs rev: c8efd2eeb329344c48935f8998e9a689d66348ca) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add reference to the "do_install" taskMichael Opdenacker2022-10-072-3/+3
| | | | | | | | | [YOCTO #14508] (From yocto-docs rev: 933ad27b81dfc4a28e7c48ca7bb2d1363e8c037f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_fetch" taskMichael Opdenacker2022-10-072-3/+3
| | | | | | | | | [YOCTO #14508] (From yocto-docs rev: 17f2041647010d885f18f889c740588586c60d3a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration guides: add release notes for 4.0.4Lee Chee Yang2022-10-072-0/+300
| | | | | | | | (From yocto-docs rev: c55f43b954bb1704d4fce5fd573017091df336f7) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: improve initramfs detailsMichael Opdenacker2022-10-074-9/+9
| | | | | | | | | | | | | | - Create a new entry in the glossary - Add implementation details - Replace the mention of "init ramdisk" by "initramfs¨ whenever possible - Remove obsolete and duplicate information - Fix spacing issues in the Sphinx code (From yocto-docs rev: 952c7e6dee49532705b2c162f4728e635c38df3f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration guides: 3.4: remove spurious space in exampleJohan Korsnes2022-10-071-2/+2
| | | | | | | | | | | | Cc: Richard Purdie <richard.purdie@linuxfoundation.org> Cc: Quentin Schulz <quentin.schulz@theobroma-systems.com> Cc: Ross Burton <ross.burton@arm.com> (From yocto-docs rev: 1942514a3f5c1a9719aa21c143088e00074a6480) Signed-off-by: Johan Korsnes <johan.korsnes@remarkable.no> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration guides: add release notes for 4.0.3Lee Chee Yang2022-08-312-0/+315
| | | | | | | | (From yocto-docs rev: a587eb476219cb1d6a9b104f4d7470c0d2da3c90) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: BB_HASHSERVE_UPSTREAM: update to new hostMichael Opdenacker2022-07-201-1/+1
| | | | | | | (From yocto-docs rev: 5004957d1c65d03d3e296bc9f0a00982457a27f8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration guides: release notes for 4.0.2Lee Chee Yang2022-07-202-0/+297
| | | | | | | | (From yocto-docs rev: 027a58616db9f3e8ee5992b57fd99cb3c284ece9) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: add CONVERSION_CMD definitionAatir Manzur2022-06-303-3/+3
| | | | | | | | (From yocto-docs rev: 05d376ccc65510a7d636e2685fb92a48d4712b0b) Signed-off-by: Aatir Manzur <aatrapps@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace hyphens with em dashesMichael Opdenacker2022-06-277-30/+29
| | | | | | | | | | | | | | | | | | | Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: switch to the sstate mirror shared between all versionsMichael Opdenacker2022-06-271-1/+1
| | | | | | | | | Following https://git.yoctoproject.org/poky/commit/?id=cf7d8894545b83f55420fa33f7848e1bfc6754ff (From yocto-docs rev: 9f7f0e862a39f4c155dc49a816ce7cdbf799373f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add documentation for INCOMPATIBLE_LICENSE_EXCEPTIONSPeter Kjellerstedt2022-06-271-1/+1
| | | | | | | | (From yocto-docs rev: 2a7732bce71b4a493f6bb081b545de6ac586b88a) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: update host tool requirementsMichael Opdenacker2022-06-214-4/+4
| | | | | | | | | | | As enforced by meta/classes/sanity.bbclass: - at least GNU make 4.0 - at least GNU tar 7.5 (instead of 5.0) (From yocto-docs rev: 6480aa0f8338ef192c666b9445bc0baff47d9248) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration guides: release notes for 4.0.1Michael Opdenacker2022-05-282-0/+249
| | | | | | | (From yocto-docs rev: a17bfe2636c11ce8e3266d9add804d795991e2ea) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration guides: release notes for 3.4.3 and 3.4.4Michael Opdenacker2022-05-243-0/+354
| | | | | | | (From yocto-docs rev: dbcc41f2c9fd5b2e52b62a9e12e0129f10565fa9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add quoting to references to bitbake.confMichael Opdenacker2022-05-101-1/+1
| | | | | | | (From yocto-docs rev: 3bf6482e15d1bf00e03c030ac89363e467a8cde1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix name capitalization issuesMichael Opdenacker2022-05-107-9/+9
| | | | | | | | | | | | - 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>
* 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>
* 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>
* 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>