/ 
Toader-1.2.1
River stage zero No dependents
/ Toader::findToaderRoot

NAME

Toader::findToaderRoot - This finds the root Toader directory.

VERSION

Version 0.1.0

SYNOPSIS

use Toader::findToaderRoot;

my $foo = Toader::findToaderRoot->new();

my $root=$foo->findToaderRoot($directory);
if($foo->error){
    warn('Error '.$foo->error.': '.$foo->errorString);
}else{
    print $root."\n";
}

METHODS

new

This initiates the object.

my $foo = Toader::findToaderRoot->new();

findToaderRoot

This takes a directory and then finds the root for that Toader repo.

One argument is required and it is the directory to start in.

One value is returned and it is the root directory.

my $root=$foo->findToaderRoot($directory);
if($foo->error){
    warn('Error '.$foo->error.': '.$foo->errorString);
}else{
    print $root."\n";
}

ERROR CODES

1, noDirSpecified

No directory specified.

2, notAdir

Not a directory.

3, notAtoaderDir

Not a Toader directory.

4, isaToaderDirErrored

Toader::isaToaderDir->isaToaderDir errored.

5, rootIsAtoaderDir

"/" is the directory and it appears to be a Toader directory.

This is a major WTF and should not be even if '/.toader' exists.

AUTHOR

Zane C. Bowers-Hadley, <vvelox at vvelox.net>

BUGS

Please report any bugs or feature requests to bug-toader at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Toader. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Toader::findToaderRoot

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Zane C. Bowers-Hadley.

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.