[thirdparty/git.git] / Documentation / git-parse-remote.txt

git-parse-remote(1)
===================

NAME
----
git-parse-remote - Routines to help parsing remote repository access parameters


SYNOPSIS
--------
'. 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/ and configuration variables that are related
to fetching, pulling and pushing.

The primary entry points are:

get_remote_refs_for_fetch::
	Given the list of user-supplied `<repo> <refspec>...`,
	return the list of refs to fetch after canonicalizing
	them into `$GIT_DIR` relative paths
	(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/`, `$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>...`
	is empty the returned list of refs consists of the
	defaults for the given `<repo>`, if specified in
	`$GIT_DIR/remotes/`.

Author
------
Written by Junio C Hamano.

Documentation
--------------
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.

GIT
---
Part of the linkgit:git[7] suite
Commit	Line	Data
	1	git-parse-remote(1)
	2	===================
	3
	4	NAME
	5	----
	6	git-parse-remote - Routines to help parsing remote repository access parameters
	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 linkgit:git[7] suite