linux/poky.git/documentation/sdk-manual, branch 5.2_M3

Move devtool doc from extensible to dev manual

2025-02-07T17:52:48+00:00

[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 (From yocto-docs rev: 044d3185b858fce1febcfe3a6834b883f9a598fa) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

sdk-manual: extensible.rst: devtool ide-sdk improve

2025-01-29T10:41:59+00:00

The devtool ide-sdk section is reformulated to be independent of the eSDK installer. In fact, ide-sdk does not even support the execution of an installer-based setup. This reformulation is also a preparation for moving the devtool documentation to a dedicated devtool section which is independent from the eSDK documentation. It should be clarified that devtool ide-sdk starts the SDK directly from the bitbake environment. It is therefore an alternative to bitbake -c populate_sdk_ext and installing an SDK installer. A warning is added that explains some workarounds for some nasty behavior of VSCode when running it in a bitbake environment. (From yocto-docs rev: 287817f33688d61f7a71c056bfa5c645edb4fc4e) Signed-off-by: Adrian Freihofer Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

sdk-manual: extensible.rst: remove confusing post-install-logging

2025-01-20T13:45:06+00:00

This is a fix for 22dc5b3be3b1fbdb9447999b71f79db055271826, which has completely replaced debug-tweaks. But in the context of devtool ide-sdk and the comment in the example, the post-install-logging-image feature doesn't really make much sense. Therefore, remove it. (From yocto-docs rev: 148191460627241cbd0c42583140f114c78cc94c) Signed-off-by: Adrian Freihofer Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

sdk-manual: extensible.rst: update devtool ide-sdk

2025-01-20T13:45:06+00:00

Replace devtool ide-sdk --debug-build-config by devtool modify --debug-build This change was introduced with commit https://git.yoctoproject.org/poky/commit/?id=1f7eb26c947dde14698ae6e2ab88f0637027f4cb (From yocto-docs rev: e2b6a4c6c633e79d0e4975ba2e1a27a8c1b8c1c5) Signed-off-by: Adrian Freihofer Reviewed-by: Quentin Schulz Reviewed-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

Remove debug-tweaks references

2024-12-28T10:57:47+00:00

We no longer provide this feature, so remove documentation for it. In most cases, we can replace occurrences of "debug-tweaks" by "allow-empty-password empty-root-password allow-root-login post-install-logging" to achieve what this feature previously enabled. Subtle, but the default local.conf does not include post-install-logging, so in parts where there is mention of the default local.conf file, adjust the documentation to only mention the first three above. In the intro manual, instead of providing instructions that replace EXTRA_IMAGE_FEATURES entirely, provide ones that append EXTRA_IMAGE_FEATURES. (From yocto-docs rev: f0efd4c7df91863304b92514664bdd1fa62b1fbb) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

manuals: remove tab characters

2024-04-12T16:29:34+00:00

As reported by "make sphinx-lint" Tabs are even removed in Makefile examples, as Sphinx turns them to spaces anyway in the generated output. (From yocto-docs rev: 20e9c0c9fad3109567948af6bc40bb0fa2a5552b) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

sdk-manual: correctly describe separate build-sysroots tasks in direct sdk workflows

2024-03-19T15:22:27+00:00

They were separated in https://git.yoctoproject.org/poky/commit/?id=63e53fb8b60d38315015844bd3357fa1649cd639 (From yocto-docs rev: b880ac9498764027de435103d493f34adf68dc13) Signed-off-by: Alexander Kanavin Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

sdk-manual: extensible.rst: cover devtool ide-sdk

2024-02-24T16:13:29+00:00

Cover the new devtool ide plugin in the extensible sdk section. Many thanks to Enguerrand de Ribaucourt for his re-view and contributions. (From yocto-docs rev: d318cc41e0600ca8e18bc6789cac414ae0226a07) Signed-off-by: Adrian Freihofer Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: suppress excess use of "following" word

2024-02-24T16:13:28+00:00

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

sdk-manual: appendix-obtain: improve and update descriptions

2023-10-20T13:40:29+00:00

- Improve text formatting - Stop mentioning all possible values - Update examples - Correct descriptions (From yocto-docs rev: f7437c2efa1014dc46481993b5e87d52dcf42b05) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie