1
0
mirror of https://github.com/systemd/systemd.git synced 2025-01-31 05:47:30 +03:00

man: suffix signals with ()

Since signals can take arguments, let's suffix them with () as we
already do with functions. To make sure we remain consistent, make the
`update-dbus-docs.py` script check & fix any occurrences where this is
not the case.

Resolves: #31002
This commit is contained in:
Frantisek Sumsal 2024-01-23 13:06:55 +01:00 committed by Lennart Poettering
parent 3bda8bc58c
commit 43b238f1c1
7 changed files with 94 additions and 105 deletions

View File

@ -131,9 +131,9 @@ node /org/freedesktop/import1 {
<variablelist class="dbus-method" generated="True" extra-ref="CancelTransfer()"/> <variablelist class="dbus-method" generated="True" extra-ref="CancelTransfer()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="TransferNew"/> <variablelist class="dbus-signal" generated="True" extra-ref="TransferNew()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="TransferRemoved"/> <variablelist class="dbus-signal" generated="True" extra-ref="TransferRemoved()"/>
<!--End of Autogenerated section--> <!--End of Autogenerated section-->
@ -169,7 +169,7 @@ node /org/freedesktop/import1 {
be used to retrieve progress information about the transfer or to cancel it. The transfer identifier is a be used to retrieve progress information about the transfer or to cancel it. The transfer identifier is a
simple numeric identifier, the object path references an simple numeric identifier, the object path references an
<interfacename>org.freedesktop.import1.Transfer</interfacename> object, see below. Listen for a <interfacename>org.freedesktop.import1.Transfer</interfacename> object, see below. Listen for a
<function>TransferRemoved</function> signal for the transfer ID in order to detect when a transfer is <function>TransferRemoved()</function> signal for the transfer ID in order to detect when a transfer is
complete. The returned transfer object is useful to determine the current progress or log output of the complete. The returned transfer object is useful to determine the current progress or log output of the
ongoing import operation.</para> ongoing import operation.</para>
@ -220,11 +220,11 @@ node /org/freedesktop/import1 {
<refsect2> <refsect2>
<title>Signals</title> <title>Signals</title>
<para>The <function>TransferNew</function> signal is generated each time a new transfer is started with <para>The <function>TransferNew()</function> signal is generated each time a new transfer is started with
the import, export or download calls described above. It carries the transfer ID and object path that the import, export or download calls described above. It carries the transfer ID and object path that
have just been created.</para> have just been created.</para>
<para>The <function>TransferRemoved</function> signal is sent each time a transfer finishes, <para>The <function>TransferRemoved()</function> signal is sent each time a transfer finishes,
is canceled or fails. It also carries the transfer ID and object path, followed by a string indicating is canceled or fails. It also carries the transfer ID and object path, followed by a string indicating
the result of the operation, which is one of <literal>done</literal> (on success), the result of the operation, which is one of <literal>done</literal> (on success),
<literal>canceled</literal> or <literal>failed</literal>.</para> <literal>canceled</literal> or <literal>failed</literal>.</para>
@ -272,7 +272,7 @@ node /org/freedesktop/import1/transfer/_1 {
<variablelist class="dbus-method" generated="True" extra-ref="Cancel()"/> <variablelist class="dbus-method" generated="True" extra-ref="Cancel()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="LogMessage"/> <variablelist class="dbus-signal" generated="True" extra-ref="LogMessage()"/>
<variablelist class="dbus-property" generated="True" extra-ref="Id"/> <variablelist class="dbus-property" generated="True" extra-ref="Id"/>

View File

@ -428,23 +428,23 @@ node /org/freedesktop/login1 {
<variablelist class="dbus-method" generated="True" extra-ref="SetWallMessage()"/> <variablelist class="dbus-method" generated="True" extra-ref="SetWallMessage()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="SessionNew"/> <variablelist class="dbus-signal" generated="True" extra-ref="SessionNew()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="SessionRemoved"/> <variablelist class="dbus-signal" generated="True" extra-ref="SessionRemoved()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="UserNew"/> <variablelist class="dbus-signal" generated="True" extra-ref="UserNew()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="UserRemoved"/> <variablelist class="dbus-signal" generated="True" extra-ref="UserRemoved()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="SeatNew"/> <variablelist class="dbus-signal" generated="True" extra-ref="SeatNew()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="SeatRemoved"/> <variablelist class="dbus-signal" generated="True" extra-ref="SeatRemoved()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="PrepareForShutdown"/> <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForShutdown()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="PrepareForShutdownWithMetadata"/> <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForShutdownWithMetadata()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="PrepareForSleep"/> <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForSleep()"/>
<variablelist class="dbus-property" generated="True" extra-ref="EnableWallMessages"/> <variablelist class="dbus-property" generated="True" extra-ref="EnableWallMessages"/>
@ -726,14 +726,14 @@ node /org/freedesktop/login1 {
<para>Whenever the inhibition state or idle hint changes, <function>PropertyChanged</function> <para>Whenever the inhibition state or idle hint changes, <function>PropertyChanged</function>
signals are sent out to which clients can subscribe.</para> signals are sent out to which clients can subscribe.</para>
<para>The <function>SessionNew</function>, <function>SessionRemoved</function>, <para>The <function>SessionNew()</function>, <function>SessionRemoved()</function>,
<function>UserNew</function>, <function>UserRemoved</function>, <function>SeatNew</function>, and <function>UserNew()</function>, <function>UserRemoved()</function>, <function>SeatNew()</function>, and
<function>SeatRemoved</function> signals are sent each time a session is created or removed, a user <function>SeatRemoved()</function> signals are sent each time a session is created or removed, a user
logs in or out, or a seat is added or removed. They each contain the ID of the object plus the object logs in or out, or a seat is added or removed. They each contain the ID of the object plus the object
path.</para> path.</para>
<para>The <function>PrepareForShutdown</function>, <para>The <function>PrepareForShutdown()</function>,
<function>PrepareForShutdownWithMetadata</function>, and <function>PrepareForSleep</function> <function>PrepareForShutdownWithMetadata()</function>, and <function>PrepareForSleep()</function>
signals are sent right before (with the argument <literal>true</literal>) or after (with the argument signals are sent right before (with the argument <literal>true</literal>) or after (with the argument
<literal>false</literal>) the system goes down for reboot/poweroff and suspend/hibernate, <literal>false</literal>) the system goes down for reboot/poweroff and suspend/hibernate,
respectively. This may be used by applications to save data on disk, release memory, or do other jobs respectively. This may be used by applications to save data on disk, release memory, or do other jobs
@ -745,7 +745,7 @@ node /org/freedesktop/login1 {
pair metadata fields. Currently it sends a <varname>type</varname> string which defines the type of pair metadata fields. Currently it sends a <varname>type</varname> string which defines the type of
shutdown. The type can be one of <literal>power-off</literal>, <literal>reboot</literal>, shutdown. The type can be one of <literal>power-off</literal>, <literal>reboot</literal>,
<literal>halt</literal>, <literal>kexec</literal> or <literal>soft-reboot</literal>. This signal is <literal>halt</literal>, <literal>kexec</literal> or <literal>soft-reboot</literal>. This signal is
sent first, followed by <function>PrepareForShutdown</function> (for backward compatibility).</para> sent first, followed by <function>PrepareForShutdown()</function> (for backward compatibility).</para>
</refsect2> </refsect2>
<refsect2> <refsect2>
@ -788,8 +788,8 @@ node /org/freedesktop/login1 {
for more information.</para> for more information.</para>
<para>The <varname>PreparingForShutdown</varname> and <varname>PreparingForSleep</varname> boolean <para>The <varname>PreparingForShutdown</varname> and <varname>PreparingForSleep</varname> boolean
properties are true during the interval between the two <function>PrepareForShutdown</function> and properties are true during the interval between the two <function>PrepareForShutdown()</function> and
<function>PrepareForSleep</function> signals respectively. Note that these properties do not <function>PrepareForSleep()</function> signals respectively. Note that these properties do not
send out <function>PropertyChanged</function> signals.</para> send out <function>PropertyChanged</function> signals.</para>
<para>The <varname>RebootParameter</varname> property shows the value set with the <para>The <varname>RebootParameter</varname> property shows the value set with the
@ -800,9 +800,9 @@ node /org/freedesktop/login1 {
<para><varname>RebootToFirmwareSetup</varname>, <varname>RebootToBootLoaderMenu</varname>, and <para><varname>RebootToFirmwareSetup</varname>, <varname>RebootToBootLoaderMenu</varname>, and
<varname>RebootToBootLoaderEntry</varname> are true when the resprective post-reboot operation was <varname>RebootToBootLoaderEntry</varname> are true when the resprective post-reboot operation was
selected with <function>SetRebootToFirmwareSetup</function>, selected with <function>SetRebootToFirmwareSetup()</function>,
<function>SetRebootToBootLoaderMenu</function>, or <function>SetRebootToBootLoaderMenu()</function>, or
<function>SetRebootToBootLoaderEntry</function>.</para> <function>SetRebootToBootLoaderEntry()</function>.</para>
<para>The <varname>WallMessage</varname> and <varname>EnableWallMessages</varname> properties reflect the <para>The <varname>WallMessage</varname> and <varname>EnableWallMessages</varname> properties reflect the
shutdown reason and wall message enablement switch which can be set with the shutdown reason and wall message enablement switch which can be set with the
@ -847,15 +847,15 @@ node /org/freedesktop/login1 {
the inhibits of the auto-selected sleep operation. <function>SetRebootParameter()</function> requires the inhibits of the auto-selected sleep operation. <function>SetRebootParameter()</function> requires
<interfacename>org.freedesktop.login1.set-reboot-parameter</interfacename>.</para> <interfacename>org.freedesktop.login1.set-reboot-parameter</interfacename>.</para>
<para><function>SetRebootToFirmwareSetup</function> requires <para><function>SetRebootToFirmwareSetup()</function> requires
<interfacename>org.freedesktop.login1.set-reboot-to-firmware-setup</interfacename>. <interfacename>org.freedesktop.login1.set-reboot-to-firmware-setup</interfacename>.
<function>SetRebootToBootLoaderMenu</function> requires <function>SetRebootToBootLoaderMenu()</function> requires
<interfacename>org.freedesktop.login1.set-reboot-to-boot-loader-menu</interfacename>. <interfacename>org.freedesktop.login1.set-reboot-to-boot-loader-menu</interfacename>.
<function>SetRebootToBootLoaderEntry</function> requires <function>SetRebootToBootLoaderEntry()</function> requires
<interfacename>org.freedesktop.login1.set-reboot-to-boot-loader-entry</interfacename>. <interfacename>org.freedesktop.login1.set-reboot-to-boot-loader-entry</interfacename>.
</para> </para>
<para><function>ScheduleShutdown</function> and <function>CancelScheduledShutdown</function> require <para><function>ScheduleShutdown()</function> and <function>CancelScheduledShutdown()</function> require
the same privileges (listed above) as the immediate poweroff/reboot/halt operations.</para> the same privileges (listed above) as the immediate poweroff/reboot/halt operations.</para>
<para><function>Inhibit()</function> is protected via one of <para><function>Inhibit()</function> is protected via one of
@ -1255,13 +1255,13 @@ node /org/freedesktop/login1/session/1 {
<variablelist class="dbus-method" generated="True" extra-ref="SetBrightness()"/> <variablelist class="dbus-method" generated="True" extra-ref="SetBrightness()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="PauseDevice"/> <variablelist class="dbus-signal" generated="True" extra-ref="PauseDevice()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="ResumeDevice"/> <variablelist class="dbus-signal" generated="True" extra-ref="ResumeDevice()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="Lock"/> <variablelist class="dbus-signal" generated="True" extra-ref="Lock()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="Unlock"/> <variablelist class="dbus-signal" generated="True" extra-ref="Unlock()"/>
<variablelist class="dbus-property" generated="True" extra-ref="Id"/> <variablelist class="dbus-property" generated="True" extra-ref="Id"/>
@ -1393,28 +1393,28 @@ node /org/freedesktop/login1/session/1 {
<refsect2> <refsect2>
<title>Signals</title> <title>Signals</title>
<para>The active session controller exclusively gets <function>PauseDevice</function> and <para>The active session controller exclusively gets <function>PauseDevice()</function> and
<function>ResumeDevice</function> events for any device it requested via <function>ResumeDevice()</function> events for any device it requested via
<function>TakeDevice()</function>. They notify the controller whenever a device is paused or resumed. A <function>TakeDevice()</function>. They notify the controller whenever a device is paused or resumed. A
device is never resumed if its session is inactive. Also note that <function>PauseDevice</function> device is never resumed if its session is inactive. Also note that <function>PauseDevice()</function>
signals are sent before the <function>PropertyChanged</function> signal for the signals are sent before the <function>PropertyChanged</function> signal for the
<function>Active</function> state. The inverse is true for <function>ResumeDevice</function>. A device <function>Active</function> state. The inverse is true for <function>ResumeDevice()</function>. A device
may remain paused for unknown reasons even though the <interfacename>Session</interfacename> is active. may remain paused for unknown reasons even though the <interfacename>Session</interfacename> is active.
</para> </para>
<para>A <function>PauseDevice</function> signal carries the major and minor numbers and a string describing the <para>A <function>PauseDevice()</function> signal carries the major and minor numbers and a string describing the
type as arguments. <function>force</function> means the device was already paused by type as arguments. <function>force</function> means the device was already paused by
<filename>systemd-logind</filename> and the signal is only an asynchronous <filename>systemd-logind</filename> and the signal is only an asynchronous
notification. <function>pause</function> means <filename>systemd-logind</filename> grants you a limited amount of time to pause the device. You must respond to this via notification. <function>pause</function> means <filename>systemd-logind</filename> grants you a limited amount of time to pause the device. You must respond to this via
<function>PauseDeviceComplete()</function>. This synchronous pausing mechanism is used for <function>PauseDeviceComplete()</function>. This synchronous pausing mechanism is used for
backwards-compatibility to VTs and <filename>systemd-logind</filename> is free to not make use of backwards-compatibility to VTs and <filename>systemd-logind</filename> is free to not make use of
it. It is also free to send a forced <function>PauseDevice</function> if you don't respond in a timely it. It is also free to send a forced <function>PauseDevice()</function> if you don't respond in a timely
manner (or for any other reason). <function>gone</function> means the device was unplugged from the manner (or for any other reason). <function>gone</function> means the device was unplugged from the
system and you will no longer get any notifications about it. There is no need to call system and you will no longer get any notifications about it. There is no need to call
<function>ReleaseDevice()</function>. You may call <function>TakeDevice()</function> again if a new <function>ReleaseDevice()</function>. You may call <function>TakeDevice()</function> again if a new
device is assigned the major+minor combination.</para> device is assigned the major+minor combination.</para>
<para><function>ResumeDevice</function> is sent whenever a session is active and a device is <para><function>ResumeDevice()</function> is sent whenever a session is active and a device is
resumed. It carries the major/minor numbers as arguments and provides a new open file descriptor. You should resumed. It carries the major/minor numbers as arguments and provides a new open file descriptor. You should
switch to the new descriptor and close the old one. They are not guaranteed to have the same underlying switch to the new descriptor and close the old one. They are not guaranteed to have the same underlying
open file descriptor in the kernel (except for a limited set of device types).</para> open file descriptor in the kernel (except for a limited set of device types).</para>
@ -1422,7 +1422,7 @@ node /org/freedesktop/login1/session/1 {
<para>Whenever <function>Active</function> or the idle state changes, <para>Whenever <function>Active</function> or the idle state changes,
<function>PropertyChanged</function> signals are sent out to which clients can subscribe.</para> <function>PropertyChanged</function> signals are sent out to which clients can subscribe.</para>
<para><function>Lock</function>/<function>Unlock</function> is sent when the session is asked to be <para><function>Lock()</function>/<function>Unlock()</function> is sent when the session is asked to be
screen-locked/unlocked. A session manager of the session should listen to this signal and act screen-locked/unlocked. A session manager of the session should listen to this signal and act
accordingly. This signal is sent out as a result of the <function>Lock()</function> and accordingly. This signal is sent out as a result of the <function>Lock()</function> and
<function>Unlock()</function> methods, respectively.</para> <function>Unlock()</function> methods, respectively.</para>
@ -1568,7 +1568,7 @@ node /org/freedesktop/login1/session/1 {
<varname>HandleSuspendKeyLongPress</varname>, and <varname>HandleSuspendKeyLongPress</varname>, and
<varname>HandleHibernateKeyLongPress</varname> were added in version 251.</para> <varname>HandleHibernateKeyLongPress</varname> were added in version 251.</para>
<para><varname>StopIdleSessionUSec</varname> was added in version 252.</para> <para><varname>StopIdleSessionUSec</varname> was added in version 252.</para>
<para><function>PrepareForShutdownWithMetadata</function> and <para><function>PrepareForShutdownWithMetadata()</function> and
<function>CreateSessionWithPIDFD()</function> were added in version 255.</para> <function>CreateSessionWithPIDFD()</function> were added in version 255.</para>
<para><function>Sleep()</function>, <para><function>Sleep()</function>,
<function>CanSleep()</function>, <function>CanSleep()</function>,

View File

@ -184,8 +184,6 @@ node /org/freedesktop/machine1 {
<!--method UnregisterMachine is not documented!--> <!--method UnregisterMachine is not documented!-->
<!--method CopyToMachineWithFlags is not documented!-->
<!--method OpenMachineRootDirectory is not documented!--> <!--method OpenMachineRootDirectory is not documented!-->
<!--method GetMachineUIDShift is not documented!--> <!--method GetMachineUIDShift is not documented!-->
@ -284,9 +282,9 @@ node /org/freedesktop/machine1 {
<variablelist class="dbus-method" generated="True" extra-ref="MapToMachineGroup()"/> <variablelist class="dbus-method" generated="True" extra-ref="MapToMachineGroup()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="MachineNew"/> <variablelist class="dbus-signal" generated="True" extra-ref="MachineNew()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="MachineRemoved"/> <variablelist class="dbus-signal" generated="True" extra-ref="MachineRemoved()"/>
<variablelist class="dbus-property" generated="True" extra-ref="PoolPath"/> <variablelist class="dbus-property" generated="True" extra-ref="PoolPath"/>
@ -411,7 +409,7 @@ node /org/freedesktop/machine1 {
host as arguments. host as arguments.
<function>CopyToMachine()</function> does the opposite and copies files from a source <function>CopyToMachine()</function> does the opposite and copies files from a source
directory on the host into a destination directory in the container. directory on the host into a destination directory in the container.
<function>CopyFromMachineWithFlags()</function> and <function>CopyToMachineWithFlags</function> do the same but take an additional flags argument.</para> <function>CopyFromMachineWithFlags()</function> and <function>CopyToMachineWithFlags()</function> do the same but take an additional flags argument.</para>
<para><function>RemoveImage()</function> removes the image with the specified name.</para> <para><function>RemoveImage()</function> removes the image with the specified name.</para>
@ -434,7 +432,7 @@ node /org/freedesktop/machine1 {
<refsect2> <refsect2>
<title>Signals</title> <title>Signals</title>
<para><function>MachineNew</function> and <function>MachineRemoved</function> are sent whenever a new <para><function>MachineNew()</function> and <function>MachineRemoved()</function> are sent whenever a new
machine is registered or removed. These signals carry the machine name and the object path to the corresponding machine is registered or removed. These signals carry the machine name and the object path to the corresponding
<interfacename>org.freedesktop.machine1.Machine</interfacename> interface (see below).</para> <interfacename>org.freedesktop.machine1.Machine</interfacename> interface (see below).</para>
</refsect2> </refsect2>

View File

@ -59,14 +59,14 @@ node /org/freedesktop/oom1 {
<variablelist class="dbus-method" generated="True" extra-ref="DumpByFileDescriptor()"/> <variablelist class="dbus-method" generated="True" extra-ref="DumpByFileDescriptor()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="Killed"/> <variablelist class="dbus-signal" generated="True" extra-ref="Killed()"/>
<!--End of Autogenerated section--> <!--End of Autogenerated section-->
<refsect2> <refsect2>
<title>Methods</title> <title>Methods</title>
<para><function>Killed</function> signal is sent when any cgroup is killed by oomd.</para> <para><function>Killed()</function> signal is sent when any cgroup is killed by oomd.</para>
<para>Note that more reasons will be added in the future, and the table below will be expanded accordingly.</para> <para>Note that more reasons will be added in the future, and the table below will be expanded accordingly.</para>
<table> <table>
<title>Killing reasons</title> <title>Killing reasons</title>
@ -100,7 +100,7 @@ node /org/freedesktop/oom1 {
<title>History</title> <title>History</title>
<refsect2> <refsect2>
<title>The Manager Object</title> <title>The Manager Object</title>
<para><function>Killed</function> was added in version 252.</para> <para><function>Killed()</function> was added in version 252.</para>
</refsect2> </refsect2>
</refsect1> </refsect1>
</refentry> </refentry>

View File

@ -617,20 +617,6 @@ node /org/freedesktop/systemd1 {
<!--method GetDynamicUsers is not documented!--> <!--method GetDynamicUsers is not documented!-->
<!--signal UnitNew is not documented!-->
<!--signal UnitRemoved is not documented!-->
<!--signal JobNew is not documented!-->
<!--signal JobRemoved is not documented!-->
<!--signal StartupFinished is not documented!-->
<!--signal UnitFilesChanged is not documented!-->
<!--signal Reloading is not documented!-->
<!--property SecurityStartTimestampMonotonic is not documented!--> <!--property SecurityStartTimestampMonotonic is not documented!-->
<!--property SecurityFinishTimestamp is not documented!--> <!--property SecurityFinishTimestamp is not documented!-->
@ -997,19 +983,19 @@ node /org/freedesktop/systemd1 {
<variablelist class="dbus-method" generated="True" extra-ref="StartAuxiliaryScope()"/> <variablelist class="dbus-method" generated="True" extra-ref="StartAuxiliaryScope()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="UnitNew"/> <variablelist class="dbus-signal" generated="True" extra-ref="UnitNew()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="UnitRemoved"/> <variablelist class="dbus-signal" generated="True" extra-ref="UnitRemoved()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="JobNew"/> <variablelist class="dbus-signal" generated="True" extra-ref="JobNew()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="JobRemoved"/> <variablelist class="dbus-signal" generated="True" extra-ref="JobRemoved()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="StartupFinished"/> <variablelist class="dbus-signal" generated="True" extra-ref="StartupFinished()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="UnitFilesChanged"/> <variablelist class="dbus-signal" generated="True" extra-ref="UnitFilesChanged()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="Reloading"/> <variablelist class="dbus-signal" generated="True" extra-ref="Reloading()"/>
<variablelist class="dbus-property" generated="True" extra-ref="Version"/> <variablelist class="dbus-property" generated="True" extra-ref="Version"/>
@ -1878,7 +1864,7 @@ node /org/freedesktop/systemd1 {
enablement state (<function>EnableUnitFiles()</function>, <function>DisableUnitFiles()</function>, enablement state (<function>EnableUnitFiles()</function>, <function>DisableUnitFiles()</function>,
<function>EnableUnitFilesWithFlags()</function>, <function>DisableUnitFilesWithFlags()</function>, <function>EnableUnitFilesWithFlags()</function>, <function>DisableUnitFilesWithFlags()</function>,
<function>ReenableUnitFiles()</function>, <function>LinkUnitFiles()</function>, <function>ReenableUnitFiles()</function>, <function>LinkUnitFiles()</function>,
<function>PresetUnitFiles</function>, <function>MaskUnitFiles</function>, and similar) require <function>PresetUnitFiles()</function>, <function>MaskUnitFiles()</function>, and similar) require
<interfacename>org.freedesktop.systemd1.manage-unit-files</interfacename>. Operations which modify the <interfacename>org.freedesktop.systemd1.manage-unit-files</interfacename>. Operations which modify the
exported environment (<function>SetEnvironment()</function>, <function>UnsetEnvironment()</function>, exported environment (<function>SetEnvironment()</function>, <function>UnsetEnvironment()</function>,
<function>UnsetAndSetEnvironment()</function>) require <function>UnsetAndSetEnvironment()</function>) require
@ -11563,7 +11549,7 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope {
<variablelist class="dbus-method" generated="True" extra-ref="AttachProcesses()"/> <variablelist class="dbus-method" generated="True" extra-ref="AttachProcesses()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="RequestStop"/> <variablelist class="dbus-signal" generated="True" extra-ref="RequestStop()"/>
<variablelist class="dbus-property" generated="True" extra-ref="Controller"/> <variablelist class="dbus-property" generated="True" extra-ref="Controller"/>
@ -11786,7 +11772,7 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope {
<refsect2> <refsect2>
<title>Signals</title> <title>Signals</title>
<para><function>RequestStop</function> is sent to the peer that is configured in the <para><function>RequestStop()</function> is sent to the peer that is configured in the
<varname>Controller</varname> property when systemd is requested to terminate the scope unit. A program <varname>Controller</varname> property when systemd is requested to terminate the scope unit. A program
registering a scope can use this to cleanly shut down the processes it added to the scope instead of registering a scope can use this to cleanly shut down the processes it added to the scope instead of
letting systemd do it with the usual <constant>SIGTERM</constant> logic.</para> letting systemd do it with the usual <constant>SIGTERM</constant> logic.</para>
@ -11798,7 +11784,7 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope {
<para>All properties correspond directly with the matching properties of service units.</para> <para>All properties correspond directly with the matching properties of service units.</para>
<para><varname>Controller</varname> contains the bus name (unique or well-known) that is notified when <para><varname>Controller</varname> contains the bus name (unique or well-known) that is notified when
the scope unit is to be shut down via a <function>RequestStop</function> signal (see below). This is the scope unit is to be shut down via a <function>RequestStop()</function> signal (see below). This is
set when the scope is created. If not set, the scope's processes will terminated with set when the scope is created. If not set, the scope's processes will terminated with
<constant>SIGTERM</constant> directly.</para> <constant>SIGTERM</constant> directly.</para>
</refsect2> </refsect2>

View File

@ -82,12 +82,12 @@ org.freedesktop.import1.Manager.ImportTar()
org.freedesktop.import1.Manager.ListTransfers() org.freedesktop.import1.Manager.ListTransfers()
org.freedesktop.import1.Manager.PullRaw() org.freedesktop.import1.Manager.PullRaw()
org.freedesktop.import1.Manager.PullTar() org.freedesktop.import1.Manager.PullTar()
org.freedesktop.import1.Manager.TransferNew org.freedesktop.import1.Manager.TransferNew()
org.freedesktop.import1.Manager.TransferRemoved org.freedesktop.import1.Manager.TransferRemoved()
org.freedesktop.import1.Transfer.Cancel() org.freedesktop.import1.Transfer.Cancel()
org.freedesktop.import1.Transfer.Id org.freedesktop.import1.Transfer.Id
org.freedesktop.import1.Transfer.Local org.freedesktop.import1.Transfer.Local
org.freedesktop.import1.Transfer.LogMessage org.freedesktop.import1.Transfer.LogMessage()
org.freedesktop.import1.Transfer.Progress org.freedesktop.import1.Transfer.Progress
org.freedesktop.import1.Transfer.Remote org.freedesktop.import1.Transfer.Remote
org.freedesktop.import1.Transfer.Type org.freedesktop.import1.Transfer.Type
@ -168,8 +168,8 @@ org.freedesktop.login1.Manager.NCurrentSessions
org.freedesktop.login1.Manager.OnExternalPower org.freedesktop.login1.Manager.OnExternalPower
org.freedesktop.login1.Manager.PowerOff() org.freedesktop.login1.Manager.PowerOff()
org.freedesktop.login1.Manager.PowerOffWithFlags() org.freedesktop.login1.Manager.PowerOffWithFlags()
org.freedesktop.login1.Manager.PrepareForShutdown org.freedesktop.login1.Manager.PrepareForShutdown()
org.freedesktop.login1.Manager.PrepareForSleep org.freedesktop.login1.Manager.PrepareForSleep()
org.freedesktop.login1.Manager.PreparingForShutdown org.freedesktop.login1.Manager.PreparingForShutdown
org.freedesktop.login1.Manager.PreparingForSleep org.freedesktop.login1.Manager.PreparingForSleep
org.freedesktop.login1.Manager.Reboot() org.freedesktop.login1.Manager.Reboot()
@ -184,10 +184,10 @@ org.freedesktop.login1.Manager.RuntimeDirectoryInodesMax
org.freedesktop.login1.Manager.RuntimeDirectorySize org.freedesktop.login1.Manager.RuntimeDirectorySize
org.freedesktop.login1.Manager.ScheduleShutdown() org.freedesktop.login1.Manager.ScheduleShutdown()
org.freedesktop.login1.Manager.ScheduledShutdown org.freedesktop.login1.Manager.ScheduledShutdown
org.freedesktop.login1.Manager.SeatNew org.freedesktop.login1.Manager.SeatNew()
org.freedesktop.login1.Manager.SeatRemoved org.freedesktop.login1.Manager.SeatRemoved()
org.freedesktop.login1.Manager.SessionNew org.freedesktop.login1.Manager.SessionNew()
org.freedesktop.login1.Manager.SessionRemoved org.freedesktop.login1.Manager.SessionRemoved()
org.freedesktop.login1.Manager.SessionsMax org.freedesktop.login1.Manager.SessionsMax
org.freedesktop.login1.Manager.SetRebootParameter() org.freedesktop.login1.Manager.SetRebootParameter()
org.freedesktop.login1.Manager.SetRebootToBootLoaderEntry() org.freedesktop.login1.Manager.SetRebootToBootLoaderEntry()
@ -204,8 +204,8 @@ org.freedesktop.login1.Manager.TerminateSession()
org.freedesktop.login1.Manager.TerminateUser() org.freedesktop.login1.Manager.TerminateUser()
org.freedesktop.login1.Manager.UnlockSession() org.freedesktop.login1.Manager.UnlockSession()
org.freedesktop.login1.Manager.UnlockSessions() org.freedesktop.login1.Manager.UnlockSessions()
org.freedesktop.login1.Manager.UserNew org.freedesktop.login1.Manager.UserNew()
org.freedesktop.login1.Manager.UserRemoved org.freedesktop.login1.Manager.UserRemoved()
org.freedesktop.login1.Manager.UserStopDelayUSec org.freedesktop.login1.Manager.UserStopDelayUSec
org.freedesktop.login1.Manager.WallMessage org.freedesktop.login1.Manager.WallMessage
org.freedesktop.login1.Seat.ActivateSession() org.freedesktop.login1.Seat.ActivateSession()
@ -237,14 +237,14 @@ org.freedesktop.login1.Session.Lock
org.freedesktop.login1.Session.Lock() org.freedesktop.login1.Session.Lock()
org.freedesktop.login1.Session.LockedHint org.freedesktop.login1.Session.LockedHint
org.freedesktop.login1.Session.Name org.freedesktop.login1.Session.Name
org.freedesktop.login1.Session.PauseDevice org.freedesktop.login1.Session.PauseDevice()
org.freedesktop.login1.Session.PauseDeviceComplete() org.freedesktop.login1.Session.PauseDeviceComplete()
org.freedesktop.login1.Session.ReleaseControl() org.freedesktop.login1.Session.ReleaseControl()
org.freedesktop.login1.Session.ReleaseDevice() org.freedesktop.login1.Session.ReleaseDevice()
org.freedesktop.login1.Session.Remote org.freedesktop.login1.Session.Remote
org.freedesktop.login1.Session.RemoteHost org.freedesktop.login1.Session.RemoteHost
org.freedesktop.login1.Session.RemoteUser org.freedesktop.login1.Session.RemoteUser
org.freedesktop.login1.Session.ResumeDevice org.freedesktop.login1.Session.ResumeDevice()
org.freedesktop.login1.Session.Scope org.freedesktop.login1.Session.Scope
org.freedesktop.login1.Session.Seat org.freedesktop.login1.Session.Seat
org.freedesktop.login1.Session.Service org.freedesktop.login1.Session.Service
@ -343,8 +343,8 @@ org.freedesktop.machine1.Manager.GetMachineUIDShift()
org.freedesktop.machine1.Manager.KillMachine() org.freedesktop.machine1.Manager.KillMachine()
org.freedesktop.machine1.Manager.ListImages() org.freedesktop.machine1.Manager.ListImages()
org.freedesktop.machine1.Manager.ListMachines() org.freedesktop.machine1.Manager.ListMachines()
org.freedesktop.machine1.Manager.MachineNew org.freedesktop.machine1.Manager.MachineNew()
org.freedesktop.machine1.Manager.MachineRemoved org.freedesktop.machine1.Manager.MachineRemoved()
org.freedesktop.machine1.Manager.MapFromMachineGroup() org.freedesktop.machine1.Manager.MapFromMachineGroup()
org.freedesktop.machine1.Manager.MapFromMachineUser() org.freedesktop.machine1.Manager.MapFromMachineUser()
org.freedesktop.machine1.Manager.MapToMachineGroup() org.freedesktop.machine1.Manager.MapToMachineGroup()
@ -653,8 +653,8 @@ org.freedesktop.systemd1.Manager.InitRDUnitsLoadFinishTimestamp
org.freedesktop.systemd1.Manager.InitRDUnitsLoadFinishTimestampMonotonic org.freedesktop.systemd1.Manager.InitRDUnitsLoadFinishTimestampMonotonic
org.freedesktop.systemd1.Manager.InitRDUnitsLoadStartTimestamp org.freedesktop.systemd1.Manager.InitRDUnitsLoadStartTimestamp
org.freedesktop.systemd1.Manager.InitRDUnitsLoadStartTimestampMonotonic org.freedesktop.systemd1.Manager.InitRDUnitsLoadStartTimestampMonotonic
org.freedesktop.systemd1.Manager.JobNew org.freedesktop.systemd1.Manager.JobNew()
org.freedesktop.systemd1.Manager.JobRemoved org.freedesktop.systemd1.Manager.JobRemoved()
org.freedesktop.systemd1.Manager.KExec() org.freedesktop.systemd1.Manager.KExec()
org.freedesktop.systemd1.Manager.KExecWatchdogUSec org.freedesktop.systemd1.Manager.KExecWatchdogUSec
org.freedesktop.systemd1.Manager.KernelTimestamp org.freedesktop.systemd1.Manager.KernelTimestamp
@ -696,7 +696,7 @@ org.freedesktop.systemd1.Manager.Reload()
org.freedesktop.systemd1.Manager.ReloadOrRestartUnit() org.freedesktop.systemd1.Manager.ReloadOrRestartUnit()
org.freedesktop.systemd1.Manager.ReloadOrTryRestartUnit() org.freedesktop.systemd1.Manager.ReloadOrTryRestartUnit()
org.freedesktop.systemd1.Manager.ReloadUnit() org.freedesktop.systemd1.Manager.ReloadUnit()
org.freedesktop.systemd1.Manager.Reloading org.freedesktop.systemd1.Manager.Reloading()
org.freedesktop.systemd1.Manager.ResetFailed() org.freedesktop.systemd1.Manager.ResetFailed()
org.freedesktop.systemd1.Manager.ResetFailedUnit() org.freedesktop.systemd1.Manager.ResetFailedUnit()
org.freedesktop.systemd1.Manager.RestartUnit() org.freedesktop.systemd1.Manager.RestartUnit()
@ -717,7 +717,7 @@ org.freedesktop.systemd1.Manager.StartTransientUnit()
org.freedesktop.systemd1.Manager.StartUnit() org.freedesktop.systemd1.Manager.StartUnit()
org.freedesktop.systemd1.Manager.StartUnitReplace() org.freedesktop.systemd1.Manager.StartUnitReplace()
org.freedesktop.systemd1.Manager.StartUnitWithFlags() org.freedesktop.systemd1.Manager.StartUnitWithFlags()
org.freedesktop.systemd1.Manager.StartupFinished org.freedesktop.systemd1.Manager.StartupFinished()
org.freedesktop.systemd1.Manager.StopUnit() org.freedesktop.systemd1.Manager.StopUnit()
org.freedesktop.systemd1.Manager.Subscribe() org.freedesktop.systemd1.Manager.Subscribe()
org.freedesktop.systemd1.Manager.SwitchRoot() org.freedesktop.systemd1.Manager.SwitchRoot()
@ -726,10 +726,10 @@ org.freedesktop.systemd1.Manager.Tainted
org.freedesktop.systemd1.Manager.ThawUnit() org.freedesktop.systemd1.Manager.ThawUnit()
org.freedesktop.systemd1.Manager.TimerSlackNSec org.freedesktop.systemd1.Manager.TimerSlackNSec
org.freedesktop.systemd1.Manager.TryRestartUnit() org.freedesktop.systemd1.Manager.TryRestartUnit()
org.freedesktop.systemd1.Manager.UnitFilesChanged org.freedesktop.systemd1.Manager.UnitFilesChanged()
org.freedesktop.systemd1.Manager.UnitNew org.freedesktop.systemd1.Manager.UnitNew()
org.freedesktop.systemd1.Manager.UnitPath org.freedesktop.systemd1.Manager.UnitPath
org.freedesktop.systemd1.Manager.UnitRemoved org.freedesktop.systemd1.Manager.UnitRemoved()
org.freedesktop.systemd1.Manager.UnitsLoadFinishTimestamp org.freedesktop.systemd1.Manager.UnitsLoadFinishTimestamp
org.freedesktop.systemd1.Manager.UnitsLoadFinishTimestampMonotonic org.freedesktop.systemd1.Manager.UnitsLoadFinishTimestampMonotonic
org.freedesktop.systemd1.Manager.UnitsLoadStartTimestamp org.freedesktop.systemd1.Manager.UnitsLoadStartTimestamp
@ -1078,7 +1078,7 @@ org.freedesktop.systemd1.Scope.MemoryLow
org.freedesktop.systemd1.Scope.MemoryMax org.freedesktop.systemd1.Scope.MemoryMax
org.freedesktop.systemd1.Scope.MemoryMin org.freedesktop.systemd1.Scope.MemoryMin
org.freedesktop.systemd1.Scope.MemorySwapMax org.freedesktop.systemd1.Scope.MemorySwapMax
org.freedesktop.systemd1.Scope.RequestStop org.freedesktop.systemd1.Scope.RequestStop()
org.freedesktop.systemd1.Scope.RestartKillSignal org.freedesktop.systemd1.Scope.RestartKillSignal
org.freedesktop.systemd1.Scope.RestrictNetworkInterfaces org.freedesktop.systemd1.Scope.RestrictNetworkInterfaces
org.freedesktop.systemd1.Scope.Result org.freedesktop.systemd1.Scope.Result

View File

@ -152,12 +152,17 @@ def check_documented(document, declarations, stats, interface, missing_version):
stats['total'] += len(items) stats['total'] += len(items)
for item in items: for item in items:
if klass == 'method': if klass in ('method', 'signal'):
elem = 'function' elem = 'function'
item_repr = f'{item}()' item_repr = f'{item}()'
elif klass == 'signal':
elem = 'function' # Find all functions/signals in <function> elements that are not
item_repr = item # suffixed with '()' and fix them
for section in sections:
element = section.find(f".//{elem}[. = '{item}']")
if element is not None:
element.text = item_repr
elif klass == 'property': elif klass == 'property':
elem = 'varname' elem = 'varname'
item_repr = item item_repr = item
@ -259,7 +264,7 @@ def subst_output(document, programlisting, stats, missing_version):
variablelist = etree.Element("variablelist") variablelist = etree.Element("variablelist")
variablelist.attrib['class'] = 'dbus-'+decl_type variablelist.attrib['class'] = 'dbus-'+decl_type
variablelist.attrib['generated'] = 'True' variablelist.attrib['generated'] = 'True'
if decl_type == 'method' : if decl_type in ('method', 'signal'):
variablelist.attrib['extra-ref'] = declaration + '()' variablelist.attrib['extra-ref'] = declaration + '()'
else: else:
variablelist.attrib['extra-ref'] = declaration variablelist.attrib['extra-ref'] = declaration