[PATCH 1/2] dim: clarify dimrc a bit

[Rodrigo Vivi]

On Tue, Aug 21, 2018 at 02:08:18PM +0200, Daniel Vetter wrote:
> Some notes I took while ramping up Shashank on dim.
> 
> Aside: Requiring that DIM_REPO is already checked out seems to confuse
> too. Maybe we should just fall back to initializing an empty git repo
> - we'll all all the branches and remotes anyway.
> 
> Cc: Shashank Sharma <shashank.sharma at intel.com>
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>

makes sense

Reviewed-by: Rodrigo Vivi <rodrigo.vivi at intel.com>


> ---
>  dim.rst      | 8 +++++---
>  dimrc.sample | 3 ++-
>  2 files changed, 7 insertions(+), 4 deletions(-)
> 
> diff --git a/dim.rst b/dim.rst
> index ed784fe20913..6d7528ce497f 100644
> --- a/dim.rst
> +++ b/dim.rst
> @@ -262,8 +262,8 @@ branches if "all" is given.
>  
>  for-each-workdir *command*
>  --------------------------
> -Run the given command in all active workdirs including the main repository under
> -\$DIM_REPO.
> +Run the given command in all active workdirs including the main linux kernel
> +repository under \$DIM_REPO.
>  
>  COMMANDS FOR MAINTAINERS
>  ========================
> @@ -438,13 +438,15 @@ Path prefix for kernel repositories.
>  
>  DIM_REPO
>  --------
> -The main maintainer repository under \$DIM_PREFIX.
> +The main linux kernel repository under \$DIM_PREFIX.
>  
>  DIM_MUA
>  -------
>  Mail user agent. Must support the following subset of **mutt(1)** command line
>  options: \$DIM_MUA [-s subject] [-i file] [-c cc-addr] to-addr [...]
>  
> +This is only needed for sending out pull requests.
> +
>  DIM_MAKE_OPTIONS
>  ----------------
>  Additional options to pass to **make(1)**. Defaults to "-j20".
> diff --git a/dimrc.sample b/dimrc.sample
> index 1b522fa47e8c..b061d2bf0c55 100644
> --- a/dimrc.sample
> +++ b/dimrc.sample
> @@ -7,11 +7,12 @@
>  # $DIM_REPO, drm-tip, maintainer-tools, etc.
>  #DIM_PREFIX=$HOME/linux
>  
> -# Name of the main maintainer repo under $DIM_PREFIX.
> +# Name of the main linux kernel repo under $DIM_PREFIX.
>  #DIM_REPO=src
>  
>  # Mail User Agent supporting a subset of mutt(1) command line options:
>  # [-s subject] [-i file] [-c cc-addr] to-addr [...]
> +# This is only needed for sending out pull requests
>  #DIM_MUA=mutt
>  
>  # Command to run after dim apply
> -- 
> 2.18.0
> 
> _______________________________________________
> dim-tools mailing list
> dim-tools at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dim-tools