Commit Graph

100 Commits

Author SHA1 Message Date
Michael Opdenacker
6846d4d00b manuals: define proper numbered lists
Using "#." instead of "1.", "2.", "3.", etc.

(From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
01e5d22507 manuals: fix double colons
Fixing double colons appearing alone on a line, while
they could be put at the end of the previous line.

Sometimes placing a note after the quoted text
to avoid such a situation. It's more natural too
not to have a note between the introduction text
and the quoted section.

(From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
8b812b29c4 manuals: add missing SPDX license header to source files
(From yocto-docs rev: 86737cc4583f1ef43bda10033c801329ba0c8b81)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
f417d3274c manuals: add missing references to variables
[YOCTO #14508]
(From yocto-docs rev: 7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
945c669138 manuals: split dev-manual/common-tasks.rst
A 500 KB source file is always harder to manage,
and can have section title conflicts.

So, the "Common Tasks" document is gone and all
its constituents are moved up one level.
You now have 40 chapters in the Development Tasks Manual.

(From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Chee Yang Lee
6fe3143800 migration-guides: add release-notes for 4.1.1
(From yocto-docs rev: 15140d5f53035bc6276fb890d89e8c2513e832da)

Signed-off-by: Chee Yang Lee <chee.yang.lee@intel.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
4d01625794 manuals: fix paragraphs with the "inherit" word
Nothing wrong with this word, but instances of "inherit"
were looked for while looking for class names without references.
Fixing alignment and sometimes syntax.

(From yocto-docs rev: c418c645a360e74ebb91765a3041336f03097e0d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
55621c31f1 manuals: add missing references to classes
Sometimes fixing line length in modified paragraphs too.

[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
40df2b19bd release-notes: use oe_git and yocto_git macros
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>
2022-11-10 22:12:56 +00:00
Lee Chee Yang
a31e8e22a3 migration guides: add release notes for 4.0.5
(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>
2022-11-10 22:12:55 +00:00
Michael Opdenacker
3a7dd1d368 manuals: add shortcut for Wikipedia links
(From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Michael Opdenacker
1d2681fa72 manuals: document "mime-xdg" class and MIME_XDG_PACKAGES
(From yocto-docs rev: dabd2e95cf8ba8ed620bfd135deb6cfcf5d74b16)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Michael Opdenacker
b44fbe5b1b manuals: use references to the "Build Directory" term
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>
2022-10-28 15:48:03 +01:00
Lee Chee Yang
5724847549 migration-guides/release-notes-4.1.rst: update Repositories / Downloads
(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>
2022-10-25 13:55:27 +01:00
Lee Chee Yang
56e3989b89 migration-guides/release-notes-4.1.rst: update Repositories / Downloads
(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>
2022-10-25 13:41:36 +01:00
Takayasu Ito
95c802b0be release-notes-4.1.rst remove bitbake-layers subcommand argument
(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>
2022-10-21 12:23:50 +01:00
Michael Opdenacker
f4fe7cdaa7 migration-guides: use contributor real name
(From yocto-docs rev: e0dc444cc1807a36f0e83f025bbf212b741d01f8)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Michael Opdenacker
d09132d130 manuals: fix misc typos
(From yocto-docs rev: 988efd0d1663e4369043c5b53d7e1dcd9e54d3cd)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:57 +01:00
Ross Burton
43cc9a16c1 migration-guides/release-notes-4.1.rst: add more known issues
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>
2022-10-19 17:32:57 +01:00
Ross Burton
2f9472efbc migration-guides: add known issues for 4.1
(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>
2022-10-19 17:32:57 +01:00
Michael Opdenacker
736135a53d migration-guides: use contributor real name
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
a0fbaf259c Add 4.1 migration guide & release notes
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
c29eb10e31 ref-manual: remove reference to testimage-auto class
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
83495559d9 migration-general: add section on using buildhistory
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>
2022-10-19 17:32:56 +01:00
Michael Opdenacker
623720dcf4 migration-guides: add reference to the "do_shared_workdir" task
(From yocto-docs rev: a549b39a56c69beecd309ae0621ca673537a467e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
40b7725212 manuals: add references to the "do_rootfs" task
[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>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
c9c7ace795 manuals: add references to the "do_unpack" task
[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>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
97495b4c89 manuals: add reference to the "do_populate_sdk" task
[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>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
a6a7676910 manuals: add references to the "do_patch" task
[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>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
67a72fc3f7 manuals: add references to the "do_package_qa" task
[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>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
0e8d0ecc6c manuals: add references to the "do_deploy" task
[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>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
5d1e8104cd manuals: add reference to "do_configure" task
[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>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
edaa121c7b manuals: add references to the "do_build" task
[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>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
9fece9c361 manuals: add reference to the "do_install" task
[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>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
84251f8d24 manuals: add references to the "do_fetch" task
[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>
2022-10-07 10:54:25 +01:00
Lee Chee Yang
104f20717c migration guides: add release notes for 4.0.4
(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>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
9dbd27a48a manuals: improve initramfs details
- 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>
2022-10-07 10:54:25 +01:00
Johan Korsnes
c3c7344826 migration guides: 3.4: remove spurious space in example
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>
2022-10-07 10:54:25 +01:00
Lee Chee Yang
f6bd4af0d9 migration guides: add release notes for 4.0.3
(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>
2022-08-31 12:17:45 +01:00
Michael Opdenacker
1127e9a7b8 docs: BB_HASHSERVE_UPSTREAM: update to new host
(From yocto-docs rev: 5004957d1c65d03d3e296bc9f0a00982457a27f8)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-07-20 14:25:01 +01:00
Lee Chee Yang
8db83d989d migration guides: release notes for 4.0.2
(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>
2022-07-20 14:25:01 +01:00
Aatir Manzur
9900bb5d13 docs: add CONVERSION_CMD definition
(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>
2022-06-30 17:09:51 +01:00
Michael Opdenacker
d9adf28c10 manuals: replace hyphens with em dashes
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>
2022-06-27 14:55:08 +01:00
Michael Opdenacker
0d1d3afa8a manuals: switch to the sstate mirror shared between all versions
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>
2022-06-27 14:55:08 +01:00
Peter Kjellerstedt
c4f669566f ref-manual: Add documentation for INCOMPATIBLE_LICENSE_EXCEPTIONS
(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>
2022-06-27 14:55:08 +01:00
Michael Opdenacker
f7f4444e36 manuals: update host tool requirements
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>
2022-06-21 20:57:17 +01:00
Michael Opdenacker
8ea5e52d75 migration guides: release notes for 4.0.1
(From yocto-docs rev: a17bfe2636c11ce8e3266d9add804d795991e2ea)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-28 10:46:00 +01:00
Michael Opdenacker
13d70e57f8 migration guides: release notes for 3.4.3 and 3.4.4
(From yocto-docs rev: dbcc41f2c9fd5b2e52b62a9e12e0129f10565fa9)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-24 13:58:47 +01:00
Michael Opdenacker
cee443ae75 manuals: add quoting to references to bitbake.conf
(From yocto-docs rev: 3bf6482e15d1bf00e03c030ac89363e467a8cde1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10 12:52:35 +01:00
Michael Opdenacker
eae7c2a0c2 manuals: fix name capitalization issues
- 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>
2022-05-10 12:52:34 +01:00