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>
I left out the word "not" in a key sentence in the new
"Checking on the Upgrade Status of a Recipe" section.
Little words can make big differences.
(From yocto-docs rev: 46a524a0d6c9e2ed6428039a4454e384a6ef648d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the section to include more detail on what the user
sees in the returned table.
(From yocto-docs rev: 671279548dde7f356888ba1ad1551b8bb1f70a65)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a new section showcasing the "devtool check-upgrade-status"
command.
Also, added a note in the "Upgrading a Recipe" section" to tell
the reader they might want to check on a recipe's upgrade
status before upgrading a recipe.
(From yocto-docs rev: 974f63fe8836fccd51f12b511c23644235cbd4b4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Specifically missing was the "devtool check-upgrade-status"
command.
(From yocto-docs rev: beaa40e8d1037f237ab588ec6ce256b8c3a18543)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The actual title of the sdk-manual does not include the word
"Manual". So, the reference to the book should terminate with the
word "manual" in lower case.
(From yocto-docs rev: 41bc85776f0b172fc243b6e5a5ca13b72e8399e5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the devtool add -h output.
Updated the devtool --help output.
Fixed wording for the "attic" file associated with the figure
of the workspace area.
(From yocto-docs rev: bc53d9a1236ba2545c112256e886729b08b507de)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided a bit of rationale on why and when you use this command.
Put in several links to help the reader get to related areas where
command use is explained.
(From yocto-docs rev: 7b30f29bfa15dd15f1388bb856e2047be55e7fb9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of the sdk-manual changed. Many links were updated to
render to the correct book title.
(From yocto-docs rev: 821e29c6c031ae2516fb0e79d0ec3936a5bd624c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11392]
Updated the section to document how to specify a branch,
tag, or revision when using devtool add with a remote
URL.
(From yocto-docs rev: 903b4a4e72908572a5f8b8c822869bbd0fe76ec9)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke several links to the id "build-directory". I fixed
these to reference into the ref-manual now.
(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10350]
Based on Henry's assesment that the wording was unclear in some
spots, I did a little smithing to try and help.
(From yocto-docs rev: b52bb8d73071ad6b7a0956dec2f84a84ae1c7045)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10350]
A situation exists where a user deploys a new application using
devtool target-deploy and the new application has runtime dependencies
that are not already on the target. When this situation exists, the
application misbehaves if it calls a missing function. I added the
explanation of this situation to the section that describes the
devtool deploy-target command. Also, put a pointer in the section
on devtool add for cross-reference purposes.
(From yocto-docs rev: 694151e397ff40871b3ec8700c39d32a15814535)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I put in some introductory material for the new devtool
quick reference chapter.
(From yocto-docs rev: dc46f47692a533ac2450bf459c098435c57e6c07)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did the following:
* Added the devtool upgrade flow to the SDK manual.
* Removed the devtool Quick Reference from the dev-manual and
added it as a new chapter to the ref-manual.
* Made sure all the links and cross-references work now with the
moved material.
* Updated the Make file so that the manual set builds correctly
regarding the new chapter in the ref-manual.
* Created cross-referencing notes in both the sdk-manual and the
dev-manual to the newly located devtool Quick Reference chapter.
(From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
