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

[Jani Nikula]

On Mon, 27 Mar 2017, Daniel Vetter <daniel.vetter at ffwll.ch> wrote:
> Inspired by Jani's efforts to clean this up and structure it better.
>
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>
> ---
>  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.

Please either change this to "This fails to add the Link: tag, so you'll
need to add it manually or use the **add-link** subcommand." or similar,
or add the FIXME comment in dim source, or both. I don't much like FIXME
comments in documentation.

Otherwise lgtm.

BR,
Jani.

>  
>  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

-- 
Jani Nikula, Intel Open Source Technology Center