GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SHIPIT::CONF (3)

.ds Aq ’

NAME

ShipIt::Conf -- holds/parses config info for a project

CONTENTS

SYNOPSIS



 # done for you:
 my $conf = ShipIt::Conf->parse(CONFFILE);

 # fetch keys out of it in your Steps init method
 package ShipIt::Step::Custom;
 use base ShipIt::Step;
 sub init {
     my ($self, $conf) = @_;
     ....
     $self->{foo} = $conf->value("foo_key");
     ....
 }



CLASS METHODS

    parse



  $conf = ShipIt::Conf->parse(".shipit");



Returns a ShipIt::Conf object from a file. Dies on parse failure.

    write_template



    ShipIt::Conf->write_template($file);



Writes out a dummy config file to the provided $file.

INSTANCE METHODS

    value



  $val = $conf->value($key);



Fetch a config value. (also marks it as a known key, so any unknown keys in a .shipit config file cause a configuration error)

    die_if_unknown_keys

Die if any key exists which has never been asked for.

    steps

Returns array of ShipIt::Step instances, based on the value of <B>stepsB> in your .shipit config file. For instance, in your .shipit file:



  steps = FindVersion, ChangeVersion, Commit, Tag, MakeDist



The makes ShipIt::Step::FindVersion loaded & instantiated (with ’new’, which calls by default ’init’), followed by ChangeVersion, etc.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 SHIPIT::CONF (3) 2012-07-21

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.