Scroll to navigation

Git::Raw::Config(3pm) User Contributed Perl Documentation Git::Raw::Config(3pm)

NAME

Git::Raw::Config - Git config class

VERSION

version 0.90

DESCRIPTION

A Git::Raw::Config represents a Git configuration file.

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

METHODS

new( )

Create a new config object.

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.

add_file( $path, $level )

Add $path to the config object with priority level $level.

bool( $name [, $value ] )

Retrieve the value of the $name configuration field of type boolean. If $value is passed, the value of the configration will be updated and returned. If $name configuration is not found, "undef" is returned.

int( $name [, $value ] )

Retrieve the value of the $name configuration field of type integer. If $value is passed, the value of the configration will be updated and returned. If $name configuration is not found, "undef" is returned.

str( $name [, $value ] )

Retrieve the value of the $name configuration field of type string. If $value is passed, the value of the configration will be updated and returned. If $name configuration is not found, "undef" is returned.

str_add( $name [, $value ] )

Adds the value of the $name configuration field of type string. If $value is passed, the value of the configration will be updated and returned. If $name configuration is not found, "undef" is returned.

foreach( $callback )

Run $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.

delete( $name )

Delete the variable $name from the config object.

AUTHOR

Alessandro Ghedini <alexbio@cpan.org>

Jacques Germishuys <jacquesg@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.

2024-10-14 perl v5.40.0