X Tutup
Skip to content

Commit dc83f27

Browse files
committed
man: fully document sd-event interfaces
This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
1 parent 0be6c2f commit dc83f27

26 files changed

+3076
-502
lines changed

Makefile-man.am

Lines changed: 194 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ MANPAGES += \
2626
man/os-release.5 \
2727
man/sd-bus-errors.3 \
2828
man/sd-daemon.3 \
29+
man/sd-event.3 \
2930
man/sd-id128.3 \
3031
man/sd-journal.3 \
3132
man/sd_booted.3 \
@@ -47,12 +48,23 @@ MANPAGES += \
4748
man/sd_bus_request_name.3 \
4849
man/sd_event_add_child.3 \
4950
man/sd_event_add_defer.3 \
51+
man/sd_event_add_io.3 \
5052
man/sd_event_add_signal.3 \
5153
man/sd_event_add_time.3 \
54+
man/sd_event_exit.3 \
5255
man/sd_event_get_fd.3 \
5356
man/sd_event_new.3 \
57+
man/sd_event_now.3 \
5458
man/sd_event_run.3 \
55-
man/sd_event_set_name.3 \
59+
man/sd_event_set_watchdog.3 \
60+
man/sd_event_source_get_event.3 \
61+
man/sd_event_source_get_pending.3 \
62+
man/sd_event_source_set_description.3 \
63+
man/sd_event_source_set_enabled.3 \
64+
man/sd_event_source_set_prepare.3 \
65+
man/sd_event_source_set_priority.3 \
66+
man/sd_event_source_set_userdata.3 \
67+
man/sd_event_source_unref.3 \
5668
man/sd_event_wait.3 \
5769
man/sd_id128_get_machine.3 \
5870
man/sd_id128_randomize.3 \
@@ -199,6 +211,19 @@ MANPAGES_ALIAS += \
199211
man/SD_DEBUG.3 \
200212
man/SD_EMERG.3 \
201213
man/SD_ERR.3 \
214+
man/SD_EVENT_ARMED.3 \
215+
man/SD_EVENT_EXITING.3 \
216+
man/SD_EVENT_FINISHED.3 \
217+
man/SD_EVENT_INITIAL.3 \
218+
man/SD_EVENT_OFF.3 \
219+
man/SD_EVENT_ON.3 \
220+
man/SD_EVENT_ONESHOT.3 \
221+
man/SD_EVENT_PENDING.3 \
222+
man/SD_EVENT_PREPARING.3 \
223+
man/SD_EVENT_PRIORITY_IDLE.3 \
224+
man/SD_EVENT_PRIORITY_IMPORTANT.3 \
225+
man/SD_EVENT_PRIORITY_NORMAL.3 \
226+
man/SD_EVENT_RUNNING.3 \
202227
man/SD_ID128_CONST_STR.3 \
203228
man/SD_ID128_FORMAT_STR.3 \
204229
man/SD_ID128_FORMAT_VAL.3 \
@@ -295,21 +320,41 @@ MANPAGES_ALIAS += \
295320
man/sd_bus_ref.3 \
296321
man/sd_bus_release_name.3 \
297322
man/sd_bus_unref.3 \
323+
man/sd_event.3 \
298324
man/sd_event_add_exit.3 \
299325
man/sd_event_add_post.3 \
326+
man/sd_event_child_handler_t.3 \
300327
man/sd_event_default.3 \
301328
man/sd_event_dispatch.3 \
302-
man/sd_event_get_name.3 \
329+
man/sd_event_get_exit_code.3 \
330+
man/sd_event_get_state.3 \
331+
man/sd_event_get_tid.3 \
332+
man/sd_event_get_watchdog.3 \
333+
man/sd_event_handler_t.3 \
334+
man/sd_event_io_handler_t.3 \
303335
man/sd_event_loop.3 \
304336
man/sd_event_prepare.3 \
305337
man/sd_event_ref.3 \
338+
man/sd_event_signal_handler_t.3 \
339+
man/sd_event_source.3 \
306340
man/sd_event_source_get_child_pid.3 \
341+
man/sd_event_source_get_description.3 \
342+
man/sd_event_source_get_enabled.3 \
343+
man/sd_event_source_get_io_events.3 \
344+
man/sd_event_source_get_io_fd.3 \
345+
man/sd_event_source_get_io_revents.3 \
346+
man/sd_event_source_get_priority.3 \
307347
man/sd_event_source_get_signal.3 \
308348
man/sd_event_source_get_time.3 \
309349
man/sd_event_source_get_time_accuracy.3 \
310350
man/sd_event_source_get_time_clock.3 \
351+
man/sd_event_source_get_userdata.3 \
352+
man/sd_event_source_ref.3 \
353+
man/sd_event_source_set_io_events.3 \
354+
man/sd_event_source_set_io_fd.3 \
311355
man/sd_event_source_set_time.3 \
312356
man/sd_event_source_set_time_accuracy.3 \
357+
man/sd_event_time_handler_t.3 \
313358
man/sd_event_unref.3 \
314359
man/sd_id128_equal.3 \
315360
man/sd_id128_from_string.3 \
@@ -489,6 +534,19 @@ man/SD_CRIT.3: man/sd-daemon.3
489534
man/SD_DEBUG.3: man/sd-daemon.3
490535
man/SD_EMERG.3: man/sd-daemon.3
491536
man/SD_ERR.3: man/sd-daemon.3
537+
man/SD_EVENT_ARMED.3: man/sd_event_wait.3
538+
man/SD_EVENT_EXITING.3: man/sd_event_wait.3
539+
man/SD_EVENT_FINISHED.3: man/sd_event_wait.3
540+
man/SD_EVENT_INITIAL.3: man/sd_event_wait.3
541+
man/SD_EVENT_OFF.3: man/sd_event_source_set_enabled.3
542+
man/SD_EVENT_ON.3: man/sd_event_source_set_enabled.3
543+
man/SD_EVENT_ONESHOT.3: man/sd_event_source_set_enabled.3
544+
man/SD_EVENT_PENDING.3: man/sd_event_wait.3
545+
man/SD_EVENT_PREPARING.3: man/sd_event_wait.3
546+
man/SD_EVENT_PRIORITY_IDLE.3: man/sd_event_source_set_priority.3
547+
man/SD_EVENT_PRIORITY_IMPORTANT.3: man/sd_event_source_set_priority.3
548+
man/SD_EVENT_PRIORITY_NORMAL.3: man/sd_event_source_set_priority.3
549+
man/SD_EVENT_RUNNING.3: man/sd_event_wait.3
492550
man/SD_ID128_CONST_STR.3: man/sd-id128.3
493551
man/SD_ID128_FORMAT_STR.3: man/sd-id128.3
494552
man/SD_ID128_FORMAT_VAL.3: man/sd-id128.3
@@ -585,21 +643,41 @@ man/sd_bus_path_encode_many.3: man/sd_bus_path_encode.3
585643
man/sd_bus_ref.3: man/sd_bus_new.3
586644
man/sd_bus_release_name.3: man/sd_bus_request_name.3
587645
man/sd_bus_unref.3: man/sd_bus_new.3
646+
man/sd_event.3: man/sd_event_new.3
588647
man/sd_event_add_exit.3: man/sd_event_add_defer.3
589648
man/sd_event_add_post.3: man/sd_event_add_defer.3
649+
man/sd_event_child_handler_t.3: man/sd_event_add_child.3
590650
man/sd_event_default.3: man/sd_event_new.3
591651
man/sd_event_dispatch.3: man/sd_event_wait.3
592-
man/sd_event_get_name.3: man/sd_event_set_name.3
652+
man/sd_event_get_exit_code.3: man/sd_event_exit.3
653+
man/sd_event_get_state.3: man/sd_event_wait.3
654+
man/sd_event_get_tid.3: man/sd_event_new.3
655+
man/sd_event_get_watchdog.3: man/sd_event_set_watchdog.3
656+
man/sd_event_handler_t.3: man/sd_event_add_defer.3
657+
man/sd_event_io_handler_t.3: man/sd_event_add_io.3
593658
man/sd_event_loop.3: man/sd_event_run.3
594659
man/sd_event_prepare.3: man/sd_event_wait.3
595660
man/sd_event_ref.3: man/sd_event_new.3
661+
man/sd_event_signal_handler_t.3: man/sd_event_add_signal.3
662+
man/sd_event_source.3: man/sd_event_add_io.3
596663
man/sd_event_source_get_child_pid.3: man/sd_event_add_child.3
664+
man/sd_event_source_get_description.3: man/sd_event_source_set_description.3
665+
man/sd_event_source_get_enabled.3: man/sd_event_source_set_enabled.3
666+
man/sd_event_source_get_io_events.3: man/sd_event_add_io.3
667+
man/sd_event_source_get_io_fd.3: man/sd_event_add_io.3
668+
man/sd_event_source_get_io_revents.3: man/sd_event_add_io.3
669+
man/sd_event_source_get_priority.3: man/sd_event_source_set_priority.3
597670
man/sd_event_source_get_signal.3: man/sd_event_add_signal.3
598671
man/sd_event_source_get_time.3: man/sd_event_add_time.3
599672
man/sd_event_source_get_time_accuracy.3: man/sd_event_add_time.3
600673
man/sd_event_source_get_time_clock.3: man/sd_event_add_time.3
674+
man/sd_event_source_get_userdata.3: man/sd_event_source_set_userdata.3
675+
man/sd_event_source_ref.3: man/sd_event_source_unref.3
676+
man/sd_event_source_set_io_events.3: man/sd_event_add_io.3
677+
man/sd_event_source_set_io_fd.3: man/sd_event_add_io.3
601678
man/sd_event_source_set_time.3: man/sd_event_add_time.3
602679
man/sd_event_source_set_time_accuracy.3: man/sd_event_add_time.3
680+
man/sd_event_time_handler_t.3: man/sd_event_add_time.3
603681
man/sd_event_unref.3: man/sd_event_new.3
604682
man/sd_id128_equal.3: man/sd-id128.3
605683
man/sd_id128_from_string.3: man/sd_id128_to_string.3
@@ -857,6 +935,45 @@ man/SD_EMERG.html: man/sd-daemon.html
857935
man/SD_ERR.html: man/sd-daemon.html
858936
$(html-alias)
859937

