Commit Graph

185 Commits

Author SHA1 Message Date
Michael Opdenacker
76ab2eab31 manuals: document hash equivalence
(From yocto-docs rev: 7fad0873207980a747f79b2ce29ec0dc6c6c3cdf)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-10 23:12:43 +00:00
Michael Opdenacker
620ba2535c overview-manual: fix typo
(From yocto-docs rev: 595d3e77855aeed31537a5e58a4426d7cc0b21f5)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07 11:12:06 +00:00
Quentin Schulz
e71983bc7d make the documentation a bit more inclusive
Except the name of variables which can't be changed only in the
documentation for obvious reasons and workflow or developement
explanations around the use of the "master" branch which cannot be
replaced with "development" branch instead, most of the non-inclusive
words that appear in https://inclusivenaming.org/word-lists/tier-1/
should have been replaced in this patch.

(From yocto-docs rev: 2755f35060084f7af356091de9dc144f85530fe2)

Signed-off-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
d21c35bd81 misc manuals: add further class references
(From yocto-docs rev: 0693f1f8466a118dc707a9c17d5ca528b4ea368a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
e467ddd9e2 overview-manual: simplify expression
(From yocto-docs rev: ea1e5d4214f30927119f0124ee8a80a558601161)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:24 +01:00
Michael Opdenacker
9c70174e5c overview-manual: SVG diagram for the git workflow
Set in full-width mode to make it ready in PDF
and EPUB outputs.

(From yocto-docs rev: 394c7c26c6591153670c67740d9a64f54725321b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
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>
2021-10-08 22:01:24 +01:00
Michael Opdenacker
f7a8e145e9 manuals: font fixes
This fixes font inconsistencies, mixing a ``text`` string
with another string with the regular font, where the whole string
makes more sense with a single font.

The result is also much simpler and will make future
searches easier.

(From yocto-docs rev: e6d1c166a97a1b6bb42ca49dfcbd3d39f8eadc16)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-08 22:01:24 +01:00
Robert P. J. Day
6c29f198d9 overview-manual: delete bad backslashes in SSTATE_MIRRORS example
Two inappropriate backslashes in the example for setting
SSTATE_MIRRORS are apparently the result of an error by the
transmogrification script for migrating XML to rST.

(From yocto-docs rev: 9cff301a768b248f19fc1d5834f04d3defffcbc7)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-02 09:57:41 +01:00
Michael Opdenacker
95866fd533 manuals: delete unmaintained history sections
This deletes the history sections in each sub-manual,
which didn't add any value, given that they didn't list
the changes from one Yocto Project version to the next.

(From yocto-docs rev: 29ce5b89c438079793cc6457401b6a9275db877a)

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>
2021-09-18 13:03:45 +01:00
Quentin Schulz
52db0c7575 docs: overview-manual: concepts: remove long-gone BBHASHDEPS variable
BBHASHDEPS was removed from bitbake in April 2014, with the following
commit:
92526eadd09d "bitbake-worker: Drop BBHASH variables"

so let's remove mentions from the docs.

(From yocto-docs rev: f9e1768b8c85e3ad7fa974940a90996a5ffee3f5)

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>
2021-08-14 12:04:23 +01:00
Quentin Schulz
3d93ddf9e8 docs: fix new override syntax migration
Fix bits missed by the migration script.

(From yocto-docs rev: 452e0c5067476fd2ce81f09e6c73da84ced4bbd0)

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>
2021-08-14 12:04:23 +01:00
Michael Opdenacker
d664794cce manuals: remove explicit BitBake variable references
The standard :term:`VARIABLE` will refer to the
description of the variable in the YP variable index. If it
doesn't exist, it will refer to the description of the variable
in the BitBake manual.

(From yocto-docs rev: 34cb466caf872f9284eb81f6a5f31ad606214dee)

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>
2021-07-30 22:49:15 +01:00
Michael Opdenacker
38496093d7 manuals: simplify references to BitBake manual
Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`"
by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name`"
when the reference description is the same as the section name.
In this case, that's unnecessary to repeat the section name in the description part.

(From yocto-docs rev: 6a1a590f9ef77dc8842ea5945661135992eb94e1)

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>
2021-07-30 22:49:15 +01:00
Quentin Schulz
5a6fb291ad docs: replace remaining `FOO by :term:FOO`
A few occurences appeared between the time the original patch was sent
and it was applied, this fixes it.

Also, the original patch didn't take into account lowercase terms, this
is now fixed, see module_autoload for example.

Finally, as is often the case with regexp, there was a typo in it that
didn't make it match as much as it should have.

The script that is used to do the replacement of ``FOO`` by :term:`FOO`
is the following Python code:

import re
from pathlib import Path
from runpy import run_module
import contextlib
import io
import sys

re_term = re.compile(r'variables.html#term-([a-zA-Z_0-9]*)')
terms = []
new_terms = set()

with contextlib.redirect_stdout(io.StringIO()) as f:
    run_module('sphinx.ext.intersphinx', run_name='__main__')

objects = f.getvalue()

match = re_term.search(objects)
while match:
    if match.group(1):
        terms.append(match.group(1))
    match = re_term.search(objects, match.end())

for rst in Path('.').rglob('*.rst'):
    with open(rst, 'r') as f:
        content = "".join(f.readlines())
    for term in terms:
        content = re.sub(r'``({})``(?!.*\s+[~=-]{{{:d},}})'.format(term, len(term)), r':term:`\1`', content)

    with open(rst, 'w') as f:
        f.write(content)

This script takes one argument as input: an objects.inv. Bitbake's can
be gotten from https://docs.yoctoproject.org/bitbake/objects.inv. The
objetcs.inv from the current git repo can be gotten from
documentation/_build/html/objetcs.inv after running `make html`.

Note that this excludes from replacement terms that appear in section
titles as it requires refs to be changed too. This can be automated too
if need be but right now it looks a bit confusing to have an anchor link
(for sections) also have a term/reference link in it. I am not sure this
is desired today.

This is the result of two runs of the aforementioned script, once with
Bitbake objects.inv and once with this repo's.

Fixes: ba49d9babfcb "docs: replace ``FOO`` by :term:`FOO` where possible"

(From yocto-docs rev: 1e1b0c4dd241b6657035172b1f7b5f341afa8b25)

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>
2021-07-16 21:59:31 +01:00
Michael Opdenacker
b394cca927 manuals: fix issues related to trailing dots
Fix missing reference and styling issues found thanks
to trailing dots (only non black character in a line)

Matches (and multiple false positives) found with the below command:
git grep "\s\.$"

(From yocto-docs rev: 1d3026f50753d9ccf39b7d0163c77c765d754994)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-19 16:54:01 +01:00
Quentin Schulz
7d3f57cfd2 docs: replace `FOO by :term:FOO` where possible
If a variable has a glossary entry and some rST files write about those
variables, it's better to point to the glossary entry instead of just
highlighting it by surrounding it with two tick quotes.

This was automated by the following python script:
"""
import re
from pathlib import Path

with open('objects.inv.txt', 'r') as f:
    objects = f.readlines()

with open('bitbake-objects.inv.txt', 'r') as f:
    objects = objects + f.readlines()

re_term = re.compile(r'variables.html#term-([A-Z_0-9]*)')
terms = []

for obj in objects:
    match = re_term.search(obj)
    if match and match.group(1):
        terms.append(match.group(1))

for rst in Path('.').rglob('*.rst'):
    with open(rst, 'r') as f:
        content = "".joing(f.readlines())
    for term in terms:
        content = re.sub(r'``({})``(?!.*\s*[~-]+)'.format(term), r':term:`\1`', content)

    with open(rst, 'w') as f:
        f.write(content)
"""

(From yocto-docs rev: ba49d9babfcb84bc5c26a68c8c3880a1d9c236d3)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-19 16:54:01 +01:00
Michael Opdenacker
31f1d4d331 overview-manual: simplify style and add missings references
(From yocto-docs rev: 4a07947dbe0dd70fd1d528a207d663dfdca2b7c1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-22 12:16:41 +01:00
Michael Opdenacker
d4a82b30b7 manuals: reduce verbosity related to "the following" expression
(From yocto-docs rev: da9d1cfb5c084d172eff3cb10ec3631dd8266260)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-13 11:28:34 +01:00
Michael Opdenacker
c3c6de2187 manuals: code insertion simplification over two lines
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>
2021-04-23 16:39:03 +01:00
Paul Eggleton
06e98c4b80 overview-manual: fix git command line
There was an en dash here instead of a hyphen; this meant that the
command line could not be copied and pasted verbatim. (Admittedly that
is less likely here than in other examples, but let's correct it
anyway.)

(From yocto-docs rev: 4f289752fab3529516ad44e6e62a1042c339fd13)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15 20:18:57 +01:00
Quentin Schulz
c380ba5a17 docs: replace anchor links
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>
2021-04-09 15:24:46 +01:00
Michael Opdenacker
aeb59935e9 manuals: fix suspicious newlines
- That could originate from documentation migration issues
- Checked that the corresponding links still exist

(From yocto-docs rev: 38bae8f6067bc12f3617ed38587737d22dd7b32c)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Michael Opdenacker
37ff21babe overview-manual: style improvements
- A few style improvements
- Fix a few typos

(From yocto-docs rev: 116484a850bdd9b8b648d919fd9c8858f6c55e21)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Michael Opdenacker
44d0532c89 manuals: Fix typos and spacing
Fix double words, punctuation spacing issues, spacing issues,
"its" instead of "it's", and other trivial issues.

(From yocto-docs rev: 56eb1f340a7af112e62c1d8ad02d4bec0ad88313)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06 22:29:49 +01:00
Paul Barker
3b298e6ddd documentation: Use https links where possible
(From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Barker
58892e05f6 documentation: Simplify remaining yocto_home links
(From yocto-docs rev: e0151e039f96c1548e2ec39ae24d4b0276f49434)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Barker
ddf55dca6b documentation: Simplify layerindex and layer links
(From yocto-docs rev: b157d57cc50b0a9cfaa062fa0e966b4d29eceeec)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Paul Barker
d903e586c2 documentation: Simplify oe_wiki and oe_home links
(From yocto-docs rev: 6867f54f349edede37c4085194f51342c24297ed)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-24 08:23:33 +00:00
Nicolas Dechesne
b70318797c ref-manual: remove 'ref' from filenames
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>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
79fecb25e1 sdk-manual: remove 'sdk' from filenames
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>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
3240a59758 overview-manual: remove 'overview-manual' from filenames
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>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
a0afa48859 kernel-dev: remove 'kernel-dev' from filenames
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>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
af6f5d821d dev-manual: remove 'dev-manual' from filenames
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>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
9e35603c12 test-manual: remove 'test-manual' from filenames
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: 1b1f2fbd9283ba53c74ea4231ab4391627eb4187)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
097d0c9f04 sphinx: use absolute paths for :doc: references
:doc: references can be made with absolute path instead of relative
path. This patch was generated with this command:
sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst

And a few manual fixup we made for references such as:
:doc:"FOOBAR <../xxx>"

Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Nicolas Dechesne
bd17892611 sphinx: rename top level document in each manual
It is more common to call the top level document index.rst. This is
what this patch is doing, along with all required references fixup.

(From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-09 12:21:27 +00:00
Paul Barker
48748377a4 documentation: Simplify yocto_git links
The yocto_git external link directive is modified to include the
`/cgit/cgit.cgi` element of the URL so that we can simplify the links in
the text.

Manual links to git.yoctoproject.org are converted to use the yocto_git
directive where possible. Note that this directive can't be used in some
places such as example code.

(From yocto-docs rev: 3a8ba5dcc783411c73fe49fb217cbc4d6528d9a7)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:21 +00:00
Nicolas Dechesne
0260421634 overview-manual: remove unused labels
(From yocto-docs rev: ffbb7ef3fea2964f3d9ea2ad02e71692a7d96713)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:21 +00:00
Nicolas Dechesne
63710fc913 sphinx: replace bitbake labels with references to corresponding title
In order to remove autogenerated labels in the bibtake docs, let's use
section titles in all YP docs.

(From yocto-docs rev: 0f44b6027f16cc37260abc7e00042d98e2e0427f)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:20 +00:00
Richard Purdie
a8ec1f72ba overview-manual-concepts: Fix the compiler bootstrap process
gcc-cross-initial and glibc-inital were removed a while ago and this
flow is incorrect anyway. Fix it to match what happens (adding libgcc
and libgcc-initial which are now important in this context).

(From yocto-docs rev: 047bff2b79c7742abc19d549b78c175dd3b5a8f5)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-12 13:04:10 +00:00
Richard Purdie
fe74a4edd2 docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UK
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: 8d30c3d792755a7bfdb74b331dad98f51d3516af)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-08 11:28:30 +01:00
Nicolas Dechesne
43d07a2851 sphinx: remove DocBook files
The Yocto Project documentation was migrated to Sphinx. Let's remove
the deprecated DocBook files.

(From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-06 13:56:17 +01:00
Quentin Schulz
d6ce950527 docs: fix broken links
(From yocto-docs rev: 5139bf1d3ac7f31b711a8410a195ffc88ac560bf)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-22 09:58:50 +01:00
Quentin Schulz
3b9114cf5a sphinx: fix or add missing links and remove mention of Eclipse workflow
The Eclipse plugin has long been gone.

(From yocto-docs rev: f7a01e67d760c1de3f5a36e3513cba1627b4ed96)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:36 +01:00
Quentin Schulz
89b546f636 sphinx: "highlight" some variables, tasks or files
(From yocto-docs rev: 41e379dc32e52cec652a7f89caf4c3fd96dd2dda)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:36 +01:00
Quentin Schulz
177aee09fe sphinx: fix a few typos or missing/too many words
(From yocto-docs rev: 744b74b3420ae475a566307e03e0b098986773e4)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:36 +01:00
Quentin Schulz
32a275c5cd sphinx: fix incorrect indentations
(From yocto-docs rev: af5209df6c8c1dcc852d29b72968aa0b36b6b761)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:36 +01:00
Quentin Schulz
c387f0c254 sphinx: replace special quotes with single and double quotes
(From yocto-docs rev: 0aeb7a94abcef3cb3850c753dd0a243f381e6675)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:36 +01:00
Quentin Schulz
6813141743 sphinx: overview-manual: remove highlight in bold section
Does not seem to be formatted correctly by Sphinx (escaped `).

(From yocto-docs rev: 8363dcea98a12a6b8438a284bcebce35b269eab6)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:35 +01:00
Quentin Schulz
a007f1afab sphinx: overview-manual: fix bitbake basic explanation
One requests Bitbake to bake a recipe to create packages.

(From yocto-docs rev: 2b9a0131999d0d0c014968f792348c55afca4c2c)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:35 +01:00