Re: [PATCH v2 2/2] ref-manual: devtool-reference: document missing commands

[Quentin Schulz <quentin.schulz@cherry.de>]

Hi Antonin,

On 10/22/24 10:37 AM, Antonin Godard wrote:
> Give a brief description for important commands that made it into
> devtool or that were missing from this quick reference document.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/devtool-reference.rst | 54 ++++++++++++++++++++++++++
>   1 file changed, 54 insertions(+)
> 
> diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
> index 9c36195c5a5a2405cf8e3a562a2a53291e97c859..4862350f92781c80187a951f149ac2e5ef273510 100644
> --- a/documentation/ref-manual/devtool-reference.rst
> +++ b/documentation/ref-manual/devtool-reference.rst
> @@ -463,6 +463,20 @@ Here is an example that resets the workspace directory that contains the
>      NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer need it then please delete it manually
>      $
>   
> +.. _devtool-finish-working-on-a-recipe:
> +
> +Finish Working on a Recipe
> +==========================
> +
> +Use the ``devtool finish`` command to push any committed changes to the
> +specified recipe in the specified layer and remove it from your workspace.
> +
> +This is roughly equivalent to the ``devtool update-recipe`` command followed by
> +the ``devtool reset`` command. The changes must have been committed to the git
> +repository created by ``devtool``. Here is an example::
> +
> +  $ devtool finish recipe /path/to/custom/layer
> +
>   .. _devtool-building-your-recipe:
>   
>   Building Your Recipe
> @@ -614,3 +628,43 @@ a match.
>   
>   When you use the ``devtool search`` command, you must supply a keyword.
>   The command uses the keyword when searching for a match.
> +
> +Alternatively, the ``devtool find-recipe`` command can be used to search for
> +recipe files instead of recipe names. Likewise, you must supply a keyword.
> +
> +.. _devtool-get-the-configure-script-help:
> +
> +Get Information on Recipe Configuration Scripts
> +===============================================
> +
> +Use the ``devtool configure-help`` command to get help on the configuration
> +script options for a given recipe. You must supply the recipe name to the
> +command. For example, it shows the output of ``./configure --help`` for
> +``autotools``-based recipes.

suggestion: maybe use :ref:`classes-autotools` here?

Cheers,
Quentin