forked from flux-framework/flux-core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: document flux_watcher_set_priority(3)
Problem: There is no documentation for flux_watcher_set_priority(3). Add it in the docs.
- Loading branch information
Showing
4 changed files
with
45 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
=========================== | ||
flux_idle_watcher_create(3) | ||
=========================== | ||
|
||
.. default-domain:: c | ||
|
||
SYNOPSIS | ||
======== | ||
|
||
.. code-block:: c | ||
#include <flux/core.h> | ||
flux_watcher_t *flux_watcher_set_priority (flux_watcher_t *w, | ||
int priority); | ||
Link with :command:`-lflux-core`. | ||
|
||
DESCRIPTION | ||
=========== | ||
|
||
:func:`flux_watcher_set_priority` sets the priority on the watcher. | ||
Higher priority watchers run first. The range of priorities is from | ||
-2 to 2, with the default being 0. If the priority is out | ||
of range, the max or min value is set. | ||
|
||
This function is a no-op if the underlying watcher does not support priorities. | ||
Currently only the check watcher supports priorities. | ||
|
||
|
||
RESOURCES | ||
========= | ||
|
||
.. include:: common/resources.rst | ||
|
||
libev: http://software.schmorp.de/pkg/libev.html | ||
|
||
|
||
SEE ALSO | ||
======== | ||
|
||
:man3:`flux_check_watcher_create` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters