From: Vincent Pit <vince@profvince.com>
Date: Wed, 22 Oct 2008 12:38:37 +0000 (+0200)
Subject: Clarify what's the root and the current directory in rgit's man page
X-Git-Tag: v0.06~13
X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2Frgit.git;a=commitdiff_plain;h=d269812ad0771d8f1925c858e8a52618cbe304e9

Clarify what's the root and the current directory in rgit's man page
---

diff --git a/bin/rgit b/bin/rgit
index 1f0b2f0..6387293 100755
--- a/bin/rgit
+++ b/bin/rgit
@@ -142,8 +142,8 @@ Version 0.05
 
 =head1 DESCRIPTION
 
-This utility recursively searches in the current directory (or in the directory given by the C<GIT_DIR> environment variable if it's set) for all git repositories, sort this list by the repository path, C<chdir> into each of them, and executes the specified git command.
-Moreover, those formats are substuted in the arguments before running the command :
+This utility recursively searches in a root directory (which may be the current working directory or - if it has been set - the directory given by the C<GIT_DIR> environment variable) for all git repositories, sort this list by the repository path, C<chdir> into each of them, and executes the specified git command.
+Moreover, those formats are substituted in the arguments before running the command :
 
 =over 4
 
@@ -153,7 +153,7 @@ C<^n> with the current repository name.
 
 =item *
 
-C<^g> with the relative path to the current repository.
+C<^g> with the relative path (based from the root directory) to the current repository.
 
 =item *
 
@@ -161,7 +161,7 @@ C<^G> with the absolute path to the current repository.
 
 =item *
 
-C<^w> with the relative path to the current repository's working directory.
+C<^w> with the relative path (based from the root directory) to the current repository's working directory.
 
 =item *
 
@@ -177,7 +177,7 @@ C<^B> with an absolute version of the "bareified" path.
 
 =item *
 
-C<^R> with the absolute path to the current root directory.
+C<^R> with the absolute path to the root directory.
 
 =item *
 
@@ -185,7 +185,7 @@ C<^^> with a bare C<^>.
 
 =back
 
-There are actually a few commands that are only executed once in the current directory : C<daemon>, C<gui>, C<help>, C<init> and C<version>.
+There are actually a few commands that are only executed once in the root directory : C<daemon>, C<gui>, C<help>, C<init> and C<version>.
 For any of those, no format substitution is done.
 
 You can specify which C<git> executable to use with the C<GIT_EXEC_PATH> environment variable.