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
|
package Git::Raw::Config;
$Git::Raw::Config::VERSION = '0.87';
use strict;
use warnings;
use Git::Raw;
=head1 NAME
Git::Raw::Config - Git config class
=head1 VERSION
version 0.87
=head1 DESCRIPTION
A L<Git::Raw::Config> represents a Git configuration file.
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 new( )
Create a new config object.
=head2 default( )
Retrieve the global, XDG and system configuration and open them into a single
prioritized config object that can be used when accessing default config data
outside a repository.
=head2 add_file( $path, $level )
Add C<$path> to the config object with priority level C<$level>.
=head2 bool( $name [, $value ] )
Retrieve the value of the C<$name> configuration field of type boolean. If
C<$value> is passed, the value of the configration will be updated and
returned. If C<$name> configuration is not found, C<undef> is returned.
=head2 int( $name [, $value ] )
Retrieve the value of the C<$name> configuration field of type integer. If
C<$value> is passed, the value of the configration will be updated and
returned. If C<$name> configuration is not found, C<undef> is returned.
=head2 str( $name [, $value ] )
Retrieve the value of the C<$name> configuration field of type string. If
C<$value> is passed, the value of the configration will be updated and
returned. If C<$name> configuration is not found, C<undef> is returned.
=head2 str_add( $name [, $value ] )
Adds the value of the C<$name> configuration field of type string. If
C<$value> is passed, the value of the configration will be updated and
returned. If C<$name> configuration is not found, C<undef> is returned.
=head2 foreach( $callback )
Run C<$callback> for every config entry. The callback receives the name of the
config entry, its value and its priority level. A non-zero return value stops
the loop.
=head2 delete( $name )
Delete the variable C<$name> from the config object.
=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::Config
|
