1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
package Git::Raw::Reference;
$Git::Raw::Reference::VERSION = '0.87';
use strict;
use warnings;
use Git::Raw;
=head1 NAME
Git::Raw::Reference - Git reference class
=head1 VERSION
version 0.87
=head1 DESCRIPTION
A L<Git::Raw::Reference> represents a Git reference.
B<WARNING>: The API of this module is unstable and may change without warning
(any change will be appropriately documented in the changelog).
=head1 METHODS
=head2 annotated_commit( )
Create a L<Git::Raw::AnnotatedCommit> from the reference.
=head2 lookup( $name, $repo )
Retrieve the reference with name C<$name> in C<$repo>.
=head2 create( $name, $repo, $object [, $force, $symbolic] )
Creates and returns a new reference named C<$name> in C<$repo> pointing
to C<$object>. C<$object> can be a L<Git::Raw::Blob>, L<Git::Raw::Commit>,
or a L<Git::Raw::Tree> object. If C<$force> is a truthy value, any existing
reference is overwritten. If C<$force> is falsy (the default) and a reference
named C<$name> already exists, an error is thrown. If C<$symbolic> is a truthy
value, then a symbolic reference is created. If C<$symbolic> is falsy
(the default), then a direct reference is created. If C<$symbolic> is a truthy
value, then C<$object> can be a L<Git::Raw::Reference> or a string.
=head2 delete( )
Delete the reference. The L<Git::Raw::Reference> object must not be accessed
afterwards.
=head2 name( )
Retrieve the name of the reference.
=head2 shorthand( )
Get the reference's short name. This will transform the reference name into a
"human-readable" version. If no shortname is appropriate, it will return the
full name.
=head2 type( )
Retrieve the type of the reference. Can be either C<"direct"> or C<"symbolic">.
=head2 target( [$new_target] )
Retrieve the target of the reference. If the C<$new_target> parameter of type
L<Git::Raw::Reference> is passed, the reference will be changed to point to it.
Note that updating the target will invalidate all existing handles to the
reference.
This function returns either an object (L<Git::Raw::Blob>, L<Git::Raw::Commit>,
L<Git::Raw::Tag> or L<Git::Raw::Tree>) for direct references, or another
reference for symbolic references.
=head2 peel( $type )
Recursively peel the reference until an object of the specified C<$type> is
found. Valid values for C<$type> include: C<"commit">, C<"tree"> or C<"tag">.
=head2 reflog( )
Retrieve the L<Git::Raw::Reflog> of the reference. Shortcut for
C<Git::Raw::Reflog-E<gt>open()>.
=cut
sub reflog { return Git::Raw::Reflog -> open (shift); }
=head2 owner( )
Retrieve the L<Git::Raw::Repository> owning the reference.
=head2 is_branch( )
Check if the reference is a branch.
=head2 is_remote( )
Check if the reference is remote.
=head2 is_tag( )
Check if the reference lives in the C<refsE<sol>tags> namespace.
=head2 is_note( )
Check if the reference lives in the C<refsE<sol>notes> namespace.
=head1 AUTHOR
Alessandro Ghedini <alexbio@cpan.org>
Jacques Germishuys <jacquesg@striata.com>
=head1 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.
=cut
1; # End of Git::Raw::Reference
|
