Commit Graph

8 Commits

Author SHA1 Message Date
Michael Opdenacker
fac2a5eff5 manuals: fix trailing spaces
Fixing errors reported by "make sphinx-lint"

(From yocto-docs rev: 45b04c281a567e06fd2904166bcc26603e73e684)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-04-19 04:50:39 -07:00
Michael Opdenacker
e0c348b644 manuals: update references to buildtools
Also fix number of corresponding paragraphs

(From yocto-docs rev: 28ee2d91fe4dd0549940dc5df1ff1d59363fcc0f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:55 -10:00
Michael Opdenacker
fa870dfd0f manuals: suppress excess use of "following" word
To simplify the style, replace "Following is" and "Following are"
by "here is" and "here are", sounding more natural.

In some cases, also go further by simplifying "Here are/is xxx"
by "xxx are/is" when the "are" or "is" are not two far at
the end of the sentence.

In some cases too, completely remove the sentence, when
it's redundant with the preceding title.

(From yocto-docs rev: 2539f1b9cbf9bdd40eff93c6522dc76133debed7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-03-01 05:19:54 -10:00
Quentin Schulz
cf42cc0ef0 docs: migration-4.0: specify variable name change for kernel inclusion in image recipe
Since commit f6d963fa6d ("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>
(From yocto-docs rev: 775a3c7c56562fa8dd6a426008bce06ca1140e04)

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>
2023-01-06 17:33:45 +00:00
Nicolas Dechesne
c77f0ce695 migration-guides: stop including documents with ".. include"
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: ac4e4b167964dd4548fb3d90cf9c63580a70b6e3)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-29 19:10:10 +01:00
Paul Eggleton
eee7bbc16a migration-guides: add release notes for 4.0
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>
2022-04-25 15:22:12 +01:00
Paul Eggleton
97bfd780ad migration-guides: complete migration guide for 4.0
* 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>
2022-04-25 15:22:12 +01:00
Richard Purdie
5fc8dd16f2 migration-guide: Kirkstone is now 4.0
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>
2022-04-13 16:54:32 +01:00