summaryrefslogtreecommitdiff
path: root/man/sd_event_source_set_prepare.xml
diff options
context:
space:
mode:
authorMartin Ejdestig <marejde@gmail.com>2016-12-05 23:42:41 +0100
committerLennart Poettering <lennart@poettering.net>2016-12-05 23:42:41 +0100
commit95977da98ca9b300af5ac1212200a3ad36b5ec51 (patch)
treeba1e4e18cb636fe935531bc26dc534a95a2eaf58 /man/sd_event_source_set_prepare.xml
parentc9fd987279a462e406fac6c7ade01da7410bdcd6 (diff)
downloadsystemd-95977da98ca9b300af5ac1212200a3ad36b5ec51.tar.gz
man: Document return value of event source prepare callback (#4834)
Diffstat (limited to 'man/sd_event_source_set_prepare.xml')
-rw-r--r--man/sd_event_source_set_prepare.xml9
1 files changed, 5 insertions, 4 deletions
diff --git a/man/sd_event_source_set_prepare.xml b/man/sd_event_source_set_prepare.xml
index 24861d01d9..ee61d23983 100644
--- a/man/sd_event_source_set_prepare.xml
+++ b/man/sd_event_source_set_prepare.xml
@@ -76,10 +76,11 @@
specified as <parameter>callback</parameter> will be invoked
immediately before the event loop goes to sleep to wait for
incoming events. It is invoked with the user data pointer passed
- when the event source was created. The callback function may be
- used to reconfigure the precise events to wait for. If the
- <parameter>callback</parameter> parameter is passed as NULL the
- callback function is reset. </para>
+ when the event source was created. The event source will be disabled
+ if the callback function returns a negative error code. The callback
+ function may be used to reconfigure the precise events to wait for.
+ If the <parameter>callback</parameter> parameter is passed as NULL
+ the callback function is reset. </para>
<para>Event source objects have no preparation callback associated
when they are first created with calls such as