| Message ID | 20241022-devtool-improvements-v2-0-9d2ebf9c5311@bootlin.com |
|---|---|
| Headers | show |
| Series | Update the devtool quick reference document | expand |
Hi Quentin, On Tue Oct 22, 2024 at 10:37 AM CEST, Antonin Godard wrote: > * Refresh command outputs from `devtool --help` and `devtool add > --help`. > * Add some brief details on the subcommands that were previously > undocumented, and the more recent commands that weren't documented > yet. > * The remaining subcommands are still present in devtool, so leave them > as-is. > > Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> > --- > Changes in v2: > - configure-help: Give an example of what the command will output for. > - ide-sdk: mention that like deploy-target an ssh server must be running > on the target. > - Link to v1: https://lore.kernel.org/r/20241017-devtool-improvements-v1-0-2bacc656fe39@bootlin.com What do you think of this v2? I took note of your suggestions and added them here. Thanks in advance, Antonin -- Antonin Godard, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
Hi Antonin, On 10/28/24 2:54 PM, Antonin Godard wrote: > Hi Quentin, > > On Tue Oct 22, 2024 at 10:37 AM CEST, Antonin Godard wrote: >> * Refresh command outputs from `devtool --help` and `devtool add >> --help`. >> * Add some brief details on the subcommands that were previously >> undocumented, and the more recent commands that weren't documented >> yet. >> * The remaining subcommands are still present in devtool, so leave them >> as-is. >> >> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> >> --- >> Changes in v2: >> - configure-help: Give an example of what the command will output for. >> - ide-sdk: mention that like deploy-target an ssh server must be running >> on the target. >> - Link to v1: https://lore.kernel.org/r/20241017-devtool-improvements-v1-0-2bacc656fe39@bootlin.com > > What do you think of this v2? > Looking good. I'm a bit wary of giving my Reviewed-by on things I've never used though. This looks like valid Sphinx and English to me, so that's how far I can go for this review :) Cheers, Quentin
Hi Quentin, On Mon Oct 28, 2024 at 3:27 PM CET, Quentin Schulz wrote: > Hi Antonin, > > On 10/28/24 2:54 PM, Antonin Godard wrote: >> Hi Quentin, >> >> On Tue Oct 22, 2024 at 10:37 AM CEST, Antonin Godard wrote: >>> * Refresh command outputs from `devtool --help` and `devtool add >>> --help`. >>> * Add some brief details on the subcommands that were previously >>> undocumented, and the more recent commands that weren't documented >>> yet. >>> * The remaining subcommands are still present in devtool, so leave them >>> as-is. >>> >>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> >>> --- >>> Changes in v2: >>> - configure-help: Give an example of what the command will output for. >>> - ide-sdk: mention that like deploy-target an ssh server must be running >>> on the target. >>> - Link to v1: https://lore.kernel.org/r/20241017-devtool-improvements-v1-0-2bacc656fe39@bootlin.com >> >> What do you think of this v2? >> > > Looking good. I'm a bit wary of giving my Reviewed-by on things I've > never used though. > > This looks like valid Sphinx and English to me, so that's how far I can > go for this review :) > > Cheers, > Quentin Thanks for the review! And I'll add the `ref-classes-autotools` suggestion from the other mail. Cheers, Antonin -- Antonin Godard, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
* Refresh command outputs from `devtool --help` and `devtool add --help`. * Add some brief details on the subcommands that were previously undocumented, and the more recent commands that weren't documented yet. * The remaining subcommands are still present in devtool, so leave them as-is. Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- Changes in v2: - configure-help: Give an example of what the command will output for. - ide-sdk: mention that like deploy-target an ssh server must be running on the target. - Link to v1: https://lore.kernel.org/r/20241017-devtool-improvements-v1-0-2bacc656fe39@bootlin.com --- Antonin Godard (2): ref-manual: devtool-reference: refresh example outputs ref-manual: devtool-reference: document missing commands documentation/ref-manual/devtool-reference.rst | 72 ++++++++++++++++++++++---- 1 file changed, 61 insertions(+), 11 deletions(-) --- base-commit: e4b64514673471850635a8dbbf62f34e710e276a change-id: 20241017-devtool-improvements-68a7c869e2b4 Best regards,