@matheusbsbs / matheus-bagliano / commits / cd0a781c38
Fork 0

Documentation: do not blindly run 'cat' .git/HEAD, or echo into it.

Many places in the documentation we still talked about reading what commit is recorded in .git/HEAD or writing the new head information into it, both assuming .git/HEAD is a symlink. That is not necessarily so. Signed-off-by: Junio C Hamano <junkio@cox.net>

Junio C Hamano committed Nov 15, 2005 at 01:31 UTC cd0a781c386b197e63a30104bead39420eada7ca
7 files changed +14 -13
Documentation/diff-format.txt
+1 -1
@@ -81,7 +81,7 @@ The "diff" formatting options can be customized via the
81 environment variable 'GIT_DIFF_OPTS'. For example, if you
82 prefer context diff:
83
84 - GIT_DIFF_OPTS=-c git-diff-index -p $(cat .git/HEAD)
84 + GIT_DIFF_OPTS=-c git-diff-index -p HEAD
85
86
87 2. When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
Documentation/git-commit-tree.txt
+3 -2
@@ -26,8 +26,9 @@ to get there.
26
27 Normally a commit would identify a new "HEAD" state, and while git
28 doesn't care where you save the note about that state, in practice we
29 -tend to just write the result to the file `.git/HEAD`, so that we can
30 -always see what the last committed state was.
29 +tend to just write the result to the file that is pointed at by
30 +`.git/HEAD`, so that we can always see what the last committed
31 +state was.
32
33 OPTIONS
34 -------
Documentation/git-diff-index.txt
+3 -3
@@ -57,14 +57,14 @@ some files in the index and are ready to commit. You want to see eactly
57 *what* you are going to commit is without having to write a new tree
58 object and compare it that way, and to do that, you just do
59
60 - git-diff-index --cached $(cat .git/HEAD)
60 + git-diff-index --cached HEAD
61
62 Example: let's say I had renamed `commit.c` to `git-commit.c`, and I had
63 done an "git-update-index" to make that effective in the index file.
64 "git-diff-files" wouldn't show anything at all, since the index file
65 matches my working directory. But doing a "git-diff-index" does:
66
67 - torvalds@ppc970:~/git> git-diff-index --cached $(cat .git/HEAD)
67 + torvalds@ppc970:~/git> git-diff-index --cached HEAD
68 -100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 commit.c
69 +100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 git-commit.c
70
@@ -98,7 +98,7 @@ show that. So let's say that you have edited `kernel/sched.c`, but
98 have not actually done a "git-update-index" on it yet - there is no
99 "object" associated with the new state, and you get:
100
101 - torvalds@ppc970:~/v2.6/linux> git-diff-index $(cat .git/HEAD )
101 + torvalds@ppc970:~/v2.6/linux> git-diff-index HEAD
102 *100644->100664 blob 7476bb......->000000...... kernel/sched.c
103
104 ie it shows that the tree has changed, and that `kernel/sched.c` has is
Documentation/git-fsck-objects.txt
+1 -1
@@ -68,7 +68,7 @@ that aren't readable from any of the specified head nodes.
68
69 So for example
70
71 - git-fsck-objects --unreachable $(cat .git/HEAD .git/refs/heads/*)
71 + git-fsck-objects --unreachable HEAD $(cat .git/refs/heads/*)
72
73 will do quite a _lot_ of verification on the tree. There are a few
74 extra validity tests to be added (make sure that tree objects are
Documentation/git-read-tree.txt
+1 -1
@@ -237,7 +237,7 @@ This is done to prevent you from losing your work-in-progress
237 changes. To illustrate, suppose you start from what has been
238 commited last to your repository:
239
240 - $ JC=`cat .git/HEAD`
240 + $ JC=`git-rev-parse --verify "HEAD^0"`
241 $ git-checkout-index -f -u -a $JC
242
243 You do random edits, without running git-update-index. And then
Documentation/git-symbolic-ref.txt
+2 -2
@@ -24,8 +24,8 @@ Traditionally, `.git/HEAD` is a symlink pointing at
24 we did `ln -sf refs/heads/newbranch .git/HEAD`, and when we want
25 to find out which branch we are on, we did `readlink .git/HEAD`.
26 This was fine, and internally that is what still happens by
27 -default, but on platforms that does not have working symlinks,
28 -or that does not have the `readlink(1)` command, this was a bit
27 +default, but on platforms that do not have working symlinks,
28 +or that do not have the `readlink(1)` command, this was a bit
29 cumbersome. On some platforms, `ln -sf` does not even work as
30 advertised (horrors).
31
README
+3 -3
@@ -396,8 +396,8 @@ git-commit-tree will return the name of the object that represents
396 that commit, and you should save it away for later use. Normally,
397 you'd commit a new `HEAD` state, and while git doesn't care where you
398 save the note about that state, in practice we tend to just write the
399 -result to the file `.git/HEAD`, so that we can always see what the
400 -last committed state was.
399 +result to the file pointed at by `.git/HEAD`, so that we can always see
400 +what the last committed state was.
401
402 Here is an ASCII art by Jon Loeliger that illustrates how
403 various pieces fit together.
@@ -464,7 +464,7 @@ tend to be small and fairly self-explanatory. In particular, if you
464 follow the convention of having the top commit name in `.git/HEAD`,
465 you can do
466
467 - git-cat-file commit $(cat .git/HEAD)
467 + git-cat-file commit HEAD
468
469 to see what the top commit was.
470