summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual
Commit message (Collapse)AuthorAgeFilesLines
* overview-manual: concepts: add details on package splittingAntonin Godard2024-11-021-5/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | | The package splitting section of the overview manual currently lacks any explanation of how package splitting is implemented and redirects to the package class, which is not really understandable for newcomers to the project. This patch adds a short explanation of what is done: * How the PACKAGES variable is defined. * How the FILES variable is defined. * How the two work together. * How to add a custom package. This should give enough details to a new user on what package splitting achieves and how to add a custom package. Adresses [YOCTO #13225] Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: ef4150029d377ce1c35645971502ae56345915a6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 143c3cacdec36c9d7ab81c89bbcc12c0c3936bd9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: fix trailing spacesMichael Opdenacker2024-04-191-1/+1
| | | | | | | | | Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: 45b04c281a567e06fd2904166bcc26603e73e684) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: replace hyphens with em dashesMichael Opdenacker2024-03-253-5/+5
| | | | | | | | | | | | | | | | | | | | Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: a0d93ea1ddfdfbcde8dac3aa328307be778f9e3c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: variables: correct sdk installation default pathJohan Bezem2024-03-251-1/+1
| | | | | | | | | | | | | | | | | | The SDKPATH variable seems mistakenly identified as the default path where the SDK will be installed by the generated installation script, unless option '-d' or a manual input overrides this default. The intended variable is SDKPATHINSTALL. SDKPATH indicates where the SDK is being composed and built. The definitions have been added/updated. (From yocto-docs rev: f7ce2abbdcff625356b337137e91f642ff6a4dc2) Signed-off-by: Johan Bezem <jbezem.extern@arri.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: updates for building on Windows (WSL 2)Michael Opdenacker2024-03-011-11/+6
| | | | | | | | | | | | | - Use the Wikipedia naming scheme: WSL 2 instead of WSLv2 - Take into account Windows Server 2019 and 2022 which are supported too. - Improve some explanations (From yocto-docs rev: e64c1154c358128d76b1b8e3a5809dbaa8dc6881) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: suppress excess use of "following" wordMichael Opdenacker2024-03-012-13/+12
| | | | | | | | | | | | | | | | | | 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: 2539f1b9cbf9bdd40eff93c6522dc76133debed7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Daniel Ammann <daniel.ammann@bytesatwork.ch> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: document VSCode extensionEnguerrand de Ribaucourt2024-01-242-0/+28
| | | | | | | | | | | | | | | | The VSCode extension is now officially maintained and published by the Yocto Project so it should be referenced in the manuals to help users discover it. I located the most relevant places to reference the extension by looking at how the old Eclipse plugin was documented in the 2.6 manuals as well as the current Toaster references. (From yocto-docs rev: 21ec0d3b52069dfc85ff47fb4f913a26a092c480) Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: update class referencesMichael Opdenacker2023-11-281-1/+1
| | | | | | | | | | Synchronizing with master whenever possible, to make the branch easier to maintain. (From yocto-docs rev: 825b1292ab08770b2d8cfdc1e11358a2790c1a1b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* overview-manual: concepts: Add Bitbake Tasks MapBELHADJ SALEM Talel2023-11-282-0/+174
| | | | | | | | | | | Create a Map to detail how BitBake handles a recipe's tasks and its compile/runtime dependencies along with detailed comments. (From yocto-docs rev: 529c7bf6c434166f4d372166868d46f275eb5bea) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* overview: Add note about non-reproducibility side effectsJoshua Watt2023-10-181-0/+9
| | | | | | | | | | | Adds an additional note about some of the side effects that can occur if recipes are not reproducible and hash equivalence is enabled. (From yocto-docs rev: aaf3e97c78e235bf3042c79ecdcf0b7c1a68ca8f) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: update former references to dev-manual/common-tasksMichael Opdenacker2023-09-233-18/+18
| | | | | | | (From yocto-docs rev: f8bb4c392912f15bb78f6f25910f85897abb4e3d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: add new contributor guideMichael Opdenacker2023-09-081-10/+9
| | | | | | | (From yocto-docs rev: 028a1b89fbb6ee7f02a7ca8cd481931e096d764b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* overview-manual: concepts.rst: Fix a typoDaniel Ammann2023-05-301-1/+1
| | | | | | | | (From yocto-docs rev: 8241867b565310341e4741a5f0a7597d5c5c84ab) Signed-off-by: Daniel Ammann <daniel.ammann@bytesatwork.ch> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: update patchwork instance URLMichael Opdenacker2023-02-151-1/+1
| | | | | | | | | | | https://patchwork.openembedded.org/ has been since long discontinued Also better to mention https://patchwork.yoctoproject.org/ than the patchwork home page. (From yocto-docs rev: e7dcd04a1a4f6db42e7469226623016dccd2186d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix quoting of double dashesMichael Opdenacker2022-03-311-2/+2
| | | | | | | | | | | | | | | | | | | Otherwise rendered as "en" dashes by sphinx, for example: git pull –rebase instead of git pull --rebase Readers could confuse them with normal dashes. Exception: replace by \-\- in italic text (*text*) as Sphinx cannot nest italic and quoted text. For consistency, also update quoting in strings in the same code hunks. (From yocto-docs rev: 4e7ce372e37f76148f623a5295a15e08bc2603ff) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: add missing upper caseMichael Opdenacker2022-03-311-1/+1
| | | | | | | (From yocto-docs rev: 9de52ac713c89e3e7023148889c234d4ec4c6246) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Fix referenceDaniel Ammann2022-03-311-1/+1
| | | | | | | | (From yocto-docs rev: 623bcfc66f42c334963bf51c262ef2fc5f9bbd91) Signed-off-by: Daniel Ammann <daniel.ammann@bytesatwork.ch> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: Drop POKYVERSION and YOCTO_POKY referencesRichard Purdie2022-03-211-1/+1
| | | | | | | | | | | | | | We don't publish tarballs using this version any more, it has been removed everywhere. Remove the obsolete references in the docs, adapting references accordingly. The tarballs now are just created with their sha256 checksum which we don't want or need to reference in the docs. (From yocto-docs rev: c7a0ac88b01c48f3d9209536542bf43ae7a7937f) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: inclusive language updatesMichael Opdenacker2022-03-161-4/+4
| | | | | | | | | | | | | Changes identified by OE core's scripts/contrib/convert-variable-renames.py script Original variable names are kept in old migration notes, but references to the new ones are provided. (From yocto-docs rev: 1a35380ca80509fee036018a2bbb22ba9b44d47a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: overview-manual: formating fixesMichael Opdenacker2022-03-161-7/+2
| | | | | | | | (From yocto-docs rev: c17eb6bb35053ad89e52d41c7da75ccbc3823d1b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: remove references to prelink supportMichael Opdenacker2022-03-042-38/+3
| | | | | | | | | | Fixing documentation and updating examples containing "prelink" in their output. (From yocto-docs rev: 8927b8fff55fac1bd1fefcff2d16141dbd1ebc51) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix hardcoded link warning messagesQuentin Schulz2022-02-231-2/+2
| | | | | | | | | | | | | | Sphinx complains about hardcoded links which can be replaced by an extlink. So let's apply its recommendations. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: dc2ec13cfbe0f20a868108a0bd800c0a875c1796) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Remove unnecessary \n from SSTATE_MIRRORS examplesPeter Kjellerstedt2022-02-201-1/+1
| | | | | | | | | | | | Since commit 044fb04d in bitbake (fetch2: Allow whitespace only mirror entries) there is no need to separate the entries in SSTATE_MIRRORS with "\n". (From yocto-docs rev: 87b34b69b2df72d4e6edbd81839622fffd560331) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: propose https for SSTATE_MIRRORSMichael Opdenacker2022-02-031-1/+1
| | | | | | | | | | Both http and https work, but https should raise fewer questions from users. (From yocto-docs rev: e3bf892b1328b5c43ab041ba6c850e2782f54bdf) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document hash equivalenceMichael Opdenacker2022-01-101-0/+132
| | | | | | | (From yocto-docs rev: 7fad0873207980a747f79b2ce29ec0dc6c6c3cdf) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: fix typoMichael Opdenacker2022-01-071-1/+1
| | | | | | | (From yocto-docs rev: 595d3e77855aeed31537a5e58a4426d7cc0b21f5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* make the documentation a bit more inclusiveQuentin Schulz2021-12-133-33/+24
| | | | | | | | | | | | | | | 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>
* misc manuals: add further class referencesMichael Opdenacker2021-12-131-1/+1
| | | | | | | (From yocto-docs rev: 0693f1f8466a118dc707a9c17d5ca528b4ea368a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: simplify expressionMichael Opdenacker2021-10-081-1/+1
| | | | | | | (From yocto-docs rev: ea1e5d4214f30927119f0124ee8a80a558601161) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: SVG diagram for the git workflowMichael Opdenacker2021-10-083-2/+1207
| | | | | | | | | | | | 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>
* manuals: font fixesMichael Opdenacker2021-10-081-1/+1
| | | | | | | | | | | | | | 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>
* overview-manual: delete bad backslashes in SSTATE_MIRRORS exampleRobert P. J. Day2021-10-021-2/+2
| | | | | | | | | | | | | 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>
* manuals: delete unmaintained history sectionsMichael Opdenacker2021-09-182-29/+0
| | | | | | | | | | | | 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>
* docs: overview-manual: concepts: remove long-gone BBHASHDEPS variableQuentin Schulz2021-08-141-3/+0
| | | | | | | | | | | | | | 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>
* docs: fix new override syntax migrationQuentin Schulz2021-08-142-3/+3
| | | | | | | | | | 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>
* manuals: remove explicit BitBake variable referencesMichael Opdenacker2021-07-301-4/+2
| | | | | | | | | | | | | 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>
* manuals: simplify references to BitBake manualMichael Opdenacker2021-07-301-3/+3
| | | | | | | | | | | | | 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>
* docs: replace remaining ``FOO`` by :term:`FOO`Quentin Schulz2021-07-161-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* manuals: fix issues related to trailing dotsMichael Opdenacker2021-06-192-7/+3
| | | | | | | | | | | | | 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>
* docs: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-06-191-36/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* overview-manual: simplify style and add missings referencesMichael Opdenacker2021-05-223-53/+46
| | | | | | | (From yocto-docs rev: 4a07947dbe0dd70fd1d528a207d663dfdca2b7c1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: reduce verbosity related to "the following" expressionMichael Opdenacker2021-05-132-13/+9
| | | | | | | (From yocto-docs rev: da9d1cfb5c084d172eff3cb10ec3631dd8266260) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: code insertion simplification over two linesMichael Opdenacker2021-04-232-38/+19
| | | | | | | | | | | | | | | 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>
* overview-manual: fix git command linePaul Eggleton2021-04-151-1/+1
| | | | | | | | | | | | 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>
* docs: replace anchor linksQuentin Schulz2021-04-094-79/+87
| | | | | | | | | | | | | | | | | | 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>
* manuals: fix suspicious newlinesMichael Opdenacker2021-04-062-14/+9
| | | | | | | | | | - 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>
* overview-manual: style improvementsMichael Opdenacker2021-04-061-26/+28
| | | | | | | | | | - 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>
* manuals: Fix typos and spacingMichael Opdenacker2021-04-061-8/+8
| | | | | | | | | | 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>
* documentation: Use https links where possiblePaul Barker2020-12-242-13/+13
| | | | | | | (From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Simplify remaining yocto_home linksPaul Barker2020-12-241-9/+6
| | | | | | | (From yocto-docs rev: e0151e039f96c1548e2ec39ae24d4b0276f49434) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-08-04 13:21:37 +0000