Commit Graph

19 Commits

Author SHA1 Message Date
Antonin Godard
841965f127 Fix dead links that use the DISTRO macro
After introducing the DISTRO_LATEST_TAG and DISTRO_REL_LATEST_TAG
macros, use them in links that currently use DISTRO/DISTRO_REL_TAG. When
building for the tip of a branch, this will replace the current A.B.999
in links to the latest existing tag.

The links were found across the documentation by running 'grep -r
"http.*5\.2\.999"' inside the _build/html output after building the
docs.

[YOCTO #14802]

(From yocto-docs rev: 29be069ebbf2c55d72fc51d99ed5a558af37c05e)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-21 21:15:29 +01:00
Michael Opdenacker
025386d53c manuals: suppress excess use of "following" word
To simplify the style, replace "Following is" and "Following are"
by "here is" and "here are", sounding more natural.

In some cases, also go further by simplifying "Here are/is xxx"
by "xxx are/is" when the "are" or "is" are not two far at
the end of the sentence.

In some cases too, completely remove the sentence, when
it's redundant with the preceding title.

(From yocto-docs rev: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-24 16:13:28 +00:00
Michael Opdenacker
373001bbc0 sdk-manual: appendix-obtain: improve and update descriptions
- Improve text formatting
- Stop mentioning all possible values
- Update examples
- Correct descriptions

(From yocto-docs rev: f7437c2efa1014dc46481993b5e87d52dcf42b05)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Quentin Schulz
69d68f6094 docs: sdk-manual: appendix-obtain: fix literal block content
Restore the error message as it is supposed to be issued.

The literal block renders its content verbatim so a term role (`:term:`)
would appear as :term: string in there and `---` as --- string instead
of the expected hyphen.

Fixes: e319b3bf4eb6 ("manuals: add missing references to SDKMACHINE and SDK_ARCH")
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 95158beba0aea7539024688c71b54fed5267faec)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-03 15:11:10 +01:00
Michael Opdenacker
6846d4d00b manuals: define proper numbered lists
Using "#." instead of "1.", "2.", "3.", etc.

(From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
01e5d22507 manuals: fix double colons
Fixing double colons appearing alone on a line, while
they could be put at the end of the previous line.

Sometimes placing a note after the quoted text
to avoid such a situation. It's more natural too
not to have a note between the introduction text
and the quoted section.

(From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
b44fbe5b1b manuals: use references to the "Build Directory" term
Replace instances of "Build Directory" and "build directory"
(when applicable) by :term:`Build Directory` as already
done in most places.

Doing this, fix the indentation of the paragraphs with
this term.

(From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Michael Opdenacker
50458d9238 manuals: add missing references to SDKMACHINE and SDK_ARCH
Doing this, fix the odd identation of the corresponding paragraphs

(From yocto-docs rev: e319b3bf4eb6420949372e699d60c7383945e513)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Alexander Kanavin
2ee5950266 sdk-manual: describe how to use extensible SDK functionality directly in a Yocto build
(From yocto-docs rev: 7e1b2e4238c2260fd74295dd208ec774e0e6bf68)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-08-12 23:11:28 +01:00
Michael Opdenacker
14c7cd24a5 manuals: improve the width of diagrams
Better for EPUB output in particular
- Make some diagrams wider when necessary
- Remove ":align: center" when we have ":width: 100%"
- Update the standards.md files to mention this

(From yocto-docs rev: 848ba7bd8984cc3f4bf6b818259865011cde0476)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10 12:52:35 +01:00
Michael Opdenacker
134da15e22 sdk-manual: overrides syntax updates
Updated with openembedded-core/scripts/contrib/convert-overrides.py

(From yocto-docs rev: 39cf6b2eb063815a3e2bf7a71ffd1fd6351cc594)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-14 12:04:23 +01:00
Robert P. J. Day
68e84ae936 sdk-manual: fix broken formatting of sample command
And add proper quoting around the first instance
of the "image" word, as it refers to a keyword in the
subsequent command.

(From yocto-docs rev: 1ffaa1db5a6eba53558b714f6071ea2e9bfe03e6)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-03 13:37:48 +01:00
Robert P. J. Day
73d317c393 sdk-manual: "beablebone" -> "beaglebone"
(From yocto-docs rev: 29d8b6f07dddba43cf14706ec26cc8cf033d1040)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-03 13:37:48 +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
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
Ulrich Ölmann
802ac0b75e sdk-manual: fix typo
(From yocto-docs rev: 5bde446a0335ccf7f3d772e1eef666aeb31eace3)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
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
a306baf850 Do not assume working from $HOME
In the "Yocto Project Quick Build" instructions
(https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#)
there is an inconsistency that impacts several documents...

People are first instructed to clone the poky git repository, but not
mentioning from which directory. Then, it's consistent to instruct
people to run "cd poky/".

However, later in the instructions, readers are instructed to run "cd
~/poky", which assumes that cloning poky was done from the home
directory. Many other places in the documentation make such an assumption.

This change fixes this, and makes no assumption on where people
have chosen to store their data, in particular where they cloned
the "poky" repository.

This also fixes a few whitespace issues.

(From yocto-docs rev: fd4e365c85df212d7ed70fc1abb3657a4a88b294)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-23 22:54:55 +00:00
Quentin Schulz
e6a0be545d docs: fix missing & and ; surrounding references from poky.yaml
poky.yaml references are only replaced in files if they are prefixed by
& and suffixed by ;.

Let's fix the missing surrounding characters.

(From yocto-docs rev: 7ee4ba7a27acd87d8c728639d1b053d2e26c6e58)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20 00:53:53 +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