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>
Before the move to Sphinx, it used to be possible to get a direct link to a
variable from the term glossary. It is very useful when pointing people to
a specific variable when manually looking for it in the glossary.
Let's add this "feature" back.
(From yocto-docs rev: ee811e9f351eb79987dcdc2c2dbbd14ac52d92ca)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 9e468274eaad270efd5f50e58a523798fcb8097e)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since the move to sphinx, variables aren't linked with var- anchors but
term-.
Let's fix that so clicking on a letter will bring to the correct variable
in the page.
(From yocto-docs rev: 731d8b62ba588200d7d57cee0fd56256f32bd9a2)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 07718faa04a8b121be004afbc23b4c338f669413)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The following changes were required after a review of trademark and
branding guidelines:
1. add (R) to 'Yocto Project' on the top left (above the logo)
2. Fix up the capitalization of the main page title
3. Add the copyright/legal blurb at the bottom of the page
For 3. it turned out to be simpler to override the whole footer.html
template, and maintain our own version. Also I took the liberty to
remove the 'next' and 'previous' buttons since I believe they are not
especially useful, given the navigation bar on the left side.
Reported-by: Tracey Erway <tracey.m.erway@intel.com>
(From yocto-docs rev: a29ee99f81aa5b3cc66493e79712a3b5dc31e23f)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 6bae1372218e0b10258e4fa6fef72fc1708a329c)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is a new manual in YP 3.2, let's remove it from the 3.1 Sphinx backport.
(From yocto-docs rev: baf4410abad44b7f1fc6e4f1c445060b87c21c32)
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>
This change was made in Sphinx/master, but does not apply to
dunfell. Since we inherited it from the Sphinx migration, we need to
undo it.
(From yocto-docs rev: f5132957398af9644188cf010acec55bca6e8a8e)
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>
As these comments have been around since 2015 and apparently unused,
get rid of hundreds of them.
(From yocto-docs rev: 98687310b9e2d4cd3bd4c96e100877414dcf791c)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit afec5770a22ac51c956e87567bf39e71064e9f04)
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was, years ago, deprecated in favour of FEATURE_PACKAGES, so
remove all references, other than the entry in the migration section.
(From yocto-docs rev: 2deac02f283547f66d1f7a002f5bf07ddd449401)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This outdated section contradicts the real behavior expressed in the next
paragraph
(From yocto-docs rev: 77e8a9e03b3bb6e6b6b2adf7796740fb362f189b)
Signed-off-by: Maxime Roussin-Bélanger <maxime.roussinbelanger@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the npm:// URL and the generated npm recipe, and remove
references to NPM_SHRINKWRAP, NPM_LOCKDOWN and lockdown functionality in
general.
(From yocto-docs rev: bc09233543abbf28adfcc1e214f85ef4c7c56639)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the glossary entry for PACKAGECONFIG in two ways:
1) Explain the recent sixth argument, which identifies conflicting
features for a given feature.
2) Use a different example, as the librsvg "croco" feature no
longer works that way.
(From yocto-docs rev: af9bf61a54c059e72c807ca8061a57d6fe74c5fa)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For stylistic reasons, clarify the use of both IMAGE_FEATURES versus
EXTRA_IMAGE_FEATURES when configuring a read-only rootfs.
(From yocto-docs rev: 4111e4e70a87400671455ddd873d802d40d6b587)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The apmd recipe is no longer appropriate to demonstrate the use of
SRC_URI checksum names as it has only a single SRC_URI URL, so pick a
more illuminating recipe.
(From yocto-docs rev: 7f391a0656442e7ee2f3dd48b848befb7f461aec)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section 3.3.5, "Fetching Code", uses the cdrtools recipe as an example
for showing the use of PV, but that's a bad example since the current
cdrtools recipe file contains:
SRC_URI = " \
${SOURCEFORGE_MIRROR}/project/cdrtools/cdrtools-${REALPV}.tar.bz2 \
...
PV = "3.01a31+really3.01"
REALPV = "3.01"
which is not exactly the point the dev manual is trying to make, so
replace with simpler strace recipe.
(From yocto-docs rev: d865b0288a4162a8d4df9a2abde43875e3dc2ced)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Bump tar, Python versions and add new gcc requirement.
Update reference from 'required-git-tar-and-python-versions'
to 'required-git-tar-python-and-gcc-versions'
(From yocto-docs rev: ca6334c1653d5e2abfe77865391509a8cd516d88)
Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Bump tar, Python versions and add new gcc requirement.
Update reference from 'required-git-tar-and-python-versions'
to 'required-git-tar-python-and-gcc-versions'
(From yocto-docs rev: 18b11662c7c9ab7828d2709eed4090116a751e14)
Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add instructions to use 'install-buildtools' and
'buildtools-extended-tarball'.
Add gcc 5.0 requirement and call out how to
use above to prepare host development system.
(From yocto-docs rev: c6dbd9bf6860ffea1bc025907343373439d91737)
Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
jessie-backports is no longer supported, so python3-git and
pylint3 are not installable via apt-get (or at least not
without disabling security checks by using archive.debian.org)
Add note to use pip3 to install instead.
(From yocto-docs rev: 19a02c5c6ef9a317c2339c2ec71200e51335e32f)
Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
CentOS-7 has different requirements than the much
newer CentOS-8. Add a section for CentOS-8 and
make the old section CentOS-7 specific.
NOTE: at the time this was written, the 'fop'
package is not yet available in epel-8. As
a Fedora packager, that will change.
(From yocto-docs rev: caf08811a23a29965ec915459019796a0c882d4d)
Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update Centos-7 to require python3, not python.
CentOS-8 has different installation requirements than
either CentOS-7 or Fedora (although it is closer to
Fedora).
Allow for differentiation between CentOS versions.
(From yocto-docs rev: 615fc45108d10e842679b3d8a38b53074d3eed4b)
Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
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>
KBUILD_DEFCONFIG is meant to refer to an *in-tree* defconfig file, not
an external one.
(From yocto-docs rev: 34202eee3fc2bb4e0b92374822bff87fd3af1ebc)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Migration to YP 2.5 contains incorrect description of routine for
delaying to first boot.
(From yocto-docs rev: 08f71ec137822c0c19b56956d7045dfb73a544d7)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the example used in explaining the PROVIDES variable to one
that actually exists, and point out that "+=" is unnecessary, a simple
assignment is sufficient.
(From yocto-docs rev: 80cd888ee81757bc5281f174b26974391ee45522)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor tweaks to chapter 5 of reference manual, including:
- grammar
- adding slashes to directory names for consistency
- collapse trivial paras into one
(From yocto-docs rev: 96b75e723bff042183f70a858d09df4aad094578)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
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>
Make it clear to the reader that they can use the much shorter form of
${PN} for the base packagegroup name, rather than typing it out in
full.
(From yocto-docs rev: 19915978c30bbf37b65d9887c78a23394779f079)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add explanation of missing checks performed by yocto-check-layer, and
fix one typo.
(From yocto-docs rev: 231bb92fa4a9c044894f845b8d6d0b9498abfc49)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
