]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-parse-remote-script.txt
Documentation updates.
[thirdparty/git.git] / Documentation / git-parse-remote-script.txt
CommitLineData
5077fa9c
JH
1git-parse-remote-script(1)
2==========================
3
4NAME
5----
6git-parse-remote-script - Routines to help parsing $GIT_DIR/remotes/
7
8
9SYNOPSIS
10--------
11'. git-parse-remote-script'
12
13DESCRIPTION
14-----------
15This script is included in various scripts to supply
16routines to parse files under $GIT_DIR/remotes/ and
17$GIT_DIR/branches/.
18
19The primary entry points are:
20
21get_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/`.
29
30get_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/`.
37
38Author
39------
40Written by Junio C Hamano.
41
42Documentation
43--------------
44Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
45
46GIT
47---
48Part of the link:git.html[git] suite