From fbd2a4d0a43443f981830ee17d3ff09217198021 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sun, 3 Dec 2006 01:53:42 +0000 Subject: [PATCH] Autogenerated man pages for v1.4.4.1-g278f --- man1/git-diff.1 | 9 ++++++--- man1/git-symbolic-ref.1 | 9 ++++----- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/man1/git-diff.1 b/man1/git-diff.1 index 2b320dd74..d04888e16 100755 --- a/man1/git-diff.1 +++ b/man1/git-diff.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-DIFF" "1" "10/03/2006" "" "" +.TH "GIT\-DIFF" "1" "12/03/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -23,8 +23,11 @@ git\-diff\-files. \(bu When one is given, the working tree and the named tree are compared, using git\-diff\-index. The option -\-\-cached +\-\-index can be given to compare the index file and the named tree. +\-\-cached +is a deprecated alias for +\-\-index. It's use is discouraged. .TP \(bu When two s are given, these two trees are compared using @@ -49,7 +52,7 @@ Various ways to check your working tree .sp .nf $ git diff \fB(1)\fR -$ git diff \-\-cached \fB(2)\fR +$ git diff \-\-index \fB(2)\fR $ git diff HEAD \fB(3)\fR .fi .sp diff --git a/man1/git-symbolic-ref.1 b/man1/git-symbolic-ref.1 index 87d569bec..67ec61d9e 100755 --- a/man1/git-symbolic-ref.1 +++ b/man1/git-symbolic-ref.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-SYMBOLIC\-REF" "1" "10/03/2006" "" "" +.TH "GIT\-SYMBOLIC\-REF" "1" "12/03/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -17,11 +17,10 @@ Given one argument, reads which branch head the given symbolic ref refers to and .sp Give two arguments, create or update a symbolic ref to point at the given branch . .sp -Traditionally, .git/HEAD is a symlink pointing at refs/heads/master. When we want to switch to another branch, we did ln \-sf refs/heads/newbranch .git/HEAD, and when we want to find out which branch we are on, we did readlink .git/HEAD. This was fine, and internally that is what still happens by default, but on platforms that do not have working symlinks, or that do not have the readlink(1) command, this was a bit cumbersome. On some platforms, ln \-sf does not even work as advertised (horrors). +A symbolic ref is a regular file that stores a string that begins with ref: refs/. For example, your .git/HEAD is a regular file whose contents is ref: refs/heads/master. .sp -A symbolic ref can be a regular file that stores a string that begins with ref: refs/. For example, your .git/HEAD \fBcan\fR be a regular file whose contents is ref: refs/heads/master. This can be used on a filesystem that does not support symbolic links. Instead of doing readlink .git/HEAD, git\-symbolic\-ref HEAD can be used to find out which branch we are on. To point the HEAD to newbranch, instead of ln \-sf refs/heads/newbranch .git/HEAD, git\-symbolic\-ref HEAD refs/heads/newbranch can be used. -.sp -Currently, .git/HEAD uses a regular file symbolic ref on Cygwin, and everywhere else it is implemented as a symlink. This can be changed at compilation time. +.SH "NOTES" +In the past, .git/HEAD was a symbolic link pointing at refs/heads/master. When we wanted to switch to another branch, we did ln \-sf refs/heads/newbranch .git/HEAD, and when we wanted to find out which branch we are on, we did readlink .git/HEAD. This was fine, and internally that is what still happens by default, but on platforms that do not have working symlinks, or that do not have the readlink(1) command, this was a bit cumbersome. On some platforms, ln \-sf does not even work as advertised (horrors). Therefore symbolic links are now deprecated and symbolic refs are used by default. .sp .SH "AUTHOR" Written by Junio C Hamano -- 2.26.2