mbox series

[v2,0/2] Move devtool doc from extensible to dev manual

Message ID 20250102-devtool-dev-manual-v2-0-db3fcb81b938@bootlin.com
Headers show
Series Move devtool doc from extensible to dev manual | expand

Message

Antonin Godard Jan. 2, 2025, 9:40 a.m. UTC
[ YOCTO #13417 ]

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/index.rst. The second patch
removes some reference to the eSDK in the manual which no longer apply
within this new context.

This series depends on:
https://lore.kernel.org/r/20241223-devtool-deploy-target-v1-1-ee00beb47691@bootlin.com

Signed-off-by: Antonin Godard <antonin.godard@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               | 954 ++++++++++++++++++++
 .../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/sdk-manual/extensible.rst            | 959 +--------------------
 6 files changed, 960 insertions(+), 954 deletions(-)
---
base-commit: 4b904539d05fdac123ed96c3952613fbbe612c39
change-id: 20241223-devtool-dev-manual-bb387251f9be
prerequisite-change-id: 20241223-devtool-deploy-target-27d9f6e8a250:v1
prerequisite-patch-id: d3a98c5a92ce8ed4945595df218769028f552057

Best regards,

Comments

Adrian Freihofer Jan. 9, 2025, 9:55 p.m. UTC | #1
Hi Antonin

Please keep the documentation of devtool ide-sdk together with the
other commands of devtool. See also my more detailed comment here:
https://bugzilla.yoctoproject.org/show_bug.cgi?id=13417#c5

Thank you
Adrian

On Thu, 2025-01-02 at 10:40 +0100, Antonin Godard via
lists.yoctoproject.org wrote:
> [ YOCTO #13417 ]
> 
> 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/index.rst. The second patch
> removes some reference to the eSDK in the manual which no longer
> apply
> within this new context.
> 
> This series depends on:
> https://lore.kernel.org/r/20241223-devtool-deploy-target-v1-1-ee00beb47691@bootlin.com
> 
> Signed-off-by: Antonin Godard <antonin.godard@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               | 954
> ++++++++++++++++++++
>  .../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/sdk-manual/extensible.rst            | 959 +----------
> ----------
>  6 files changed, 960 insertions(+), 954 deletions(-)
> ---
> base-commit: 4b904539d05fdac123ed96c3952613fbbe612c39
> change-id: 20241223-devtool-dev-manual-bb387251f9be
> prerequisite-change-id: 20241223-devtool-deploy-target-
> 27d9f6e8a250:v1
> prerequisite-patch-id: d3a98c5a92ce8ed4945595df218769028f552057
> 
> Best regards,
> 
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#6051):
> https://lists.yoctoproject.org/g/docs/message/6051
> Mute This Topic: https://lists.yoctoproject.org/mt/110386509/4454582
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe:
> https://lists.yoctoproject.org/g/docs/unsub [adrian.freihofer@gmail.com
> ]
> -=-=-=-=-=-=-=-=-=-=-=-
>