Merge branch 'mg/track'
[gitweb.git] / Documentation / git-parse-remote.txt
index fc27afe26d9d174c350e00804071630f879c663c..cd43069874d59504627211e011250a3554aeee5a 100644 (file)
@@ -3,18 +3,19 @@ git-parse-remote(1)
 
 NAME
 ----
-git-parse-remote - Routines to help parsing $GIT_DIR/remotes/
+git-parse-remote - Routines to help parsing remote repository access parameters
 
 
 SYNOPSIS
 --------
-'. git-parse-remote'
+'. "$(git --exec-path)/git-parse-remote"'
 
 DESCRIPTION
 -----------
 This script is included in various scripts to supply
 routines to parse files under $GIT_DIR/remotes/ and
-$GIT_DIR/branches/.
+$GIT_DIR/branches/ and configuration variables that are related
+to fetching, pulling and pushing.
 
 The primary entry points are:
 
@@ -25,12 +26,13 @@ get_remote_refs_for_fetch::
        (e.g. `refs/heads/foo`).  When `<refspec>...` is empty
        the returned list of refs consists of the defaults
        for the given `<repo>`, if specified in
-       `$GIT_DIR/remotes/` or `$GIT_DIR/branches/`.
+       `$GIT_DIR/remotes/`, `$GIT_DIR/branches/`, or `remote.*.fetch`
+       configuration.
 
 get_remote_refs_for_push::
        Given the list of user-supplied `<repo> <refspec>...`,
        return the list of refs to push in a form suitable to be
-       fed to the `git-send-pack` command.  When `<refspec>...`
+       fed to the 'git-send-pack' command.  When `<refspec>...`
        is empty the returned list of refs consists of the
        defaults for the given `<repo>`, if specified in
        `$GIT_DIR/remotes/`.
@@ -45,4 +47,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[1] suite