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