mbox series

[yocto-docs,v3,0/2] Move devtool doc from extensible to dev manual

Message ID 20250127-devtool-dev-manual-v3-0-0e7ed17cfde4@bootlin.com
Headers show
Series Move devtool doc from extensible to dev manual | expand

Message

Antonin Godard Jan. 27, 2025, 9:58 a.m. UTC
As described in https://bugzilla.yoctoproject.org/show_bug.cgi?id=13417,
the devtool documentation is not really coupled to the extensible SDK,
and so documentation for it could be part of its own manual in the
dev-manual.

The first patch of the series moves the documentation from
sdk-manual/extensible.rst to dev-manual/devtool.rst. The second patch
removes some reference to the eSDK in the manual which no longer apply
within this new context.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Changes in v3:
- Also move the ide-sdk section of the extensible document, after
  rebasing on Adrian's changes to this section to make it non-related to
  the extensible sdk directly.
- Link to v2: https://lore.kernel.org/r/20250102-devtool-dev-manual-v2-0-db3fcb81b938@bootlin.com

Changes in v2:
- forgot to fix some references to titles in the previous version, fixed
  them in this v2.
- Link to v1: https://lore.kernel.org/r/20241224-devtool-dev-manual-v1-0-0cc4fb584018@bootlin.com

---
Antonin Godard (2):
      Move devtool doc from extensible to dev manual
      dev-manual/devtool: remove reference to the extensible SDK

 documentation/dev-manual/devtool.rst               | 1322 +++++++++++++++++++
 .../figures/devtool-add-flow.png}                  |  Bin
 .../figures/devtool-modify-flow.png}               |  Bin
 .../figures/devtool-upgrade-flow.png}              |  Bin
 documentation/dev-manual/index.rst                 |    1 +
 documentation/dev-manual/new-recipe.rst            |    2 +-
 documentation/dev-manual/upgrading-recipes.rst     |    2 +-
 documentation/migration-guides/migration-2.1.rst   |    2 +-
 documentation/overview-manual/concepts.rst         |    2 +-
 documentation/ref-manual/devtool-reference.rst     |    2 +-
 documentation/ref-manual/variables.rst             |    2 +-
 documentation/sdk-manual/extensible.rst            | 1323 +-------------------
 documentation/what-i-wish-id-known.rst             |    2 +-
 13 files changed, 1333 insertions(+), 1327 deletions(-)
---
base-commit: 287817f33688d61f7a71c056bfa5c645edb4fc4e
change-id: 20241223-devtool-dev-manual-bb387251f9be

Best regards,