Documentation: git-init: --separate-git-dir: clarify
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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Linus Arver committed
Aug 8, 2014 at 10:29 UTC
c165d1f5ca82bca5e79a1a797d847ca5458ea9c8
1 file changed
+6
-6
Documentation/git-init.txt
+6
-6
@@ -57,12 +57,12 @@ DIRECTORY" section below.)
57
58
--separate-git-dir=<git dir>::
59
60
-Instead of initializing the repository where it is supposed to be,
61
-place a filesytem-agnostic Git symbolic link there, pointing to the
62
-specified path, and initialize a Git repository at the path. The
63
-result is Git repository can be separated from working tree. If this
64
-is reinitialization, the repository will be moved to the specified
65
-path.
60
+Instead of initializing the repository as a directory to either `$GIT_DIR` or
61
+`./.git/`, create a text file there containing the path to the actual
62
+repository. This file acts as filesystem-agnostic Git symbolic link to the
63
+repository.
64
++
65
+If this is reinitialization, the repository will be moved to the specified path.
66
67
--shared[=(false|true|umask|group|all|world|everybody|0xxx)]::
68