From ce245c842b5409cb961e49f7fd98cdbed05d07a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 25 Jan 2016 18:54:31 -0500 Subject: [PATCH 1/4] build-sys: provide fallback value for xsltproc Commit ab6f56debf made the change to allow building man pages even when disabled with ./configure --disable-manpages. This works fine, as long as xsltproc is present. If xsltproc is not present, the command to build a man page (obviously) fails. Unfortnately it fails with a cryptic message '-o not found', because $(XSLTPROC) is empty. Add a fallback, to use 'xsltproc' is $(XSLTPROC) is not defined. This way we get a nice message: make: xsltproc: Command not found --- Makefile.am | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Makefile.am b/Makefile.am index 4218a6dcdf..1f204b826c 100644 --- a/Makefile.am +++ b/Makefile.am @@ -6043,11 +6043,12 @@ XSLTPROC_FLAGS = \ --stringparam systemd.version $(VERSION) \ --path '$(builddir)/man:$(srcdir)/man' +XSLT = $(if $(XSLTPROC), $(XSLTPROC), xsltproc) XSLTPROC_PROCESS_MAN = \ - $(AM_V_XSLT)$(XSLTPROC) -o $@ $(XSLTPROC_FLAGS) $(srcdir)/man/custom-man.xsl $< + $(AM_V_XSLT)$(XSLT) -o $@ $(XSLTPROC_FLAGS) $(srcdir)/man/custom-man.xsl $< XSLTPROC_PROCESS_HTML = \ - $(AM_V_XSLT)$(XSLTPROC) -o $@ $(XSLTPROC_FLAGS) $(srcdir)/man/custom-html.xsl $< + $(AM_V_XSLT)$(XSLT) -o $@ $(XSLTPROC_FLAGS) $(srcdir)/man/custom-html.xsl $< man/%.1: man/%.xml man/custom-man.xsl man/custom-entities.ent $(XSLTPROC_PROCESS_MAN) From 524f3e5c9d1eb2fba3d0b65d1790018163ba0b20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 25 Jan 2016 17:56:42 -0500 Subject: [PATCH 2/4] man: fix references to a few external man pages Noticed in pull request #2067. --- man/resolved.conf.xml | 2 +- man/systemd-ask-password.xml | 4 ++-- man/systemd.nspawn.xml | 2 +- man/udev_device_new_from_syspath.xml | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/man/resolved.conf.xml b/man/resolved.conf.xml index 3ab7fc4a11..09a192c933 100644 --- a/man/resolved.conf.xml +++ b/man/resolved.conf.xml @@ -210,7 +210,7 @@ systemd-resolved.service8, systemd-networkd.service8, dnssec-trust-anchors.d5, - resolv.conf4 + resolv.conf4 diff --git a/man/systemd-ask-password.xml b/man/systemd-ask-password.xml index 6fb322e849..2a4d24349b 100644 --- a/man/systemd-ask-password.xml +++ b/man/systemd-ask-password.xml @@ -149,7 +149,7 @@ possible to cache multiple passwords under the same keyname, in which case they will be stored as NUL-separated list of passwords. Use - keyctl1 + keyctl1 to access the cached key via the kernel keyring directly. Example: --keyname=cryptsetup @@ -209,7 +209,7 @@ systemd1, systemctl1, - keyctl1, + keyctl1, plymouth8, wall1 diff --git a/man/systemd.nspawn.xml b/man/systemd.nspawn.xml index e952688331..f39e1ad42c 100644 --- a/man/systemd.nspawn.xml +++ b/man/systemd.nspawn.xml @@ -192,7 +192,7 @@ Takes a space-separated list of Linux process capabilities (see - capabilities7 + capabilities7 for details). The Capability= setting specifies additional capabilities to pass on top of the default set of capabilities. The diff --git a/man/udev_device_new_from_syspath.xml b/man/udev_device_new_from_syspath.xml index 11db1a0fab..c71356a75a 100644 --- a/man/udev_device_new_from_syspath.xml +++ b/man/udev_device_new_from_syspath.xml @@ -134,7 +134,7 @@ a uevent file. udev_device_new_from_devnum takes a device type, which can be b for block devices or c for character devices, as well as a devnum (see - makedev3). + makedev3). udev_device_new_from_subsystem_sysname looks up devices based on the provided subsystem and sysname (see udev_device_get_subsystem3 @@ -171,7 +171,7 @@ udev_device_new_from_environment creates a device from the current environment (see - environ7). + environ7). Each key-value pair is interpreted in the same way as if it was received in an uevent (see udev_monitor_receive_device3). From a3972469b2c11c8c9201f67e88907207eaaaecba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 25 Jan 2016 19:05:47 -0500 Subject: [PATCH 3/4] man: fix reference to sd_event_source_get_io_revents --- man/sd_event_source_get_pending.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/sd_event_source_get_pending.xml b/man/sd_event_source_get_pending.xml index 1c06e81fe0..7f88bd1b87 100644 --- a/man/sd_event_source_get_pending.xml +++ b/man/sd_event_source_get_pending.xml @@ -87,7 +87,7 @@ For I/O event sources, as created with sd_event_add_io3, the call - sd_event_get_io_revents3 + sd_event_source_get_io_revents3 may be used to query the type of event pending in more detail. From 6a089ddddd2d4a2b8ef99989d4be6e476883d088 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 25 Jan 2016 20:20:58 -0500 Subject: [PATCH 4/4] man: add stub sd-bus(3) We have 126 broken links to sd-bus.html, it's nice to fix that. Current version is mostly a stub, with a long list of links to other pages. I think that's fine, especially that sd-bus might evolve quite a bit before it is made public. Not all of linked pages are written. Still missing: sd_bus_can_send sd_bus_get_name_creds sd_bus_get_owner_creds sd_bus_message_can_send sd_bus_message_get_creds sd_bus_message_set_allow_interactive_authorization sd_bus_send sd_bus_set_address sd_bus_set_description sd_bus_start sd_event_set_prepare sd-device systemd.busname --- Makefile-man.am | 2 + man/sd-bus.xml | 123 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 125 insertions(+) create mode 100644 man/sd-bus.xml diff --git a/Makefile-man.am b/Makefile-man.am index bcb67166ba..0055746a70 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -25,6 +25,7 @@ MANPAGES += \ man/machine-info.5 \ man/os-release.5 \ man/sd-bus-errors.3 \ + man/sd-bus.3 \ man/sd-daemon.3 \ man/sd-event.3 \ man/sd-id128.3 \ @@ -2478,6 +2479,7 @@ EXTRA_DIST += \ man/resolved.conf.xml \ man/runlevel.xml \ man/sd-bus-errors.xml \ + man/sd-bus.xml \ man/sd-daemon.xml \ man/sd-event.xml \ man/sd-id128.xml \ diff --git a/man/sd-bus.xml b/man/sd-bus.xml new file mode 100644 index 0000000000..336dd33ea0 --- /dev/null +++ b/man/sd-bus.xml @@ -0,0 +1,123 @@ + + + + + + + + + sd-bus + systemd + + + + Documentation + Zbigniew + Jędrzejewski-Szmek + zbyszek@in.waw.pl + + + + + + sd-bus + 3 + + + + sd-bus + A lightweight D-Bus and kdbus client library + + + + + #include <systemd/sd-bus.h> + + + + pkg-config --cflags --libs libsystemd + + + + + + Description + + sd-bus.h provides an implementation + of a D-Bus client. It can interoperate both with the traditional + dbus-daemon1, + and with kdbus. See + + for more information about the big picture. + + + + Interfaces described here have not been declared stable yet, + and are not accessible from libsystemd.so. + This documentation is provided in hope it might be useful for + developers, without any guarantees of availability or stability. + + + + See + sd_bus_default3, + sd_bus_new3, + sd_bus_request_name3, + sd_bus_start3, + sd_bus_message_append3, + sd_bus_message_append_basic3, + sd_bus_message_append_array3, + sd_bus_message_append_string_memfd3, + sd_bus_message_append_strv3, + sd_bus_message_can_send3, + sd_bus_message_get_cookie3, + sd_bus_message_get_monotonic_usec3, + sd_bus_send3, + sd_bus_set_address3, + sd_bus_set_description3, + sd_bus_set_prepare3, + sd_bus_creds_get_pid3, + sd_bus_creds_new_from_pid3, + sd_bus_get_name_creds3, + sd_bus_get_owner_creds3, + sd_bus_negotiate_fds3, + sd_bus_path_encode3, + sd-bus-errors3, + sd_bus_error3, + sd_bus_error_add_map3, + sd_bus_set_allow_interactive_authorization3 + for more information about the functions available. + + + + + + See Also + + systemd1, + sd-event3, + dbus-daemon1, + dbus-send1, + gdbus + + + +