—package
Git::Raw::Config;
$Git::Raw::Config::VERSION
=
'0.55'
;
# TRIAL
use
strict;
use
warnings;
use
Git::Raw;
=head1 NAME
Git::Raw::Config - Git config class
=head1 VERSION
version 0.55
=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 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