summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/devtool-reference.rst
Commit message (Collapse)AuthorAgeFilesLines
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-05-261-1/+1
| | | | | | | | | | | | | | | | Fix as many instances of unbalanced-inline-literals-delimiters as reported by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped up randomly when references contain links to a heading which contain literals enclosed in double-back-tics; especially in the cases where a heading either contains multiple literals or when the literal is not at the end of the heading. Not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 3460177c46d360b0f2f852cdab23f21bd4ec6d5a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Move devtool doc from extensible to dev manualAntonin Godard2025-02-071-1/+1
| | | | | | | | | | | | | | | | | | | | [YOCTO #13417] devtool is not directly tied to the Extensible SDK anymore, and instructions in there can be split and added to the development manual. This patch is a simple bulk move, except for the following: - Intro added to the devtool.rst document (mostly copy-pasted from the devtool quick reference in the ref-manual). - Figures renamed to remove "sdk-" from filenames. - References to sdk-manual/extensible replaced by dev-manual/devtool. Reported-By: Paul Eggleton <bluelightning@bluelightning.org> (From yocto-docs rev: 044d3185b858fce1febcfe3a6834b883f9a598fa) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/devtool-reference: add warning note on deploy-target and shared ↵Antonin Godard2025-01-091-0/+20
| | | | | | | | | | | | | | | | | | | | | | objects The command `devtool deploy-target` does not handle any dependency of the application, even when properly listed in DEPENDS or RDEPENDS. While the current documentation was clear on that, it felt needed to add a note on the fact that build-time dependencies may also result in runtime dependencies, especially for people new to the project. Add a warning block below the existing deploy-target documentation. Also, link to the Overview and Concepts page, which explains it thoroughly. [ YOCTO #14377 ] Reported-By: Robert Berger <pokylinux@reliableembeddedsystems.com> (From yocto-docs rev: 56c84004daad5f8a5db53e36852331435d57c8af) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: devtool-reference: document missing commandsAntonin Godard2024-10-311-0/+54
| | | | | | | | | | Give a brief description for important commands that made it into devtool or that were missing from this quick reference document. (From yocto-docs rev: 6238adae1b072c9e09c558038d397dfac6ec109f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: devtool-reference: refresh example outputsAntonin Godard2024-10-311-11/+7
| | | | | | | | | | Previous outputs were missing some commands and options, some others were obsolete. (From yocto-docs rev: 1c83037707b4c981a70c968ba04ded502f9bffbf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: suppress excess use of "following" wordMichael Opdenacker2024-02-241-2/+2
| | | | | | | | | | | | | | | | | | 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>
* manuals: simplify references to the BitBake User ManualMichael Opdenacker2023-03-201-1/+1
| | | | | | | | | | | | | | | | | | | | - Replacing :ref:`bitbake:bitbake-user-manual/...` by :ref:`bitbake-user-manual/...` Adding "bitbake:" as a prefix is not necessary as there is no naming conflict between the YP and the BitBake manuals (all documents are in "bitbake-user-manual/") - Explaining the rules in the README file - When necessary, fixing line length in the modified paragraphs. (From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: improve "devtool check-upgrade-status" explanationsMichael Opdenacker2023-02-101-8/+11
| | | | | | | | | | - Fix broken link to a .bb file - Clarify the explanations (From yocto-docs rev: 937ef39cb4d04da388b1945d741820089daa2780) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix double colonsMichael Opdenacker2022-12-181-5/+2
| | | | | | | | | | | | | | | 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>
* manuals: split dev-manual/common-tasks.rstMichael Opdenacker2022-12-011-2/+2
| | | | | | | | | | | | | | A 500 KB source file is always harder to manage, and can have section title conflicts. So, the "Common Tasks" document is gone and all its constituents are moved up one level. You now have 40 chapters in the Development Tasks Manual. (From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace hyphens with em dashesMichael Opdenacker2022-06-271-1/+1
| | | | | | | | | | | | | | | | | | | 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: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: improve the width of diagramsMichael Opdenacker2022-05-101-2/+1
| | | | | | | | | | | | 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>
* ref-manual: update "devtool check-upgrade-status" outputMichael Opdenacker2021-09-181-9/+6
| | | | | | | | | | | This command now uses "INFO" insted of "NOTES" and output information in columns. Also good to show more recent versions of recipes. (From yocto-docs rev: d875083150ac30b884d823e9f0f568d3a92ddcc1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: improve documentation for RECIPE_NO_UPDATE_REASONMichael Opdenacker2021-09-181-9/+4
| | | | | | | | | | | This add a description of this variable to the variable index, and clarifies the explanations given in the devtool reference section. (From yocto-docs rev: 034b976addd0db6da31c4bacdbea21f2d47c00dc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: improve "devtool check-upgrade-status" detailsMichael Opdenacker2021-09-181-9/+27
| | | | | | | | | | | | | - Mention "devtool latest-version recipe" to process a single version - Explain that the mechanism is controlled by the UPSTREAM_CHECK* variables, which are not referred to anywhere else in the manuals, except in the variable index. (From yocto-docs rev: eded237f1a1ec7df3f9910242bfa4b3818ff3e58) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Alexander Kanavin <alex.kanavin@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove mention of obsolete devtool "--any-recipe" optionRobert P. J. Day2021-09-181-4/+1
| | | | | | | | | | | | | | Running "devtool edit-recipe -h" produces, in part, the output: --any-recipe, -a Does nothing (exists for backwards-compatibility) so it seems of little value to continue referring to it. (From yocto-docs rev: fdac1da045e60d37025f754c9b6be5bb36f31c86) 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>
* ref-manual: render options in monospace to show quotes properlyRobert P. J. Day2021-09-181-2/+2
| | | | | | | | | | | It's important (at least for now) to mark up options with monospaced font to highlight the difference between single and double quotes. (From yocto-docs rev: 8d71ffdd3f354747dcade6de512355e8fa567728) 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>
* ref-manual: simplify styleMichael Opdenacker2021-05-221-5/+5
| | | | | | | (From yocto-docs rev: 657a7f54856afd6fec7f2cb0b5f12b4b2d24adb7) 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-231-34/+17
| | | | | | | | | | | | | | | 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>
* docs: replace anchor linksQuentin Schulz2021-04-091-2/+2
| | | | | | | | | | | | | | | | | | 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>
* docs: fix missing & and ; surrounding references from poky.yamlQuentin Schulz2021-01-201-4/+4
| | | | | | | | | | | | 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>
* ref-manual: remove 'ref' from filenamesNicolas Dechesne2020-12-091-0/+631
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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-06-16 00:40:24 +0000