Skip to content

Commit

Permalink
cls-protocols.rst: update remoteInterruptCommand prototype description
Browse files Browse the repository at this point in the history
Update the doc to be aligned with the fix
implemented in 7c9a059.
  • Loading branch information
yetanotherion committed Jun 6, 2015
1 parent b98f47f commit e107985
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions master/docs/developer/cls-protocols.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,17 @@ to know about protocol calls or handle protocol specific exceptions.

Just starts build

.. py:method:: remoteInterruptCommand(commandId, why)
.. py:method:: remoteInterruptCommand(builderName, commandId, why)
:param builderName: self explanatory
:type builderName: string
:param commandId: command number
:type commandId: string
:param why: reason to interrupt
:type why: string
:returns: Deferred

Interrupt command with given CommandID on slave, print reason "why" to
Interrupt the command executed on builderName with given commandId on slave, print reason "why" to
slave logs

Following classes are describing the slave -> master part of the protocol.
Expand Down

0 comments on commit e107985

Please sign in to comment.