Skip to content

Commit c165d1f

Browse files
listxgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 86d387a commit c165d1f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Documentation/git-init.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ DIRECTORY" section below.)
5757

5858
--separate-git-dir=<git dir>::
5959

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.
6666

6767
--shared[=(false|true|umask|group|all|world|everybody|0xxx)]::
6868

0 commit comments

Comments
 (0)