Age | Commit message (Collapse) | Author |
|
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
>From sphinx-build man page:
-j N build in parallel with N processes where possible
(special value "auto" will set N to cpu-count)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 1847aeea8b88c84f821610803264955e51e31d2f)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
The default PDF output shows only chapter headings in the table of
contents and in the outline (aka PDF bookmarks). We should override
these defaults to set something more suitable.
With a depth of 2 for the TOC we see both section and subsection
headings which is enough to get the list of classes in the reference
manual and the list of topics under "Common Tasks" in the development
manual. Going to a deeper level would make the TOC unwieldy but we do
want to make sure we can navigate more precisely using the outline
(commonly shown in a left tab in PDF viewers) so we set the depth to 5
for the outline.
Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 5db16d3b01da0a138b6413347fcf2321a1bfae08)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
There are plenty of variables in poky.yaml which are not used anywhere
in the docs. So let's remove them. We can always add the one we need
later.
Note ORGEMAIL could be used in boilerplate.rst, however this file is
not parsed but included, and somehow the yocto-vars.py exenstion does
not process this file, so we cannot use a variable there.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit f1164d2e6401d93e0b4e484b090abbe0f72a6ac7)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Adds a Pipfile so that Pipenv can be used to automatically install all
the dependencies required to build the documentation
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 31658ad30827d38dcd4ea83bcfb828441c7c3eca)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Since the ADT manual has long been superseded by the SDK manual,
remove the entire adt-manual directory, and the references to it in
the two top-level files "conf.py" and "poky.yaml".
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(cherry picked from commit 64b2e83bddf6af0439ac7089ac95e60faa696cfc)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Directory has been renamed, so fix README and add a bit more white
space to keep everything lined up.
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit cdd4c705f7271e31e44a94c79b050eda1fba5945)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Fix single misspelling.
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit e1a47857f4ff3edb105e7fa80ff8d29dcc3ece03)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 6c023ee1328bb31ececd9e1daaac67351c8320e3)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Add IMAGE_LINK_NAME to the variable glossary.
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 370551f961a291f7090a8a40a0beea3511274bc1)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Add a variable glossary entry for IMAGE_NAME_SUFFIX, which was added way
back in krogoth.
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 78920a8ea5fb991606300c1fcb48aa6a7c20f8c1)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Add an entry to the variable glossary for IMAGE_VERSION_SUFFIX (which
was added in thud) and update the IMAGE_NAME and KERNEL_ARTIFACT_NAME
entries whose defaults use this variable.
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 1a02c4be8e348687d4f7e09aefc408aaed5f1be5)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 843a91187783b2e11512c45b8dd8302b19113569)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
distro_features_check was renamed to features_check and extended to
support MACHINE_FEATURES, COMBINED_FEATURES and ANY_OF_*_FEATURES in
dunfell, but the documentation still needed to be updated.
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 274eb596582a22883e8b386a07cf32ed45a77d79)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Make it possible to link to the explanation for a particular QA check.
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 3f6dc24e0a371feca8fe66c1be8c86e599307854)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Since 2.5 (sumo), RDEPENDS_kernel-base has been replaced by
RDEPENDS_${KERNEL_PACKAGE_NAME}-base, so let's use this one instead.
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 0639160185969a6761e9911a166b897a015f4d59)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Patches provided in SRC_URI are only applied if their extension is .diff or
.patch. The examples do not use those extensions and would probably result
in user confusion as to why the patches aren't being applied to the
sources.
Let's fix this by giving them a .patch file extension.
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 0858e86ed8e3e3005207980041fe4f2117750663)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit a69247321ff34cb0a2b9a8cc62020ec7f3aad834)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 64c7cb54e031b5b0babc8ee33dac0b9162a5f391)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Adds documentation that describes how to use the --offset argument in a
kickstart file
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 0fbb2d71fe866b4ae7721f2f70d5b50dbc019030)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit cb0e11170b34b332b41f8b533545c69b05c696c0)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Everything declared in a glossary has a "term-" link that is usable as an
HTML anchor. The link already works, one just cannot get a link from
within the ref-terms page.
Let's make this possible.
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit fcbb267fba968834d4d9d011fc71cc371f910447)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Adds an example to SRC_URI that explains how to name sources in SRC_URI
and how to associate SRCREVs and checksums with the names
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 900af0addab7d6ea465922957f881a13012429ed)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit ab244dcd48968ea6d0e328808c9aac4aef281032)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
SimpleHTTPServer is python2 only, the module in python3 is http.server.
Let's use this one since everything in Yocto Project is using python3
nowadays.
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 75338f17b116afadb7360181d071875a68272708)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Missing DEPENDS were an issue before rocko (2.4) because of a shared global
sysroot. Since then, every recipe has its own sysroot, it is not possible
to build successfully a recipe without all DEPENDS. Therefore, races in
tasks possibly triggered by missing DEPENDS are a thing of the past.
This paragraph is misleading and can be safely removed.
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 9aec42794846a4bca37b49a9f920fa2887974ddf)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
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.
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>
|
|
This unfortunately makes the variables probably unusable for proper
replacement in other indentation blocks.
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit adf240b8db9597328324bbfb0095f573bea217f9)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
poky.yaml changes aren't detected by Sphinx by default.
In order to detect changes in poky.yaml, its md5sum is stored in the
app.outdir (BUILDDIR/html when building html) and checked against the
md5sum of the poky.yaml under use.
If the md5sum has changed, find all rst files in app.srcdir that have at
least an occurence of `&.*;` and mark them as requiring a rebuild.
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 59537c7fa49e3ea6918f45b3201ad16d56988b9b)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Sphinx docs
Tested with containers on all supported distributions.
Debian 8 (Jessie) still has Python3.4 and an old pip3, which makes it
impossible to build typing module which is a requirement of "new" Sphinx
python module.
One cannot update to latest pip3 from within pip in Jessie's version.
One cannot get a newer pip from upstream because newer pip don't support
Python3.4 anymore.
One cannot build with python3-sphinx package from Jessie because the
package is too old (1.2.3) and does not have sphinx.ext.autosectionlabel
module which appeared in 1.4 version.
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 14da565986a573ac7e0b5c5943e55b7b74f99dd5)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
tinderclient class was dropped in dunfell.
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 241059880bbfa61b61cf1843447e1b6d57c71ebe)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 19b3ce7bc46b76207a6f3733881f3f16deab5a0d)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit f21e92f74c8357b23fd4059af6815fbba9487147)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
There's probably no need for such a variable (the name of the script is
unlikely to change any time soon) and not all instances of
oe-init-build-env were actually using this variable.
For consistency sake, let's just remove the OE_INIT_FILE variable.
Suggested-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 6fd4421283005b0ecc980e9ef25770d383b93937)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit f5688a74cd9d100dee270edb9a33c02015cfabda)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Manually tested, ran linkcheck on it too.
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 46912c4c7e429f01dba52071efa649e8c4fbaf06)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Fix some typos.
s/necesary/necessary/
s/overriden/overridden/
Signed-off-by: Naoki Hayama <naoki.hayama@lineo.co.jp>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit f4ce6ae80b1d96f9b8bead013642aeda0c776182)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.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)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 8d30c3d792755a7bfdb74b331dad98f51d3516af)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Now that the DocBook files are removed, we can rename the top level
Makefile.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(cherry picked from commit 25fefa9a91ba5d7b398443f543e2c46165e8a3f4)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
The Yocto Project documentation was migrated to Sphinx. Let's remove
the deprecated DocBook files.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(cherry picked from commit 28fb0e63b2fbfd6426b00498bf2682bb53fdd862)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.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.
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: 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 77aa3990cab4fb01706d0b6b0284c38e4d9dda56)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.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.
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>
|
|
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>
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>
|
|
This is a new manual in YP 3.2, let's remove it from the 3.1 Sphinx backport.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.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.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.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.
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.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
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
|
|
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|