[PATCH] doc: clarify the target audience for the status command

Jani Nikula jani.nikula at linux.intel.com
Thu Jun 21 10:56:38 UTC 2018


On Thu, 21 Jun 2018, Liviu Dudau <Liviu.Dudau at arm.com> wrote:
> 'dim status' is intended to be used by maintainers and not by commiters.
> Move the description of the subcommand into the 'COMMANDS FOR MAINTAINERS'
> area and clarify in the COMMITERS area that they should use vanilla
> 'git status' for checking the health of the branch.
>
> Signed-off-by: Liviu Dudau <liviu.dudau at arm.com>
> ---
>  dim.rst | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
>
> diff --git a/dim.rst b/dim.rst
> index f7ca4ebdf0ebe..c24253b4d8cfb 100644
> --- a/dim.rst
> +++ b/dim.rst
> @@ -110,7 +110,8 @@ maintainers and committers pushed patches meanwhile.
>  
>  status
>  ------
> -Lists all branches with unmerged patches, and how many patches are unmerged.
> +This command is for maintainers use. Commiters that want to check the status
> +of their current branch should use normal **git status** commands.

Thanks for improving the documentation. However, please document the
command in one place only. I'm fine with either place, not both.

BR,
Jani.

>  
>  cd
>  --
> @@ -288,6 +289,13 @@ cherry-pick them to drm-intel-fixes or drm-intel-next-fixes. These commands use
>  dim cherry-pick internally to make sure bugfixes for fixes are cherry-picked
>  too.
>  
> +status
> +------
> +Lists all branches with unmerged patches, and how many patches are unmerged. It
> +will show how the overall subsystem tree looks like and where patches waiting to
> +be merged have been added, in order to help maintainers with deciding which tree
> +is in need of a pull request.
> +
>  pull-request *branch* *upstream*
>  --------------------------------
>  Fetch the *upstream* remote to make sure it's up-to-date, create and push a date

-- 
Jani Nikula, Intel Open Source Graphics Center


More information about the dim-tools mailing list