/ 
Git-Raw-0.26-TRIAL
River stage one • 3 direct dependents • 3 total dependents
/ Git::Raw::Remote

NAME

Git::Raw::Remote - Git remote class

VERSION

version 0.26

SYNOPSIS

use Git::Raw;

# open the Git repository at $path
my $repo = Git::Raw::Repository -> open($path);

# add a new remote
my $remote = Git::Raw::Remote -> create($repo, 'origin', $url);

# set the acquire credentials callback
$remote -> callbacks({
  credentials => sub { Git::Raw::Cred -> plaintext($usr, $pwd) }
});

# connect the remote
$remote -> connect('fetch');

# fetch from the remote and update the local tips
$remote -> download;
$remote -> update_tips;

# disconnect
$remote -> disconnect;

DESCRIPTION

A Git::Raw::Remote represents a Git remote.

WARNING: The API of this module is unstable and may change without warning (any change will be appropriately documented in the changelog).

METHODS

create( $repo, $name, $url )

Create a remote with the default fetch refspec and add it to the repository's configuration.

load( $repo, $name )

Load an existing remote.

name( [ $name ] )

Retrieve the name of the remote. If $name is passed, the remote's name will be updated and returned.

url( [ $url ] )

Retrieve the URL of the remote. If $url is passed, the remote's URL will be updated and returned.

add_fetch( $spec )

Add a fetch spec to the remote.

add_push( $spec )

Add a push spec to the remote.

callbacks( \%callbacks )

  • "credentials"

    The callback to be called any time authentication is required to connect to the remote repository. The callback receives a string containing the URL of the remote, and it must return a Git::Raw::Cred object.

cred_acquire( $callback )

Run $callback any time authentication is required to connect to the remote repository. The callback receives a string containing the URL of the remote, and it must return a Git::Raw::Cred object.

Note that this method is deprecated in favor of callbacks()

connect( $direction )

Connect to the remote. The direction can be either "fetch" or "push".

disconnect( )

Disconnect the remote.

download( )

Download the remote packfile.

save( )

Save the remote to its repository's config.

update_tips( )

Update the tips to the new status.

is_connected( )

Check if the remote is connected.

AUTHOR

Alessandro Ghedini <alexbio@cpan.org>

LICENSE AND COPYRIGHT

Copyright 2012 Alessandro Ghedini.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.