[Intel-gfx] [PATCH 2/3] dim: Review subcommand docs

[Daniel Vetter]

On Mon, Mar 27, 2017 at 10:45:45AM +0200, Daniel Vetter wrote:
> Inspired by Jani's efforts to clean this up and structure it better.
> 
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>

Forgot to add in the commit message: This adds the doc for
update-next-continue.
-Daniel

> ---
>  dim.rst | 20 ++++++++++++++------
>  1 file changed, 14 insertions(+), 6 deletions(-)
> 
> diff --git a/dim.rst b/dim.rst
> index 2f8fda8c42a7..be541d80ec7e 100644
> --- a/dim.rst
> +++ b/dim.rst
> @@ -283,7 +283,9 @@ any changes with git add -u and continues the rebase.
>  apply-resolved
>  --------------
>  Compile-test the current tree and if successfully resolve a
> -confilicted git am. Also runs the patch checker afterwards.
> +conflicted git am. Also runs the patch checker afterwards.
> +
> +FIXME: Forgets to add the Link: tag.
>  
>  create-branch *branch* [*commit-ish*]
>  -------------------------------------
> @@ -299,9 +301,8 @@ Remove the given topic branch.
>  
>  create-workdir (*branch* | all)
>  -------------------------------
> -Create a separate workdir for the branch with the given name (requires that
> -git-new-workdir from git-core contrib is installed), or for all branches if
> -"all" is given.
> +Create a separate workdir for the branch with the given name, or for all
> +branches if "all" is given.
>  
>  for-each-workdir|fw *command*
>  -----------------------------
> @@ -313,8 +314,8 @@ COMMANDS FOR MAINTAINERS
>  
>  cherry-pick *commit-ish* [*git cherry-pick arguments*]
>  ------------------------------------------------------
> -Improved git cherry-pick version which also scans drm-tip picked, too. In
> -dry-run mode/-d only the patch list is generated.
> +Improved git cherry-pick version which also scans drm-tip for additional
> +cherry-pick candidates. In dry-run mode/-d only the patch list is generated.
>  
>  cherry-pick-fixes
>  -----------------
> @@ -366,6 +367,13 @@ opened.
>  Also checks that the drm-intel-fixes|-next-queued are fully
>  merged into drm-tip to avoid operator error.
>  
> +update-next-continue
> +--------------------
> +
> +When **update-next** fails to push the special release commit (because it raced with
> +another committer) rebase and push manually, and then continue using this
> +command.
> +
>  tag-next
>  --------
>  Pushes a new tag for the current drm-intel-next state after checking that the
> -- 
> 2.11.0
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch