diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/log.rst | 2 | ||||
| -rw-r--r-- | doc/utils.rst | 2 | ||||
| -rw-r--r-- | doc/workflow.rst | 6 |
3 files changed, 6 insertions, 4 deletions
diff --git a/doc/log.rst b/doc/log.rst index 1fd3b6f..d19bc13 100644 --- a/doc/log.rst +++ b/doc/log.rst @@ -8,3 +8,5 @@ Logging .. autofunction:: rumba.log.flush_and_kill_logging .. autofunction:: rumba.log.flush_log + +.. autoclass:: rumba.log.LogOptions diff --git a/doc/utils.rst b/doc/utils.rst index 6df8a0c..cc3db41 100644 --- a/doc/utils.rst +++ b/doc/utils.rst @@ -8,6 +8,8 @@ Example usage of the class: .. code-block:: python + from rumba.utils import ExperimentManager, PROMPT_SWAPOUT + with ExperimentManager(exp, swap_out_strategy=PROMPT_SWAPOUT): exp.swap_in() exp.bootstrap_prototype() diff --git a/doc/workflow.rst b/doc/workflow.rst index 04f23b1..672c33c 100644 --- a/doc/workflow.rst +++ b/doc/workflow.rst @@ -34,11 +34,9 @@ Workflow Accessing nodes after swap-in ----------------------------- -To access a node once the experiment swapped in, use the following +To access a node once the experiment is swapped in, use the following command (in the same terminal where ssh-agent was run in case of jFed): :: $ rumba-access $NODE_NAME -Where $NODE_NAME is the name of the node to access. In case of the -QEMU testbed, the password of the downloaded buildroot images is -'root'. +Where $NODE_NAME is the name of the node to access.
\ No newline at end of file |