summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/migration.xml
AgeCommit message (Collapse)Author
2021-01-04sphinx: remove DocBook filesNicolas Dechesne
The Yocto Project documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (From yocto-docs rev: abdb6b6bdfef3dc8e8cc13779e44a8d6df903469) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (cherry picked from commit 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04sphinx: import docsNicolas Dechesne
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>
2020-06-02ref-manual: Remove long-dead PACKAGE_GROUP variableRobert P. J. Day
This was, years ago, deprecated in favour of FEATURE_PACKAGES, so remove all references, other than the entry in the migration section. (From yocto-docs rev: 2deac02f283547f66d1f7a002f5bf07ddd449401) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-15ref-manual: add migration section for 3.1Paul Eggleton
Migration information for the 3.1 release. (From yocto-docs rev: dda13761733c7f3fe672f45b8d06f6c3fcf8cb30) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06ref-manual: add install-buildtools and -extendedTim Orling
Add instructions to use 'install-buildtools' and 'buildtools-extended-tarball'. Add gcc 5.0 requirement and call out how to use above to prepare host development system. (From yocto-docs rev: c6dbd9bf6860ffea1bc025907343373439d91737) Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06correct mention of "postinst_intercept delay_to_first_boot"rpjday@crashcourse.ca
Migration to YP 2.5 contains incorrect description of routine for delaying to first boot. (From yocto-docs rev: 08f71ec137822c0c19b56956d7045dfb73a544d7) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11ref-manual: Add missing/remove extraneous quotesPeter Kjellerstedt
(From yocto-docs rev: 542e362bf06c2d71ee6e30f5728ad5476f035c6e) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-11-10ref-manual: Removed blank lines from 3.0 migratrion section.Scott Rifenbark
(From yocto-docs rev: a3c4701e0b6fc90aaa7138c1fd772e0d8ad7e3a6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-11-10ref-manual: Completed the 3.0 migration section.Scott Rifenbark
(From yocto-docs rev: 1f996ce595b91e2dba55bdeeb2a558eb8a16c195) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual: Removed deprecated link to ref-classes-bluetoothScott Rifenbark
This was in a moving to YP version 1.8 migration section. (From yocto-docs rev: b87f0882c39524747004fafc4d1caf58b3344c3a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual: 2nd pass 3.0 migrationScott Rifenbark
Turned "2.8" into "3.0". Nobody told me about skipping 2.8 and 2.9. (From yocto-docs rev: 13819f0651c48adae9d1a8d6d19341ba5ee44978) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual: First pass of 2.8 migration changes (WIP)Scott Rifenbark
(From yocto-docs rev: 2c0f6cd921132caa4f49c34ac592db68be27761a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07dev-manual, ref-manual: removed "distrodata" classScott Rifenbark
Ousted these since it was noted in the migration section that the class had been removed. Modified all references to the removed class as needed. (From yocto-docs rev: 7000acc76da6b7ee850b799347ab9083663c7e6a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07documentation: Cleaned up "plug-in"/"plugin" terminology.Scott Rifenbark
The YP manual set was using the plugin term inconsistently. It was appearing as "plugin" as well as "plug-in". The plugins in the project are all named without a hyphen. The term itself is either/or according to Google. I have changed all references to plugin so that they do not use a hyphen. (From yocto-docs rev: 715bb58e2347c5e37a49da7d9e3e230503672337) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07ref-manual: Review comments applied to 2.7 migration section.Scott Rifenbark
(From yocto-docs rev: 81ced4c68631d4d63efec206e5453b00d8fcc786) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07ref-manual: Added "License Value Corrections to migration.Scott Rifenbark
(From yocto-docs rev: 398a60005b9ce63e6ee141dfb8a71e8ae2bf2d86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07ref-manual: Added Eclipse removal for migration section.Scott Rifenbark
(From yocto-docs rev: 06409e5fa0080f76f68d9f98b3c9f5a4edfcc948) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07ref-manual: Inserted Migration 2.7 section.Scott Rifenbark
(From yocto-docs rev: 238ddd62995420741c2b97ccfa7d2c533b72837c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15ref-manual: Updates to CMake and cmake.bbclass.Scott Rifenbark
I cleaned up the terminology used for the CMake build system. I provided some meaningful links to a good overview page for CMake. I also built in some cross-referencing as needed. (From yocto-docs rev: 7c38add39b97a7a8786a1be53f9ff549e4727fad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: Added cross-references to "Post-Installation Scripts"Scott Rifenbark
Two areas in the migration chapter discuss the post-installation behavior when you defer the scripts to after boot. I added a couple references to each of those migration note sections that go into the dev-manual's section. (From yocto-docs rev: eeb09b5fa208499f37be4e5aafcf55db82715fd1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: Updated "Packaging Changes" section for 2.6 migration.Scott Rifenbark
Changed reference to "python-modules" to "python-modules / python3-modules". (From yocto-docs rev: 49d66f928366dda19b6afd1e9ac6431f0f66ab21) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: Applied review edits to the 2.6 migration section.Scott Rifenbark
Minor fixes here and there. (From yocto-docs rev: 740b4392bd98a12f188b79ae3ecdc7c3031f9f7d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: New 2.6 Migration section complete.Scott Rifenbark
(From yocto-docs rev: 6597ea2d706e3975ff0ffae15cf748ffd7aaed8b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: Added new python3 profile-optimization migration topicScott Rifenbark
(From yocto-docs rev: 2d0960d9282ffcb843ed9956a0e49183b22f11f2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: Updated postinstall migration note.Scott Rifenbark
(From yocto-docs rev: fa6582df36d770e7207e4c5201dafe0e64f46a76) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: Updates to the 2.6 migration section.Scott Rifenbark
This is the completed first draft. (From yocto-docs rev: 45d39b7655ea5b515c8dda91249a84ee19387099) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: Added several new sections to the 2.6 migration section.Scott Rifenbark
(From yocto-docs rev: 54703fbde3f7808b9257da883fe8e4769a65fc44) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: Updated migration section for 2.6Scott Rifenbark
Made two minor corrections from reviewer feedback. (From yocto-docs rev: 765e44127f52e1d9d4d1c365b0574ca73364add2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: Updated 2.6 migration topic "_remove"Scott Rifenbark
Provided more explanation and also a link into the BB manual for a detailed example. (From yocto-docs rev: ca1e113dc837f5104f765b655880a87d1fbd66ac) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22ref-manual: Added the 2.6 Migration Section.Scott Rifenbark
Provided some new sections on the information for migrating from the 2.5 release to the 2.6 release. (From yocto-docs rev: dd721a31594c753d7229c45ebad0ce11640a0704) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Finalized edits on the 2.5 Migration sectionKristi Rifenbark
(From yocto-docs rev: 54259a4d4d69be73e7c614baa2a8d87faa2e3ea5) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Formatting pass of 2.5 Migration sectionKristi Rifenbark
(From yocto-docs rev: 50308cc7f04d3fc54c06766f85e15e76a99f0b4b) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Added 2.5 Migration SectionKristi Rifenbark
(From yocto-docs rev: 5d6c1b69e5559eced5142f46421302f61c95404c) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Added "section" as part of a reference to the bitbake-user-manual.Scott Rifenbark
Missing this conventional part of the reference contextual diatribe. (From yocto-docs rev: 5468ebf21bc9166de35e9b7016eef06ed586e5c3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Removed several redundant links to variables.Scott Rifenbark
Trying to get back to a standard of using an actual link for only the first occurrence of a variable in any given section. (From yocto-docs rev: 68d80a5dd8481f938892473c4671a9c436e80c8f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Removed redundant links to the DISTRO_FEATURES variable.Scott Rifenbark
(From yocto-docs rev: d834e5f5cef520b80e5049b28945cfa1ead3b092) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Fixed bad title for the bitbake-user-manualScott Rifenbark
In the migration section, an older name for the bitbake-user-manual was being used in the text for a cross-reference. I replaced it with the current and correct name. (From yocto-docs rev: 3f466b59a3138984cceae12ac58c84ec3cda4432) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Fixed bad link to naked sdk-manualScott Rifenbark
In the migration section, an older flavor of the title to the sdk-manual was being used. This of course was not processed correctly by the mega-manual.sed script. I fixed the title so it is now processed correctly. (From yocto-docs rev: 1f9fa699bb14f96a7c9ccab314a7d72e6a93dda6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Fixed bad title string for "Toaster User Manual"Scott Rifenbark
(From yocto-docs rev: 14efbdbbcffea3a301dd220b3336fd11e1878ff8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Removed redundant paragraph for links to variables.Scott Rifenbark
(From yocto-docs rev: 32228c3e138d6bd0076b164980e90fdc25c62768) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Fixed mis-matched title in link to ptest.Scott Rifenbark
(From yocto-docs rev: d203312ede89d5c7467f8ac8117522c4fc1fd7b5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Removed redundant link to the BAD_RECOMMENDATIONS variable.Scott Rifenbark
(From yocto-docs rev: 27ce95176fcceb95065eee19fecc2a71d88a0984) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24ref-manual: Removed redundant link to IMAGE_FEATURES variable.Scott Rifenbark
(From yocto-docs rev: 0ca8dc6aa8e06405e9483398788f4e221408fed7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24documentation: Updated everything for new overview-manualScott Rifenbark
This involved changing the root manual folder from "getting-started" to "overview-manual". Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was changed to "YOCTO_DOCS_OM_URL". Most manuals had several occurrences of these links. The makefile needed updating to process the new manual and not process the old "getting-started" manual. (From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24mega-manual: Fixed various links to the dev-manualScott Rifenbark
Found a few links that were not using the correct wording when referencing a section to the dev-manual. Also, fixed one link that was assuming a section outside the dev-manual when the link was to a section inside the dev-manual. (From yocto-docs rev: 7a577b135e1a01d6a9924ba89733e46d029c6cca) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14documentation: Created new "Getting Started" manual.Scott Rifenbark
Creation involved removing the overview-manual and replacing it with the getting-started manual. All links to the string "&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with "&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed files used to create the manual with prefixes suited for the new manual name, which is "Getting Started With Yocto Project". The style sheet for the new manual needed updating to display the new .PNG image for the title page. The mega-manual file had to be updated to include the files. The mega-manual.sed file had to be updated to include the new manual and not use the overview manual. (From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14dev-manual, ref-manual: Moved build history info to dev-manualScott Rifenbark
Fixes [YOCTO #12370] The section in the ref-manual on build history has been moved to the dev-manual. It is more of a "how-to" piece of information than a reference. (From yocto-docs rev: 9634bd8dc51e2972e6a5f3a3d3b4256c8ca8749c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14documentation: Created new YP Overview ManualScott Rifenbark
Fixes [YOCTO #12370] Added a new chapter to the newly created Yocto Project Overview Manual. This chapter originated from the YP Reference Manual and was the old chapter 3, which talked a lot about various concepts. This information is better suited for the new overview manual. The change involved moving the entire chapter and renaming it. This move of the content affected many, many external references and links into the old area. Consequently, I had to recast all these links from the different manual. Changes also included fixing the mega-manual.xml file so that it would include the new overview manual as part of it. Many figures had to be relocated as part of the move as well. This meant deleting them from the ref-manual/figures folder and putting them into the overview-manual/figures folder. (From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09ref-manual: Added the GCCPIE Variable to GlossaryKristi Rifenbark
(From yocto-docs rev: b30f3d3bd6f6d333b00fc9c3797126a898fb0685) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09ref-manual: Added kernel-devicetree to the Classes sectionKristi Rifenbark
(From yocto-docs rev: 1ea1f0dc6451030738c506c4d6228b31f67f3f36) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-05-12 18:44:37 +0000