Merge branch 'sp/checkout'
[git/gitweb-caching.git] / Documentation / git-parse-remote.txt
blobfc27afe26d9d174c350e00804071630f879c663c
1 git-parse-remote(1)
2 ===================
4 NAME
5 ----
6 git-parse-remote - Routines to help parsing $GIT_DIR/remotes/
9 SYNOPSIS
10 --------
11 '. git-parse-remote'
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/.
19 The primary entry points are:
21 get_remote_refs_for_fetch::
22         Given the list of user-supplied `<repo> <refspec>...`,
23         return the list of refs to fetch after canonicalizing
24         them into `$GIT_DIR` relative paths
25         (e.g. `refs/heads/foo`).  When `<refspec>...` is empty
26         the returned list of refs consists of the defaults
27         for the given `<repo>`, if specified in
28         `$GIT_DIR/remotes/` or `$GIT_DIR/branches/`.
30 get_remote_refs_for_push::
31         Given the list of user-supplied `<repo> <refspec>...`,
32         return the list of refs to push in a form suitable to be
33         fed to the `git-send-pack` command.  When `<refspec>...`
34         is empty the returned list of refs consists of the
35         defaults for the given `<repo>`, if specified in
36         `$GIT_DIR/remotes/`.
38 Author
39 ------
40 Written by Junio C Hamano.
42 Documentation
43 --------------
44 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
46 GIT
47 ---
48 Part of the gitlink:git[7] suite