All of lore.kernel.org
 help / color / mirror / Atom feed
From: Linus Arver <linusarver@gmail.com>
To: git@vger.kernel.org
Cc: "Steven Drake" <sdrake@xnet.co.nz>,
	"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
	"Johan Herland" <johan@herland.net>,
	"Linus Arver" <linusarver@gmail.com>
Subject: [PATCH v2 4/7] Documentation: git-init: --separate-git-dir: clarify
Date: Fri,  8 Aug 2014 10:29:17 -0700	[thread overview]
Message-ID: <1407518960-6203-5-git-send-email-linusarver@gmail.com> (raw)
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

  parent reply	other threads:[~2014-08-08 17:30 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-08-02 18:06 [PATCH] lots of documentation fixes/rewordings in git-init(1) Linus Arver
2014-08-02 18:06 ` [PATCH 1/7] Documentation: git-init: typographical fixes Linus Arver
2014-08-05 22:06   ` Junio C Hamano
2014-08-06  4:58     ` Linus Arver
2014-08-02 18:06 ` [PATCH 2/7] Documentation: git-init: list items facelift Linus Arver
2014-08-02 18:06 ` [PATCH 3/7] Documentation: git-init: template directory: reword Linus Arver
2014-08-05 22:10   ` Junio C Hamano
2014-08-06  5:15     ` Linus Arver
2014-08-06 17:21       ` Junio C Hamano
2014-08-08 16:36         ` Linus Arver
2014-08-02 18:06 ` [PATCH 4/7] Documentation: git-init: --separate-git-dir: clarify Linus Arver
2014-08-05 22:12   ` Junio C Hamano
2014-08-06  5:21     ` Linus Arver
2014-08-06 17:35       ` Junio C Hamano
2014-08-08 16:42         ` Linus Arver
2014-08-02 18:06 ` [PATCH 5/7] Documentation: git-init: reword parenthetical statements Linus Arver
2014-08-02 18:06 ` [PATCH 6/7] Documentation: git-init: template directory: reword and cross-reference Linus Arver
2014-08-02 18:06 ` [PATCH 7/7] Documentation: git-init: flesh out example Linus Arver
2014-08-05 22:14   ` Junio C Hamano
2014-08-06  5:34     ` Linus Arver
2014-08-06 17:41       ` Junio C Hamano
2014-08-08 16:49         ` Linus Arver
2014-08-08 17:29 ` [PATCH v2] lots of documentation fixes/rewordings in git-init(1) Linus Arver
2014-08-08 17:29   ` [PATCH v2 1/7] Documentation: git-init: typographical fixes Linus Arver
2014-08-08 17:29   ` [PATCH v2 2/7] Documentation: git-init: list items facelift Linus Arver
2014-08-08 17:29   ` [PATCH v2 3/7] Documentation: git-init: template directory: reword Linus Arver
2014-08-08 17:29   ` Linus Arver [this message]
2014-08-08 17:29   ` [PATCH v2 5/7] Documentation: git-init: reword parenthetical statements Linus Arver
2014-08-08 17:29   ` [PATCH v2 6/7] Documentation: git-init: template directory: reword and cross-reference Linus Arver
2014-08-08 17:29   ` [PATCH v2 7/7] Documentation: git-init: flesh out example Linus Arver

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1407518960-6203-5-git-send-email-linusarver@gmail.com \
    --to=linusarver@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=johan@herland.net \
    --cc=pclouds@gmail.com \
    --cc=sdrake@xnet.co.nz \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.