[PATCH v2 4/7] Documentation: git-init: --separate-git-dir: clarify

From: Linus Arver <linusarver@gmail.com>
Date: Aug 8, 2014, 17:29 UTC
Message-ID: <1407518960-6203-5-git-send-email-linusarver@gmail.com>
In-Reply-To: <1407518960-6203-1-git-send-email-linusarver@gmail.com>

Use shorter sentences to describe what actually happens. We describe what the term "Git symbolic link" actually means.

Also, we separate out the description of the behavioral change upon reinitialization into its own paragraph.

Signed-off-by: Linus Arver <linusarver@gmail.com>
---
 Documentation/git-init.txt | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index 6ffe721..3f4e46a 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -57,12 +57,12 @@ DIRECTORY" section below.)
 
 --separate-git-dir=<git dir>::
 
-Instead of initializing the repository where it is supposed to be,
-place a filesytem-agnostic Git symbolic link there, pointing to the
-specified path, and initialize a Git repository at the path. The
-result is Git repository can be separated from working tree. If this
-is reinitialization, the repository will be moved to the specified
-path.
+Instead of initializing the repository as a directory to either `$GIT_DIR` or
+`./.git/`, create a text file there containing the path to the actual
+repository.  This file acts as filesystem-agnostic Git symbolic link to the
+repository.
++
+If this is reinitialization, the repository will be moved to the specified path.
 
 --shared[=(false|true|umask|group|all|world|everybody|0xxx)]::

-- 
2.0.4