[PATCH] Update $GIT_DIR/remotes to $GIT_DIR/refs/remotes in docs

[PATCH] Update $GIT_DIR/remotes to $GIT_DIR/refs/remotes in docs

[ayiehere]

I think this patch is is order now that $GIT_DIR/remotes is no longer used.

[PATCH] Update $GIT_DIR/remotes to $GIT_DIR/refs/remotes in docs

[ayiehere]

From: Nazri Ramliy <ayiehere@gmail.com>

---
 Documentation/git-parse-remote.txt |    2 +-
 Documentation/git-pull.txt         |    6 +++---
 Documentation/git-remote.txt       |   14 +++++++-------
 Documentation/git-show-branch.txt  |    2 +-
 Documentation/urls-remotes.txt     |    8 ++++----
 5 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/Documentation/git-parse-remote.txt b/Documentation/git-parse-remote.txt
index 39d9daa..9d27489 100644
--- a/Documentation/git-parse-remote.txt
+++ b/Documentation/git-parse-remote.txt
@@ -13,7 +13,7 @@ SYNOPSIS
 DESCRIPTION
 -----------
 This script is included in various scripts to supply
-routines to parse files under $GIT_DIR/remotes/ and
+routines to parse files under $GIT_DIR/refs/remotes/ and
 $GIT_DIR/branches/ and configuration variables that are related
 to fetching, pulling and pushing.
 
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index b932011..250d64c 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -74,13 +74,13 @@ present while on branch `<name>`, that value is used instead of
 In order to determine what URL to use to fetch from, the value
 of the configuration `remote.<origin>.url` is consulted
 and if there is not any such variable, the value on `URL: ` line
-in `$GIT_DIR/remotes/<origin>` file is used.
+in `$GIT_DIR/refs/remotes/<origin>` file is used.
 
 In order to determine what remote branches to fetch (and
 optionally store in the tracking branches) when the command is
 run without any refspec parameters on the command line, values
 of the configuration variable `remote.<origin>.fetch` are
-consulted, and if there aren't any, `$GIT_DIR/remotes/<origin>`
+consulted, and if there aren't any, `$GIT_DIR/refs/remotes/<origin>`
 file is consulted and its `Pull: ` lines are used.
 In addition to the refspec formats described in the OPTIONS
 section, you can have a globbing refspec that looks like this:
@@ -104,7 +104,7 @@ line of `git pull`, they are all merged.
 
 When no refspec was given on the command line, then `git pull`
 uses the refspec from the configuration or
-`$GIT_DIR/remotes/<origin>`.  In such cases, the following
+`$GIT_DIR/refs/remotes/<origin>`.  In such cases, the following
 rules apply:
 
 . If `branch.<name>.merge` configuration for the current
diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index c272c92..9dbcb0b 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -50,11 +50,11 @@ the remote information is set up.
 +
 With `-t <branch>` option, instead of the default glob
 refspec for the remote to track all branches under
-`$GIT_DIR/remotes/<name>/`, a refspec to track only `<branch>`
+`$GIT_DIR/refs/remotes/<name>/`, a refspec to track only `<branch>`
 is created.  You can give more than one `-t <branch>` to track
 multiple branches without grabbing all branches.
 +
-With `-m <master>` option, `$GIT_DIR/remotes/<name>/HEAD` is set
+With `-m <master>` option, `$GIT_DIR/refs/remotes/<name>/HEAD` is set
 up to point at remote's `<master>` branch. See also the set-head command.
 +
 In mirror mode, enabled with `\--mirror`, the refs will not be stored
@@ -69,7 +69,7 @@ Rename the remote named <old> to <new>. All remote tracking branches and
 configuration settings for the remote are updated.
 +
 In case <old> and <new> are the same, and <old> is a file under
-`$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to
+`$GIT_DIR/refs/remotes` or `$GIT_DIR/branches`, the remote is converted to
 the configuration file format.
 
 'rm'::
@@ -79,23 +79,23 @@ configuration settings for the remote are removed.
 
 'set-head'::
 
-Sets or deletes the default branch (`$GIT_DIR/remotes/<name>/HEAD`) for
+Sets or deletes the default branch (`$GIT_DIR/refs/remotes/<name>/HEAD`) for
 the named remote. Having a default branch for a remote is not required,
 but allows the name of the remote to be specified in lieu of a specific
 branch. For example, if the default branch for `origin` is set to
 `master`, then `origin` may be specified wherever you would normally
 specify `origin/master`.
 +
-With `-d`, `$GIT_DIR/remotes/<name>/HEAD` is deleted.
+With `-d`, `$GIT_DIR/refs/remotes/<name>/HEAD` is deleted.
 +
 With `-a`, the remote is queried to determine its `HEAD`, then
-`$GIT_DIR/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote
+`$GIT_DIR/refs/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote
 `HEAD` is pointed at `next`, "`git remote set-head origin -a`" will set
 `$GIT_DIR/refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will
 only work if `refs/remotes/origin/next` already exists; if not it must be
 fetched first.
 +
