- Shifting the focus to multiple changes instead of just one
- Advising to create a branch for changes
- Removing unnecessary or too verbose explanations
- Adding useful resources and examples
(From yocto-docs rev: e7e47121fd979e034f8f40a043912640a6a25a5e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Starting from the original contents of dev-manual/changes.rst
and from text contributed by Richard Purdie.
(From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Except the "yocto" and "uninative" directories, everything
under https://downloads.yoctoproject.org/releases/, in particular
"bitbake".
Point to https://downloads.yoctoproject.org/releases/yocto/
instead for people interested in tar archives.
Simplify the description too, unnecessarily verbose.
(From yocto-docs rev: 502b00003b1c84d7b419f01b87a6ab6a121a7ad9)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Fix the location of the target for supported distributions
- Improve the name of this target
(From yocto-docs rev: 40f0cf9302b9f0ce01a1270977644b1b2fdfc650)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
- Use the Wikipedia naming scheme: WSL 2 instead of WSLv2
- Take into account Windows Server 2019 and 2022 which are
supported too.
- Improve some explanations
(From yocto-docs rev: 35c5fb01d3543ef5e1f4edf337a2ab080b4e7956)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
- 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>
We don't publish tarballs using this version any more, it has been
removed everywhere. Remove the obsolete references in the docs,
adapting references accordingly. The tarballs now are just created
with their sha256 checksum which we don't want or need to reference
in the docs.
(From yocto-docs rev: c7a0ac88b01c48f3d9209536542bf43ae7a7937f)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using DiskPart for the systems which lack optimize-vhd
(From yocto-docs rev: c692b77065e6bd8eda789a88fa8fae1351a7274d)
Signed-off-by: Tony McDowell <svet.am@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
While nightly builds are still run, they only produce
test files and reports. They are no longer a solution
to use the latest code.
(From yocto-docs rev: ace9f81ade851bb1b0d98a050007fffbc62b938d)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since there are actually four listed requirements, just drop the
number to avoid future issues.
(From yocto-docs rev: 612015dc227600d23956402eab7f324e0c8fd42a)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update Docker installation URL on various plaforms, replacing
some URLs by the ones they now redirect to, renaming "Docker CE"
to "Docker Desktop" on Mac and Windows, and to "Docker Engine"
on GNU/Linux.
Stop mentioning "Docker Toolbox" which is now deprecated and
replaced by "Docker Desktop" on Mac and Windows.
(From yocto-docs rev: 8eb249aed50b7b5b2078648c9efd9c79262ae57f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This simplifies paragraphs ending with a colon and followed
by code insertion.
Automatically substituted through the command:
sed -i -z "s/:\n\s*::/::/g" file.rst
This generates identical HTML output.
(From yocto-docs rev: 28e2192a7c12d64b68061138a9f6c796453eebb1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minimum Git, tar, Python and gcc versions are specified in quite a few
different places. Let's add some variables for these so there's no
chance of missing one if they're updated in future. Additionally, for
hardknott the minimum Python version is 3.6 so set that as the value for
Python.
(From yocto-docs rev: 9a802bc4bb0438c2540f360a08c7787caf64408a)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.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>
In the "Yocto Project Quick Build" instructions
(https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#)
there is an inconsistency that impacts several documents...
People are first instructed to clone the poky git repository, but not
mentioning from which directory. Then, it's consistent to instruct
people to run "cd poky/".
However, later in the instructions, readers are instructed to run "cd
~/poky", which assumes that cloning poky was done from the home
directory. Many other places in the documentation make such an assumption.
This change fixes this, and makes no assumption on where people
have chosen to store their data, in particular where they cloned
the "poky" repository.
This also fixes a few whitespace issues.
(From yocto-docs rev: fd4e365c85df212d7ed70fc1abb3657a4a88b294)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
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>
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: bd8c0f7fc09a39a8bbde1c05b51693955738e148)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
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: 4f489a40bb00be018e419802a76fec9dbee3f255)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
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: 3d7eb2c5e1d230290c97dd8e5b528086e1d8034a)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
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: 00a9244587e2e63f2a5197ed0dfc89cb330f9275)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
