The current HTML output is bogus, because we have a fix of * and \.
Sphinx has built-in footnotes that can be used in this specific
example. let's use that instead.
(From yocto-docs rev: ebac4486e711152962bb8cd22b55ddce332b07f6)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 5be36103ca1102c995915a20bf881e43920595e3)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When the license identifier tags were added, an incorrect string was used
and the Share-Alike clause was lost. Fix this to match the license
description in the files and add back the lost piece (its clear from
the history it should be there)
(From yocto-docs rev: ac9eede80f19c6e2138406209ab5700e89a244a0)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 8d30c3d792755a7bfdb74b331dad98f51d3516af)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Yocto Project documentation was migrated to Sphinx. Let's remove
the deprecated DocBook files.
(From yocto-docs rev: abdb6b6bdfef3dc8e8cc13779e44a8d6df903469)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(cherry picked from commit 28fb0e63b2fbfd6426b00498bf2682bb53fdd862)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The following changes were undo'd when the Sphinx docs were backported
in dunfell:
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
In this commit, we reintroduce the content related to these patches,
but in the .rst files.
(From yocto-docs rev: a6a1b8e9df26b4b4ccf5c5c9cc3c02fa156cf81f)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Update the author indo and use variables for author and email to make it
easier to change in future.
(From yocto-docs rev: 4fdf2a060705fa00b11b5a9d270f4ffa506c9927)
Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Given the defined DocBook entity:
<!ENTITY YOCTO_DOCS_URL "&YOCTO_HOME_URL;/docs">
replace numerous instances of the more verbose
"&YOCTO_HOME_URL;/documentation", which is a redirect, anyway.
rday
(From yocto-docs rev: 53fa17321624028b12d880bc4236fbef46675eb4)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the "Manual Notes" section of numerous YP manuals with a
reference to the recently-introduced YP documentation mailing list.
(From yocto-docs rev: a10fe36c864b8f1a71c6a8eb7e1f6a4eef2f5171)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scrubbed so subsequent releases are relevant to the
initial release only.
(From yocto-docs rev: 7bb2c4f851aa968eb05b11c5471b81962f268eba)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Updates to poky.ent
* Updates to mega-manual.sed
* Updates to all <manual>.xml files for date
(From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I was using "2.8" throughout the manual set instead
of "3.0". Updated all aspects to "3.0".
(From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #13079
Bug is about making sure the section on the devtool command
talks about oe-local-files. Two devtool commands (modify
and upgrade) needed to mention the role of the oe-local-files
area and how it is used during these commands. I updated the
appropriate sections:
* Use devtool modify to Modify the Source of an Existing Component
* Use devtool upgrade to Create a Version of the Recipe that
Supports a Newer Version of the Software.
(From yocto-docs rev: 70ed68eca6dcb5b1f1b5638fd27a7b513b65661e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Use devtool upgrade to Create a Version of the Recipe
that Supports a Newer Version of the Software" section, we
reference "fetchers" but do not link to the section on them
in the BB manual. I added a link.
(From yocto-docs rev: 633ac78daa2ab3bdde17ecb1a203f6addd6ee4af)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
poky.ent - variables all set up for 2.8
mega-manual.sed - "2.7" replaced with "2.8"
<folder>.xml - manual revision history tables updated.
(From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
One Neon appendix completely removed. One other chapter
removed that held the latest version of Eclipse use
removed. A figure was also removed.
(From yocto-docs rev: 03524fc363f9232a2ed45d10688ddeb0439b0917)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The help files for YP manuals used in the Eclipse application
are no longer supported. I removed the individual
*-customization.xsl files for the individual YP manuals.
(From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
unify the spacing for questions in various places
e.g. before the [Y/n] there should be a space, and before
"?" there should be none. Unify the questions where the
system expect an answer from the end user
(From yocto-docs rev: 0643b2e22273a798b96f126931885efd733e5f89)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated poky.ent to have variables for 2.7.
Updated mega-manual.sed file to use "2.7" string.
Updated all <manual>.xml Manual History Tables to use "TBD"
(From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title needs to use the terminology "Build Host" to be consistent
with the manual set. I updated the title and the many links into that
section.
(From yocto-docs rev: 930030433e58e6180ee4f95e559d079c3899defc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This fix involved a few other manuals.
(From yocto-docs rev: d2659951a458a8db773e8c1b2b86a7b109d667fa)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made some re-writes for clearity.
(From yocto-docs rev: a68619a2ba8b7877cde6c9ef7dbb726adc75b0cd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
On second thought, the list I turned into a bullet list from the
previous commit was a bit hasty. That list is order dependent.
Reverted the list.
(From yocto-docs rev: 9ea640ffea2a2c9827f18070a5b287453c8653e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The list appears to be not a numbered list. Fixed that. Also, provided
better wording around "exposing" the sstate-cache.
(From yocto-docs rev: 15c65db41c9e6eddf7d12e138f6c63755e845beb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Step 1 of the "Providing Updates to the Extensible SDK After Installation"
section really did not do much for the reader regarding setting up a
HTTP or HTTPS directory. I added more detail on how to generally do
that.
(From yocto-docs rev: ff250cea239668db5fe26aa912942c0d142833fa)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made some suggestions on how and where to edit the SDK_TITLE
variable.
(From yocto-docs rev: 4a4393e00c7108eefaaeaa3951a75524589bf360)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added more detail to this section.
(From yocto-docs rev: 15beb33eadd03391a1af0c9bad0620cefad2a0e2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There are two sections that deal with this topic. One is from the
standpoint of a user using a 3rd party published and installed
extensible SDK ("Applying Updates to an Installed Extensible SDK").
The other is from the standpoint of a person providing Extensible
SDKs for consumption ("Providing Updates to the Extensible SDK
After Installation"). These sections needed some closer examination
regarding fully describing what was going on. I provided some
re-writes to both.
(From yocto-docs rev: 1c60b13b5f1813d6e3688e1efce32b7f31422e86)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title for the section on how to effect changes to an installed
extensible SDK is better suited as "Providing Updates to the
Extensible SDK AFter Installation."
(From yocto-docs rev: 2120ba194abada1769be28ae2737ac12a16adebc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In "Providing Updates After Installing the Extensible SDK" section,
Step 1 had a bit of a grammar error. Not technically, but it
could have been written better. I fixed that.
(From yocto-docs rev: 20f1cad5a813697afd99837699bf52a6586893bb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added more information on how this is done. Still could use a bit
of detail on how you actually do it.
(From yocto-docs rev: 007bbe40fd11a5f880adf7ad8137d1535f08c815)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated this section with clearer text.
(From yocto-docs rev: 433388ff37297d905c465a5f05d93953dfe062c5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made improvements to this section and tied the variables together
for the explanation.
(From yocto-docs rev: de882b81ed8525dee5e10f247cc6f5c8f15e0f72)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This figure had changed. I updated the file and folder hierarchy.
Also fixed some wording.
(From yocto-docs rev: 359292397781f9f5eac2fb693d89ec286ddf9940)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The figure was incorrect for the installed file and folder hierarchy
for a standard SDK. I updated it. This figure goes in both the sdk-manual
and the mega-manual.
(From yocto-docs rev: a0dc11ce74bba0a18f385d9800f93524340ed033)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Verified a good example and updated the text to match that example.
(From yocto-docs rev: 053467557ef22ce37762222a2997ff9c10be87e8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The value of SDKMACHINE must match the architecture of the machine
on which the SDK installer is being built if you are building an
installer for an extensible SDK. I added a note to this effect.
(From yocto-docs rev: ffdd9a9d00cccf270b5aa236279e6eeea0ff47ed)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the example to more current information.
(From yocto-docs rev: 6952824473f820cbe6d02cba9523c023652f68e3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated some links. Also, rewrote the note about the libraries.
It was inaccurate.
(From yocto-docs rev: a0fce0ed36f3d0668e2d211433e7d93fb8833319)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I corrected some wrong information. Provided the correct terminology
for the build host, and provided quotations for supplied values to
be in line with manual writing conventions.
(From yocto-docs rev: 420a7e96e7145dbef31d706cd257059619f71e12)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made several formatting changes for selections. These should
be using quotes and not being formatted in Courier.
(From yocto-docs rev: ec0a2d7e3cfd78fa4e508d5672f1c8265a3600a4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
