[PATCH v2] doc: clarify the target audience for the status command

Liviu Dudau Liviu.Dudau at arm.com
Thu Jun 21 14:36:20 UTC 2018


'dim status' is intended to be used by maintainers and not by commiters.
Move the description of the subcommand into the 'COMMANDS FOR MAINTAINERS'
area and clarify in the COMMITERS area that they should use vanilla
'git status' for checking the health of the branch.

v2: Fix duplicate 'status' warnings by merging the text into the 'COMMANDS
FOR MAINTAINERS' description.

Signed-off-by: Liviu Dudau <liviu.dudau at arm.com>
---
 dim.rst | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/dim.rst b/dim.rst
index f7ca4ebdf0ebe..a99e40678a2f0 100644
--- a/dim.rst
+++ b/dim.rst
@@ -108,10 +108,6 @@ update-branches
 Updates all maintainer branches. Useful to synchronize all branches when other
 maintainers and committers pushed patches meanwhile.
 
-status
-------
-Lists all branches with unmerged patches, and how many patches are unmerged.
-
 cd
 --
 Changes the working directory into the git repository used by the last previous
@@ -288,6 +284,15 @@ cherry-pick them to drm-intel-fixes or drm-intel-next-fixes. These commands use
 dim cherry-pick internally to make sure bugfixes for fixes are cherry-picked
 too.
 
+status
+------
+Lists all branches with unmerged patches, and how many patches are unmerged. It
+will show how the overall subsystem tree looks like and where patches waiting to
+be merged have been added, in order to help maintainers with deciding which tree
+is in need of a pull request. Commiters that want to check the status of their
+current branch should use normal **git status** commands.
+
+
 pull-request *branch* *upstream*
 --------------------------------
 Fetch the *upstream* remote to make sure it's up-to-date, create and push a date
-- 
2.17.1



More information about the dim-tools mailing list