Add a new section to release-process.rst to document the development
cycle of each release and namely the milestones and feature freeze
occuring after M3.
Fixes [YOCTO #15979]
(From yocto-docs rev: 1cc5321c162ce36079d661ea1d35c2694c20ed9b)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 77c04cc5944acda7575546a7434e014e4a75ba58)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We have moved to Valkyrie which is hosted on
https://autobuilder.yoctoproject.org/valkyrie. Update the URL in the
documentation.
Also, the YOCTO_AB_URL macro was used in a single location in the
documentation so replace it by the :yocto_ab: custom extlink and remove
the macro.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: b02e90b6eb32ce57a98e0e3720848e5cdfbb69d0)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 0b0ed55d909dd11cdc9b29b105473271627c025e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
In the same fashion as the previous commit ("ref-manual/packages: move
ptest section to the test-manual"), move the runtime testing section of
the development tasks manual to the test environment manual.
Add a link to it from the test-manual/intro document.
(From yocto-docs rev: 79aa34db34def525a11c41d951365bcb891318c4)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 6b44257874858db3aa426d3e84a79c41cb4937a3)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
[ YOCTO #15106 ]
It makes more sense to document ptests in the test-manual. Since ptests
are still related to packages, keep a link to ptests from packages.rst
to the test-manual.
Reported-by: Yoann Congal <yoann.congal@smile.fr>
(From yocto-docs rev: 110e15c4407dfc03c7d931e4488eb43dbfad7570)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b389c06b709e4791e1cce5e8a5b58f6b0cd03a14)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
When reading the stable releases section, we want to know for which
release the documentation was built. Use &DISTRO_NAME; to refer to the
current release.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: fb5bbfbe7138ad5643b2929dd77d8cb79bc9c74c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 05ee6844d710beb844bbdac892888879847f6d22)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Mention that Scarthgap the latest LTS in a bullet list next to
Kirkstone. Reword the parapraph a bit to make it clearer after this
change.
Reviewed-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
(From yocto-docs rev: 0ed10e173457bf28338115a063cfa42c88a541d8)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit afeded9939777d88bf4cb9ebf7a61aadd476642d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
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: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also add a target (and use) a target
for the "Long Term Support Release" section.
(From yocto-docs rev: 98d6f2066fcdb20e63b8da6ed52d0f3590b15195)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Remove note to section not carrying information about
special hosts tools for oe-selftest
- Add links to mentioned repositories
CC: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
- Simplify references to class sections, by replacing references such as
:ref:`image.bbclass <ref-classes-image>`
by
:ref:`ref-classes-image`
That's equivalent, because the class sections always called <class>.bbclass
- Adding references to class sections, by replacing strings such as
``image.bbclass``
by
:ref:`ref-classes-image`
- Simplifying a few class section links
(From yocto-docs rev: 29d66aaa898390c19f121baf0f4fdcc178e4cd80)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fix missing reference and styling issues found thanks
to trailing dots (only non black character in a line)
Matches (and multiple false positives) found with the below command:
git grep "\s\.$"
(From yocto-docs rev: 1d3026f50753d9ccf39b7d0163c77c765d754994)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This makes the reference manual much lighter by moving
the migration guides to a separate document.
The migration guides are also reordered from last to first,
and they appear directly in the left bar, making them easier
to find in the documentation.
(From yocto-docs rev: 5121b86ee97eb62a0c69c9ad1fc0e3fabbe3e934)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Anchor links are treated by Sphinx as external links and are not checked
during build, meaning it is impossible to know if a link becomes broken or
not.
As a matter of fact, most of the anchor links replaced in this commit
were actually broken.
The README now states that anchor links are forbidden so that there's no
need to go through such a change later on.
(From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
poky.yaml references are only replaced in files if they are prefixed by
& and suffixed by ;.
Let's fix the missing surrounding characters.
(From yocto-docs rev: 7ee4ba7a27acd87d8c728639d1b053d2e26c6e58)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references
(From yocto-docs rev: bb7e4783f45a5f67e6e4b39968f3512f43738833)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