938+
man/SD_EVENT_ARMED.html: man/sd_event_wait.html
939+
$(html-alias)
940+
941+
man/SD_EVENT_EXITING.html: man/sd_event_wait.html
942+
$(html-alias)
943+
944+
man/SD_EVENT_FINISHED.html: man/sd_event_wait.html
945+
$(html-alias)
946+
947+
man/SD_EVENT_INITIAL.html: man/sd_event_wait.html
948+
$(html-alias)
949+
950+
man/SD_EVENT_OFF.html: man/sd_event_source_set_enabled.html
951+
$(html-alias)
952+
953+
man/SD_EVENT_ON.html: man/sd_event_source_set_enabled.html
954+
$(html-alias)
955+
956+
man/SD_EVENT_ONESHOT.html: man/sd_event_source_set_enabled.html
957+
$(html-alias)
958+
959+
man/SD_EVENT_PENDING.html: man/sd_event_wait.html
960+
$(html-alias)
961+
962+
man/SD_EVENT_PREPARING.html: man/sd_event_wait.html
963+
$(html-alias)
964+
965+
man/SD_EVENT_PRIORITY_IDLE.html: man/sd_event_source_set_priority.html
966+
$(html-alias)
967+
968+
man/SD_EVENT_PRIORITY_IMPORTANT.html: man/sd_event_source_set_priority.html
969+
$(html-alias)
970+
971+
man/SD_EVENT_PRIORITY_NORMAL.html: man/sd_event_source_set_priority.html
972+
$(html-alias)
973+
974+
man/SD_EVENT_RUNNING.html: man/sd_event_wait.html
975+
$(html-alias)
976+
860977
man/SD_ID128_CONST_STR.html: man/sd-id128.html
861978
$(html-alias)
862979