-Use `<branch>` to set `$GIT_DIR/remotes/<name>/HEAD` explicitly. e.g., "git
+Use `<branch>` to set `$GIT_DIR/refs/remotes/<name>/HEAD` explicitly. e.g., "git
 remote set-head origin master" will set `$GIT_DIR/refs/remotes/origin/HEAD` to
 `refs/remotes/origin/master`. This will only work if
 `refs/remotes/origin/master` already exists; if not it must be fetched first.
diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index 7343361..3671c2e 100644
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -161,7 +161,7 @@ $ git show-branch master fixes mhf
   + [mhf~5] Infamous 'octopus merge'
   + [mhf~6] Retire git-parse-remote.
   + [mhf~7] Multi-head fetch.
-  + [mhf~8] Start adding the $GIT_DIR/remotes/ support.
+  + [mhf~8] Start adding the $GIT_DIR/refs/remotes/ support.
 *++ [master] Add 'git show-branch'.
 ------------------------------------------------
 
diff --git a/Documentation/urls-remotes.txt b/Documentation/urls-remotes.txt
index 2a0e7b8..5c4deeb 100644
--- a/Documentation/urls-remotes.txt
+++ b/Documentation/urls-remotes.txt
@@ -7,7 +7,7 @@ The name of one of the following can be used instead
 of a URL as `<repository>` argument:
 
 * a remote in the git configuration file: `$GIT_DIR/config`,
-* a file in the `$GIT_DIR/remotes` directory, or
+* a file in the `$GIT_DIR/refs/remotes` directory, or
 * a file in the `$GIT_DIR/branches` directory.
 
 All of these also allow you to omit the refspec from the command line
@@ -35,11 +35,11 @@ config file would appear like this:
 The `<pushurl>` is used for pushes only. It is optional and defaults
 to `<url>`.
 
-Named file in `$GIT_DIR/remotes`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Named file in `$GIT_DIR/refs/remotes`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can choose to provide the name of a
-file in `$GIT_DIR/remotes`.  The URL
+file in `$GIT_DIR/refs/remotes`.  The URL
 in this file will be used to access the repository.  The refspec
 in this file will be used as default when you do not
 provide a refspec on the command line.  This file should have the
-- 
1.6.6.rc0.63.g66abc

Re: [PATCH] Update $GIT_DIR/remotes to $GIT_DIR/refs/remotes in docs

[Jeff King]

On Mon, Nov 30, 2009 at 11:38:36AM +0800, ayiehere@gmail.com wrote:

>  DESCRIPTION
>  -----------
>  This script is included in various scripts to supply
> -routines to parse files under $GIT_DIR/remotes/ and
> +routines to parse files under $GIT_DIR/refs/remotes/ and
>  $GIT_DIR/branches/ and configuration variables that are related
>  to fetching, pulling and pushing.

Er, what? $GIT_DIR/remotes/ and $GIT_DIR/refs/remotes/ are not even
remotely the same thing. The former holds information about how to
contact remotes (but that information is usually held in the config file
these days).  The latter holds any tracking refs we have fetched from
the remotes.

-Peff

Re: [PATCH] Update $GIT_DIR/remotes to $GIT_DIR/refs/remotes in docs

[Nazri Ramliy]

On Mon, Nov 30, 2009 at 1:03 PM, Jeff King <peff@peff.net> wrote:
> Er, what? $GIT_DIR/remotes/ and $GIT_DIR/refs/remotes/ are not even
> remotely the same thing. The former holds information about how to
> contact remotes (but that information is usually held in the config file
> these days).  The latter holds any tracking refs we have fetched from
> the remotes.

Erg.. thanks for the enlightenment.

I was reading 'git help remote' while attempting to change my local git
repo from tracking

  http://www.kernel.org/pub/scm/git/git.git

to

  git://git.kernel.org/pub/scm/git/git.git

and noticed that the documentation refers to $GIT_DIR/remotes and
(wrongly) thought that it meant $GIT_DIR/refs/remotes.

Sorry for the noise.

Nazri.