NAME

TaskForest::LogDir - Functions related to today's log directory

SYNOPSIS

use TaskForest::LogDir;

my $log_dir = &TaskForest::LogDir::getLogDir("/var/logs/taskforest");
# $log_dir is created if it does not exist

DOCUMENTATION

If you're just looking to use the taskforest application, the only documentation you need to read is that for TaskForest. You can do this either of the two ways:

perldoc TaskForest

OR

man TaskForest

If you're a developer and you want to understand the code, I would recommend that you read the pods in this order:

• TaskForest

• TaskForest::Job

• TaskForest::Family

• TaskForest::TimeDependency

• TaskForest::LogDir

• TaskForest::Options

• TaskForest::StringHandleTier

• TaskForest::StringHandle

Finally, read the documentation in the source. Great efforts have been made to keep it current and relevant.

DESCRIPTION

This is a simple package that provides a location for the getLogDir function that's used in a few places.

METHODS

getLogDir()

Usage     : my $log_dir = TaskForest::LogDir::getLogDir($root)
Purpose   : This method creates a dated subdirectory of its first
            parameter, if that directory doesn't already exist.  
Returns   : The dated directory
Argument  : $root - the parent directory of the dated directory
Throws    : "mkdir $log_dir failed" if the log directory cannot be
            created