Skip to content

Commit

Permalink
user-manual: don't assume refs are stored under .git/refs
Browse files Browse the repository at this point in the history
The scripts taken from Tony Luck's howto assume all refs can be found
under .git/refs, but this is not necessarily true, especially since
git-gc runs git-pack-refs.

Also add a note warning of this in the chapter that introduces refs, and
fix the same incorrect assumption in one other spot.

Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
  • Loading branch information
J. Bruce Fields committed Sep 23, 2007
1 parent 806ea70 commit fc74ecc
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions Documentation/user-manual.txt
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,11 @@ shorthand:
The full name is occasionally useful if, for example, there ever
exists a tag and a branch with the same name.

(Newly created refs are actually stored in the .git/refs directory,
under the path given by their name. However, for efficiency reasons
they may also be packed together in a single file; see
gitlink:git-pack-refs[1]).

As another useful shortcut, the "HEAD" of a repository can be referred
to just using the name of that repository. So, for example, "origin"
is usually a shortcut for the HEAD branch in the repository "origin".
Expand Down Expand Up @@ -2189,9 +2194,9 @@ test|release)
git checkout $1 && git pull . origin
;;
origin)
before=$(cat .git/refs/remotes/origin/master)
before=$(git rev-parse refs/remotes/origin/master)
git fetch origin
after=$(cat .git/refs/remotes/origin/master)
after=$(git rev-parse refs/remotes/origin/master)
if [ $before != $after ]
then
git log $before..$after | git shortlog
Expand All @@ -2216,11 +2221,10 @@ usage()
exit 1
}

if [ ! -f .git/refs/heads/"$1" ]
then
git show-ref -q --verify -- refs/heads/"$1" || {
echo "Can't see branch <$1>" 1>&2
usage
fi
}

case "$2" in
test|release)
Expand Down Expand Up @@ -2251,7 +2255,7 @@ then
git log test..release
fi

for branch in `ls .git/refs/heads`
for branch in `git show-ref --heads | sed 's|^.*/||'`
do
if [ $branch = test -o $branch = release ]
then
Expand Down Expand Up @@ -2946,7 +2950,7 @@ nLE/L9aUXdWeTFPron96DLA=
See the gitlink:git-tag[1] command to learn how to create and verify tag
objects. (Note that gitlink:git-tag[1] can also be used to create
"lightweight tags", which are not tag objects at all, but just simple
references in .git/refs/tags/).
references whose names begin with "refs/tags/").

[[pack-files]]
How git stores objects efficiently: pack files
Expand Down

0 comments on commit fc74ecc

Please sign in to comment.