Commit 446c58b9 authored by Gary Wong's avatar Gary Wong

Add comments describing Reservation->Forecast() output.

parent 9c9908b1
......@@ -842,6 +842,23 @@ sub FreeCount($$;$) {
#
# Generate a time series of counts of nodes of a given type.
#
# The result is a list of (t, unavailable, held, free) tuples, where:
#
# * 't' is the timestamp at which the state changes to the corresponding
# values.
#
# * 'unavailable' is a count of nodes unavailable for allocation, either
# because they're already in use (including both those in use
# by experiments in the projects specified and those used by others),
# or because they're required for reservations to other projects.
#
# * 'held' is a count of nodes reserved to the project(s) queried, and
# so could potentially be used by the user asking, but generally not by
# others. Not merely "could", but "SHOULD"!
#
# * 'free' is the number of nodes not allocated and not needed
# for reservations; available for general use subject to other constraints.
sub Forecast($$;$) {
my ($class, $type, $projlist) = @_;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment