shaba/systemd-stable
1
1
Fork 0
mirror of https://github.com/systemd/systemd-stable.git synced 2024-12-23 17:34:00 +03:00
Code

man: document the Dump() calls of the PID 1 D-Bus interface, and what they are

Browse Source 
(cherry picked from commit 0df8512124)
This commit is contained in:
Lennart Poettering 2022-09-27 12:18:43 +02:00 committed by Zbigniew Jędrzejewski-Szmek
parent 140fee4627
commit c4fd38f7d2
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
man/org.freedesktop.systemd1.xml
View File

@ -554,10 +554,6 @@ node /org/freedesktop/systemd1 {
<!--method ListUnitsByNames is not documented!-->
<!--method Dump is not documented!-->
<!--method DumpByFileDescriptor is not documented!-->
<!--method ListUnitFilesByPatterns is not documented!-->
<!--method PresetUnitFilesWithMode is not documented!-->
@ -1312,6 +1308,20 @@ node /org/freedesktop/systemd1 {
all clients which previously asked for <function>Subscribe()</function> either closed their connection
to the bus or invoked <function>Unsubscribe()</function>.</para>
<para><function>Dump()</function> returns a text dump of the internal service manager state. This is a
privileged, low-level debugging interface only. The returned string is supposed to be readable
exclusively by developers, and not programmatically. There's no interface stability on the returned
string guaranteed, and new fields may be added any time, and old fields removed. The general structure
may be rearranged drastically between releases. This is exposed by
<citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<command>dump</command> command. The <function>DumpByFileDescriptor()</function> method is identical to
<function>Dump()</function> but returns the data serialized into a file descriptor (the client should
read the text data from it until hitting EOF). Given the size limits on D-Bus messages and the possibly
large size of the returned string, <function>DumpByFileDescriptor()</function> is usually the
preferable interface, since it ensures the data can be passed reliably from the service manager to the
client. (Note though that <function>DumpByFileDescriptor()</function> cannot work when communicating
with the service manager remotely, as file descriptors are strictly local to a system.)</para>
<para><function>Reload()</function> may be invoked to reload all unit files.</para>
<para><function>Reexecute()</function> may be invoked to reexecute the main manager process. It will