linux/poky.git/documentation/ref-manual/devtool-reference.rst, branch yocto-4.1.2

manuals: replace hyphens with em dashes

2022-06-27T13:55:08+00:00

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 Signed-off-by: Richard Purdie

manuals: improve the width of diagrams

2022-05-10T11:52:35+00:00

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 Signed-off-by: Richard Purdie

ref-manual: update "devtool check-upgrade-status" output

2021-09-18T12:03:45+00:00

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 Signed-off-by: Richard Purdie

ref-manual: improve documentation for RECIPE_NO_UPDATE_REASON

2021-09-18T12:03:45+00:00

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 Signed-off-by: Richard Purdie

ref-manual: improve "devtool check-upgrade-status" details

2021-09-18T12:03:45+00:00

- 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 Reviewed-by: Alexander Kanavin Signed-off-by: Richard Purdie

ref-manual: remove mention of obsolete devtool "--any-recipe" option

2021-09-18T12:03:44+00:00

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 Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

ref-manual: render options in monospace to show quotes properly

2021-09-18T12:03:44+00:00

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 Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

ref-manual: simplify style

2021-05-22T11:16:40+00:00

(From yocto-docs rev: 657a7f54856afd6fec7f2cb0b5f12b4b2d24adb7) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: code insertion simplification over two lines

2021-04-23T15:39:03+00:00

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 Signed-off-by: Richard Purdie

docs: replace anchor links

2021-04-09T14:24:46+00:00

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 Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie