Skip to content

Commit

Permalink
Documentation: git-init: --separate-git-dir: clarify
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Linus Arver authored and Junio C Hamano committed Aug 8, 2014
1 parent 86d387a commit c165d1f
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions Documentation/git-init.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)]::

Expand Down

0 comments on commit c165d1f

Please sign in to comment.