@@ -1145,19 +1262,40 @@ man/sd_bus_release_name.html: man/sd_bus_request_name.html
11451262
man/sd_bus_unref.html: man/sd_bus_new.html
11461263
$(html-alias)
11471264

1265+
man/sd_event.html: man/sd_event_new.html
1266+
$(html-alias)
1267+
11481268
man/sd_event_add_exit.html: man/sd_event_add_defer.html
11491269
$(html-alias)
11501270

11511271
man/sd_event_add_post.html: man/sd_event_add_defer.html
11521272
$(html-alias)
11531273

1274+
man/sd_event_child_handler_t.html: man/sd_event_add_child.html
1275+
$(html-alias)
1276+
11541277
man/sd_event_default.html: man/sd_event_new.html
11551278
$(html-alias)
11561279

11571280
man/sd_event_dispatch.html: man/sd_event_wait.html
11581281
$(html-alias)
11591282

1160-
man/sd_event_get_name.html: man/sd_event_set_name.html
1283+
man/sd_event_get_exit_code.html: man/sd_event_exit.html
1284+
$(html-alias)
1285+
1286+
man/sd_event_get_state.html: man/sd_event_wait.html
1287+
$(html-alias)
1288+
1289+
man/sd_event_get_tid.html: man/sd_event_new.html
1290+
$(html-alias)
1291+
1292+
man/sd_event_get_watchdog.html: man/sd_event_set_watchdog.html
1293+
$(html-alias)
1294+
1295+
man/sd_event_handler_t.html: man/sd_event_add_defer.html
1296+
$(html-alias)
1297+
1298+
man/sd_event_io_handler_t.html: man/sd_event_add_io.html
11611299
$(html-alias)
11621300

11631301
man/sd_event_loop.html: man/sd_event_run.html
@@ -1169,9 +1307,33 @@ man/sd_event_prepare.html: man/sd_event_wait.html
11691307
man/sd_event_ref.html: man/sd_event_new.html
11701308
$(html-alias)
11711309

