summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Vetter <daniel.vetter@ffwll.ch>2018-08-21 13:52:22 +0200
committerDaniel Vetter <daniel.vetter@ffwll.ch>2018-08-23 08:59:02 +0200
commitf8cb0159ff4ebcf74dbf2ea2df484c0160fbb460 (patch)
treed5ab8023397cab199cef12d898be00e535e89ff6
parentd3a840644ff2df75dc8605704e9032346d8127df (diff)
dim: clarify dimrc a bit
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@intel.com> Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
-rw-r--r--dim.rst8
-rw-r--r--dimrc.sample3
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