On Wed, Feb 26, 2014 at 5:55 AM, Duy Nguyen <pclo...@gmail.com> wrote:
> On Wed, Feb 26, 2014 at 8:24 AM, Eric Sunshine <sunsh...@sunshineco.com> 
> wrote:
>>> +'GIT_COMMON_DIR'::
>>> +       If this variable is set to a path, non-worktree files that are
>>> +       normally in $GIT_DIR will be taken from this path
>>> +       instead. Worktree-specific files such as HEAD or index are
>>> +       taken from $GIT_DIR. This variable has lower precedence than
>>> +       other path variables such as GIT_INDEX_FILE,
>>> +       GIT_OBJECT_DIRECTORY...
>>
>> For a person not familiar with "git checkout --to" or its underlying
>> implementation, this description may be lacking. Such a reader may be
>> left wondering about GIT_COMMON_DIR's overall purpose, and when and
>> how it should be used. Perhaps it would make sense to talk a bit about
>> "git checkout --to" here?
>
> I don't want to repeat too much. Maybe mention about "git checkout
> --to" and point them to git-checkout man page?

Yes, that might be sufficient. "git checkout --to" documentation
points the reader at the "MULTIPLE CHECKOUT MODE" section which gives
a more detailed explanation of GIT_COMMON_DIR, so a user wanting to
understand GIT_COMMON_DIR better would have a way to find the
information.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Reply via email to