1310+
man/sd_event_signal_handler_t.html: man/sd_event_add_signal.html
1311+
$(html-alias)
1312+
1313+
man/sd_event_source.html: man/sd_event_add_io.html
1314+
$(html-alias)
1315+
11721316
man/sd_event_source_get_child_pid.html: man/sd_event_add_child.html
11731317
$(html-alias)
11741318

1319+
man/sd_event_source_get_description.html: man/sd_event_source_set_description.html
1320+
$(html-alias)
1321+
1322+
man/sd_event_source_get_enabled.html: man/sd_event_source_set_enabled.html
1323+
$(html-alias)
1324+
1325+
man/sd_event_source_get_io_events.html: man/sd_event_add_io.html
1326+
$(html-alias)
1327+
1328+
man/sd_event_source_get_io_fd.html: man/sd_event_add_io.html
1329+
$(html-alias)
1330+
1331+
man/sd_event_source_get_io_revents.html: man/sd_event_add_io.html
1332+
$(html-alias)
1333+
1334+
man/sd_event_source_get_priority.html: man/sd_event_source_set_priority.html
1335+
$(html-alias)
1336+
11751337
man/sd_event_source_get_signal.html: man/sd_event_add_signal.html
11761338
$(html-alias)
11771339

@@ -1184,12 +1346,27 @@ man/sd_event_source_get_time_accuracy.html: man/sd_event_add_time.html
11841346
man/sd_event_source_get_time_clock.html: man/sd_event_add_time.html
11851347
$(html-alias)
11861348

1349+
man/sd_event_source_get_userdata.html: man/sd_event_source_set_userdata.html
1350+
$(html-alias)
1351+
1352+
man/sd_event_source_ref.html: man/sd_event_source_unref.html
1353+
$(html-alias)
1354+
1355+
man/sd_event_source_set_io_events.html: man/sd_event_add_io.html
1356+
$(html-alias)
1357+
1358+
man/sd_event_source_set_io_fd.html: man/sd_event_add_io.html
1359+
$(html-alias)
1360+
11871361
man/sd_event_source_set_time.html: man/sd_event_add_time.html
11881362
$(html-alias)
11891363

11901364
man/sd_event_source_set_time_accuracy.html: man/sd_event_add_time.html
11911365
$(html-alias)
11921366

1367+
man/sd_event_time_handler_t.html: man/sd_event_add_time.html
1368+
$(html-alias)
1369+
11931370
man/sd_event_unref.html: man/sd_event_new.html
11941371
$(html-alias)
11951372

@@ -2264,6 +2441,7 @@ EXTRA_DIST += \
22642441
man/runlevel.xml \
22652442
man/sd-bus-errors.xml \
22662443
man/sd-daemon.xml \
2444+
man/sd-event.xml \
22672445
man/sd-id128.xml \
22682446
man/sd-journal.xml \
22692447
man/sd-login.xml \
@@ -2286,12 +2464,23 @@ EXTRA_DIST += \
22862464
man/sd_bus_request_name.xml \
22872465
man/sd_event_add_child.xml \
22882466
man/sd_event_add_defer.xml \
2467+
man/sd_event_add_io.xml \
22892468
man/sd_event_add_signal.xml \
22902469
man/sd_event_add_time.xml \
2470+
man/sd_event_exit.xml \
22912471
man/sd_event_get_fd.xml \
22922472
man/sd_event_new.xml \
2473+
man/sd_event_now.xml \
22932474
man/sd_event_run.xml \
2294-
man/sd_event_set_name.xml \
2475+
man/sd_event_set_watchdog.xml \
2476+
man/sd_event_source_get_event.xml \
2477+
man/sd_event_source_get_pending.xml \
2478+
man/sd_event_source_set_description.xml \
2479+
man/sd_event_source_set_enabled.xml \
2480+
man/sd_event_source_set_prepare.xml \
2481+
man/sd_event_source_set_priority.xml \
2482+
man/sd_event_source_set_userdata.xml \
2483+
man/sd_event_source_unref.xml \
22952484
man/sd_event_wait.xml \
22962485
man/sd_get_seats.xml \
22972486
man/sd_id128_get_machine.xml \

man/sd-daemon.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@
7171
<refsect1>
7272
<title>Description</title>
7373

74-
<para><filename>sd-daemon.h</filename> provide APIs for new-style
74+
<para><filename>sd-daemon.h</filename> provides APIs for new-style
7575
daemons, as implemented by the
7676
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
77-
init system.</para>
77+
service manager.</para>
7878

7979
<para>See
8080
<citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

0 commit comments

Comments
 (0)
X Tutup