Skip to content

Commit

Permalink
document RemoteCommand's stdioLogName parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
djmitche committed May 26, 2014
1 parent 02225e7 commit c8c3215
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions master/docs/developer/cls-remotecommands.rst
Expand Up @@ -13,24 +13,25 @@ detail in :ref:`master-slave-updates`.
RemoteCommand
~~~~~~~~~~~~~

.. py:class:: RemoteCommand(remote_command, args, collectStdout=False, ignore_updates=False, decodeRC=dict(0))
.. py:class:: RemoteCommand(remote_command, args, collectStdout=False, ignore_updates=False, decodeRC=dict(0), stdioLogName='stdio')
:param remote_command: command to run on the slave
:type remote_command: string
:param args: arguments to pass to the command
:type args: dictionary
:param collectStdout: if True, collect the command's stdout
:param ignore_updates: true to ignore remote updates
:param decodeRC: dictionary associating ``rc`` values to buildsteps results constants
(e.g. ``SUCCESS``, ``FAILURE``, ``WARNINGS``)
:param decodeRC: dictionary associating ``rc`` values to buildsteps results constants (e.g. ``SUCCESS``, ``FAILURE``, ``WARNINGS``)
:param stdioLogName: name of the log to which to write the command's stdio

This class handles running commands, consisting of a command name and
a dictionary of arguments. If true, ``ignore_updates`` will suppress any
updates sent from the slave.

This class handles updates for ``stdout``, ``stderr``, and ``header`` by
appending them to a ``stdio`` logfile, if one is in use. It handles
updates for ``rc`` by recording the value in its ``rc`` attribute.
This class handles updates for ``stdout``, ``stderr``, and ``header`` by appending them to s stdio logfile named by the ``stdioLogName`` parameter.
Steps that run multiple commands and want to separate those commands' stdio streams can use this parameter.

It handles updates for ``rc`` by recording the value in its ``rc`` attribute.

Most slave-side commands, even those which do not spawn a new process on
the slave, generate logs and an ``rc``, requiring this class or one of its
Expand Down

0 comments on commit c8c3215

Please sign in to comment.