Code

docs: don't talk about $GIT_DIR/refs/ everywhere
authorJeff King <peff@peff.net>
Thu, 18 Feb 2010 01:16:20 +0000 (20:16 -0500)
committerJunio C Hamano <gitster@pobox.com>
Thu, 18 Feb 2010 05:40:09 +0000 (21:40 -0800)
commitcc1b8d8bc6e453b96798574d67ce9590eb3e82e1
treebe182f1f5a302a4ee660a35d1cd16599ff4441a5
parente3ff352c73a87d533fd239c3f9d4bb978c8ce387
docs: don't talk about $GIT_DIR/refs/ everywhere

It is misleading to say that we pull refs from $GIT_DIR/refs/*, because we
may also consult the packed refs mechanism. These days we tend to treat
the "refs hierarchy" as more of an abstract namespace that happens to be
represented as $GIT_DIR/refs. At best, this is a minor inaccuracy, but at
worst it can confuse users who then look in $GIT_DIR/refs and find that it
is missing some of the refs they expected to see.

This patch drops most uses of "$GIT_DIR/refs/*", changing them into just
"refs/*", under the assumption that users can handle the concept of an
abstract refs namespace. There are a few things to note:

  - most cases just dropped the $GIT_DIR/ portion. But for cases where
    that left _just_ the word "refs", I changed it to "refs/" to help
    indicate that it was a hierarchy.  I didn't do the same for longer
    paths (e.g., "refs/heads" remained, instead of becoming
    "refs/heads/").

  - in some cases, no change was made, as the text was explicitly about
    unpacked refs (e.g., the discussion in git-pack-refs).

  - In some cases it made sense instead to note the existence of packed
    refs (e.g., in check-ref-format and rev-parse).

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-check-ref-format.txt
Documentation/git-clone.txt
Documentation/git-fetch-pack.txt
Documentation/git-pack-objects.txt
Documentation/git-prune.txt
Documentation/git-push.txt
Documentation/git-rev-parse.txt
Documentation/git-show-branch.txt
Documentation/git-stash.txt
Documentation/rev-list-options.txt