openstack/ironic
Code Issues Proposed changes

Documentation: Describe the 'spacing' argument

Browse Source 
Explain that the 'spacing' argument takes number of seconds.  So
'spacing=5' means to run every 5 seconds.

Change-Id: I3b58fbe5c0adfd7f659d6c098533804bbf00d778
Signed-off-by: John L. Villalovos <john.l.villalovos@intel.com>
This commit is contained in:
John L. Villalovos 2015-02-04 13:18:49 -08:00
parent f099e69762
commit 150309f10a
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/dev/architecture.rst
View File

@ -98,7 +98,8 @@ driver itself or on any interface with driver_periodic_task_ decorator, e.g.
pass # do something fast, this blocks other tasks from starting! pass # do something fast, this blocks other tasks from starting!
Here ``spacing`` argument is a period for a given periodic task. Here the ``spacing`` argument is a period in seconds for a given periodic task.
For example 'spacing=5' means every 5 seconds.
The ``parallel`` argument may be passed to driver_periodic_task_ and defaults The ``parallel`` argument may be passed to driver_periodic_task_ and defaults
to True. If False, this task will be run in the periodic task loop, rather to True. If False, this task will be run in the periodic task loop, rather