From: Junio C Hamano Date: Sun, 3 Dec 2006 01:53:32 +0000 (+0000) Subject: Autogenerated HTML docs for v1.4.4.1-g278f X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=735a4f7eff2a5d1efa0032c975f48bcfb3129d43;p=git.git Autogenerated HTML docs for v1.4.4.1-g278f --- diff --git a/git-diff.html b/git-diff.html index 37b31bf0d..eb8abec52 100644 --- a/git-diff.html +++ b/git-diff.html @@ -291,8 +291,10 @@ When no <tree-ish> is given, the working tree and the index

When one <tree-ish> is given, the working tree and the named tree are compared, using git-diff-index. The option - --cached can be given to compare the index file and + --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.

  • @@ -337,7 +339,7 @@ Various ways to check your working tree 
    $ git diff            (1)
-$ git diff --cached   (2)
+$ git diff --index    (2)
 $ git diff HEAD       (3)
      @@ -463,7 +465,7 @@ output diff in reverse. diff --git a/git-diff.txt b/git-diff.txt index 228c4d95b..3144864d8 100644 --- a/git-diff.txt +++ b/git-diff.txt @@ -22,8 +22,10 @@ the number of trees given to the command. * When one is given, the working tree and the named tree are compared, using `git-diff-index`. The option - `--cached` can be given to compare the index file and + `--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. * When two s are given, these two trees are compared using `git-diff-tree`. @@ -47,7 +49,7 @@ Various ways to check your working tree:: + ------------ $ git diff <1> -$ git diff --cached <2> +$ git diff --index <2> $ git diff HEAD <3> ------------ + diff --git a/git-symbolic-ref.html b/git-symbolic-ref.html index 2b13baede..ee6e8be9c 100644 --- a/git-symbolic-ref.html +++ b/git-symbolic-ref.html @@ -282,27 +282,22 @@ directory. Typically you would give HEAD as the <name> argument to see on which branch your working tree is on.

      Give two arguments, create or update a symbolic ref <name> to point at the given branch <ref>.

      -

      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 +

      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.

      + +

      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).

      -

      A symbolic ref can be a regular file that stores a string that -begins with ref: refs/. For example, your .git/HEAD can -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.

      -

      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.

      +advertised (horrors). Therefore symbolic links are now deprecated +and symbolic refs are used by default.

      Author

      @@ -314,7 +309,7 @@ changed at compilation time.

      diff --git a/git-symbolic-ref.txt b/git-symbolic-ref.txt index 68ac6a65d..4bc35a1d4 100644 --- a/git-symbolic-ref.txt +++ b/git-symbolic-ref.txt @@ -19,29 +19,22 @@ argument to see on which branch your working tree is on. Give two arguments, create or update a symbolic ref to point at the given branch . -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 +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`. + +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). - -A symbolic ref can be a regular file that stores a string that -begins with `ref: refs/`. For example, your `.git/HEAD` *can* -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. - -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. +advertised (horrors). Therefore symbolic links are now deprecated +and symbolic refs are used by default. Author ------