diff options
Diffstat (limited to 'rumba/utils.py')
| -rw-r--r-- | rumba/utils.py | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/rumba/utils.py b/rumba/utils.py index f6d6c1c..fd12333 100644 --- a/rumba/utils.py +++ b/rumba/utils.py @@ -88,19 +88,27 @@ class ExperimentManager(object): syslogs_strategy=NO_SYSLOGS, syslogs=None): """ - Initializes the ExperimentManager. - :param experiment: The experiment name. + :type experiment: `rumba.model.Experiment` :param swap_out_strategy: What action to perform on swap-out. - :param syslog_strategy: What system and prototype logs to retrieve + :param syslogs_strategy: What system and prototype logs to retrieve before swap-out. :param syslogs: The location of the syslogs in case of custom syslogs. + :type syslogs: `str` + + .. note:: Options for swap_out_strategy are + + - NO_SWAPOUT == 0, + - AUTO_SWAPOUT == 1, + - PAUSE_SWAPOUT == 2, + - PROMPT_SWAPOUT == 3. - .. note:: Options for swap_out_strategy are NO_SWAPOUT, AUTO_SWAPOUT, - PAUSE_SWAPOUT, PROMPT_SWAPOUT. + .. note:: Options for syslog_strategy are - .. note:: Options for syslog_strategy are NO_SYSLOGS, DEFAULT_SYSLOGS, - DMESG_SYSLOGS, CUSTOM_SYSLOGS. + - NO_SYSLOGS == 0, + - DEFAULT_SYSLOGS == 1, + - DMESG_SYSLOGS == 2, + - CUSTOM_SYSLOGS == 3. """ assert isinstance(experiment, model.Experiment), \ 'An experiment instance is required.' |