oslo.concurrency/doc/source/reference/index.rst

===============
 API Reference
===============

.. toctree::
   :maxdepth: 1

   fixture.lockutils
   lockutils
   opts
   processutils
   watchdog
   api/modules
rearrange existing documentation to follow the new layout standard Change-Id: I79d7b97c7e9395f75fa158d870485853418a4db7 Signed-off-by: Doug Hellmann <doug@doughellmann.com> 2017-07-07 14:26:34 -04:00			`===============`
			`API Reference`
			`===============`

Clean up API documentation Use explicit files instead of auto-generating them. Fail the build on a warning. Tweak titles and other headings. Add instructions for using lockutils-wrapper. Change-Id: Ie92ce14b33180d35d84bbd0998e61b659487481d 2014-12-10 08:31:04 -05:00			`.. toctree::`
			`:maxdepth: 1`

			`fixture.lockutils`
			`lockutils`
			`opts`
			`processutils`
add watchdog module This provides the watchdog.watch function which is a contextmanager that can be used before doing operations that have a high risk of deadlocking or aberrantly taking huge amounts of time to complete (which could be the root cause for other issues). Unit tests require the use of sleep to make the timers pop either before or after the event in question. There is 1 second buffer that's encoded into each scenario which should be sufficient for unit tests (even in busy systems). If that turns into an issue later, the buffer can be increased (I was only seeing real skew of 1-2 ms locally). Change-Id: I79e39f8a4aa702627ca39bea3e6fc672134b8a72 2015-01-09 11:27:55 -05:00			`watchdog`
Follow the new PTI for document build For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html For more detials information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: I4b1b023ff2c40f5b31429584fc1a77c0315ed2d9 Co-Authored-By: Stephen Finucane <stephenfin@redhat.com> 2018-03-02 09:00:54 +08:00			`api/modules`