NAME

TaskForest::Mark - Functions related to marking a job as Success or Failure

SYNOPSIS

use TaskForest::Mark;

&TaskForest::Mark::mark($family_name, $job_name, $log_dir, $status, $cascade, $dependents_only, $family_dir)

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

DESCRIPTION

This is a simple package that provides a location for the mark function, so that it can be used in the test scripts as well.

METHODS

mark()

Usage     : mark($family_name, $job_name, $log_dir, $status)
Purpose   : Mark the specified job as success or failure.  This job
            only changes the name of the status file:
            $family_name.$job_name.[01].  The actual contents of the
            file, the original return code is not changed.  The file
            name is what is used to determine job dependencies. 
Returns   : Nothing
Arguments : $family_name - the family name
            $job_name - the job name
            $log_dir - the root log directory
            $status - "Success" or "Failure".  Case does not matter. 
Throws    : Nothing