[PATCH] docs: More links to the conflict resolution howto

[Jani Nikula]

On Thu, 26 Apr 2018, Daniel Vetter <daniel.vetter at ffwll.ch> wrote:
> It's a bit a FAQ, and good excuse to use native sphinx links (now that
> we do/will use sphinx for everything).
>
> Cc: Jani Nikula <jani.nikula at intel.com>
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>
> ---
>  dim.rst          | 6 ++++--
>  drm-tip.rst      | 2 ++
>  repositories.rst | 5 ++---
>  3 files changed, 8 insertions(+), 5 deletions(-)
>
> diff --git a/dim.rst b/dim.rst
> index f7ca4ebdf0eb..8e8a699bc1b9 100644
> --- a/dim.rst
> +++ b/dim.rst
> @@ -178,7 +178,8 @@ push-branch branch [*git push arguments*]
>  -----------------------------------------
>  Updates the named branch. Complains if that's not the current branch, assuming
>  that patches got merged to the wrong branch. After pushing also updates
> -linux-next and drm-tip branches.
> +linux-next and drm-tip branches. If there's a conflict see section on
> +:ref:`resolving-integration-conflicts`.

Alas I think these will still fail the rst2html check. I think we'll
want the two man pages (dim.rst and qf.rst) to work with plain rst2html
to be able to render them standalone from 'dim help'.

I did struggle with linking both ways myself. I'm not sure what the
right solution would be in the end. Requiring Sphinx or pre-built man
pages seems a bit heavy for what has worked so nicely and lightly so
far.

BR,
Jani.


>  
>  push-fixes [*git push arguments*]
>  ---------------------------------
> @@ -197,7 +198,8 @@ push [*git push arguments*]
>  
>  rebuild-tip
>  -----------
> -Rebuild and push the integration tree.
> +Rebuild and push the integration tree. If there's a conflict see section on
> +:ref:`resolving-integration-conflicts`.
>  
>  ADVANCED COMMANDS FOR COMMITTERS AND MAINTAINERS
>  ================================================
> diff --git a/drm-tip.rst b/drm-tip.rst
> index 133ef1699b92..1377ad154451 100644
> --- a/drm-tip.rst
> +++ b/drm-tip.rst
> @@ -20,6 +20,8 @@ resolution for merging the branches on drm-tip rebuild.
>  
>  .. _nightly.conf: https://cgit.freedesktop.org/drm/drm-tip/plain/nightly.conf?h=rerere-cache
>  
> +.. _resolving-integration-conflicts:
> +
>  Resolving Conflicts when Rebuilding drm-tip
>  ===========================================
>  
> diff --git a/repositories.rst b/repositories.rst
> index 44009656d5b2..715c2304cd74 100644
> --- a/repositories.rst
> +++ b/repositories.rst
> @@ -158,9 +158,8 @@ drm-tip
>  
>  This is the overall integration tree for drm, and lives in
>  ``git://anongit.freedesktop.org/drm-tip``. Every time one of the above branches
> -is updated drm-tip gets rebuilt. If there's a conflict see section on `resolving
> -conflicts when rebuilding drm-tip
> -<drm-tip.html#resolving-conflicts-when-rebuilding-drm-tip>`_.
> +is updated drm-tip gets rebuilt. If there's a conflict see section on
> +:ref:`resolving-integration-conflicts`.
>  
>  drm-rerere
>  ~~~~~~~~~~

-- 
Jani Nikula, Intel Open Source Technology Center