[PATCH] dim: Update getting started

Daniel Vetter daniel.vetter at ffwll.ch
Tue Sep 3 08:30:15 UTC 2019


We expect a clone now since

commit 2e9ddb93dac994c7367d2e44d7939c63f780f240
Author: Jani Nikula <jani.nikula at intel.com>
Date:   Fri Jan 11 14:36:48 2019 +0200

    dim: don't setup maintainer-tools as aux checkout

But somehow the getting started pages haven't been updated.

Cc: Ayan Halder <Ayan.Halder at arm.com>
Cc: Jani Nikula <jani.nikula at intel.com>
Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>
---
 getting-started.rst | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/getting-started.rst b/getting-started.rst
index 5d4ce9c1991e..ea672497982d 100644
--- a/getting-started.rst
+++ b/getting-started.rst
@@ -12,6 +12,11 @@ There's also a sample config file for ~/.dimrc::
 
     https://gitlab.freedesktop.org/drm/maintainer-tools/raw/master/dimrc.sample
 
+The recommended way to setup dim is to simply clone it::
+
+    $ cd $DIM_PREFIX # defaults to ~/.src, or whatever you've set in your .dimrc
+    $ git clone git at gitlab.freedesktop.org:drm/maintainer-tools.git
+
 Plus, there's bash completion in the same directory if you feel like using that.
 Run::
 
@@ -23,10 +28,9 @@ your .dimrc to match your setup and then run::
 
     $ dim setup
 
-This will also check out the latest maintainer-tools branches, so please replace
-the dim you just downloaded with a symlink after this step. And by the way, if
-you have improvements for dim, see `contributing
-<dim.html#contributing-bug-reports-and-discussion>`_.
+This expects that you have the maintainer-tools already checked out in
+$DIM_PREFIX/maintainer-tools. And by the way, if you have improvements for dim,
+see `contributing <dim.html#contributing-bug-reports-and-discussion>`_.
 
 If you have a freedesktop.org account and plan to push things on one of the
 drm-xxx repos, you should use the ssh://git.freedesktop.org/git/drm-xxx urls
-- 
2.23.0



More information about the dim-tools mailing list