Conjury::Stage - Perl Conjury staging areas
use Conjury::Stage; $stage = Conjury::Stage->new ( I<HASH> ); $stage->make_subdir ( F<filename> ); ($basedir, $subdir) = find_stage ( F<directory> );
The Conjury::Stage module defines the object class used to model a staging area for intermediate constructions. A stage contains a journal object and methods for creating new subdirectories in the staging area. The
find_stage function is also defined for parsing a pathname and returning the base directory of the stage and the relative remainer of the pathname.
A "stage" is an association between a directory and a journal object mapped to a file in that directory with a standard name. On most platforms, journal files in a stage are named .conjury-journal, but some filesystems have funny conventions so your experience may vary.
Creates a stage object associated with a directory. The arguments are named in a hash. All of them are optional.
Use the optional 'Directory' argument to associate the stage with a directory other than the one associated with the current context.
Use the optional 'Journal' argument to associate the stage explicitly with a specific journal object.
Creates a subdirectory within the stage. The named subdirectory must be specified by relative path. The subdirectory is created during the compile phase.
There is only one exported function:
find_stage. Whether this should be only made available as an object method is an argument not settled yet.
Finds the stage object for the specified directory.
In array context, this returns a 2-tuple of the base directory for the stage object and the relative path from the base to specified directory.
James Woodyatt <email@example.com>
2 POD Errors
The following errors were encountered while parsing the POD:
- Around line 60:
You can't have =items (as at line 124) unless the first thing after the =over is an =item
- Around line 226:
You can't have =items (as at line 234) unless the first thing after the =over is an =item