918ca55f5332e09ec3b54e715a3193766a0d4747
[git/git.git] / Documentation / git-parse-remote.txt
1 git-parse-remote(1)
2 ===================
3
4 NAME
5 ----
6 git-parse-remote - Routines to help parsing $GIT_DIR/remotes/
7
8
9 SYNOPSIS
10 --------
11 '. git-parse-remote'
12
13 DESCRIPTION
14 -----------
15 This script is included in various scripts to supply
16 routines to parse files under $GIT_DIR/remotes/ and
17 $GIT_DIR/branches/ and configuration variables that are related
18 to fetching, pulling and pushing.
19
20 The primary entry points are:
21
22 get_remote_refs_for_fetch::
23 Given the list of user-supplied `<repo> <refspec>...`,
24 return the list of refs to fetch after canonicalizing
25 them into `$GIT_DIR` relative paths
26 (e.g. `refs/heads/foo`). When `<refspec>...` is empty
27 the returned list of refs consists of the defaults
28 for the given `<repo>`, if specified in
29 `$GIT_DIR/remotes/`, `$GIT_DIR/branches/`, or `remote.*.fetch`
30 configuration.
31
32 get_remote_refs_for_push::
33 Given the list of user-supplied `<repo> <refspec>...`,
34 return the list of refs to push in a form suitable to be
35 fed to the `git-send-pack` command. When `<refspec>...`
36 is empty the returned list of refs consists of the
37 defaults for the given `<repo>`, if specified in
38 `$GIT_DIR/remotes/`.
39
40 Author
41 ------
42 Written by Junio C Hamano.
43
44 Documentation
45 --------------
46 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
47
48 GIT
49 ---
50 Part of the gitlink:git[7] suite