diff options
author | Frantisek Sumsal <frantisek@sumsal.cz> | 2024-01-23 13:06:55 +0100 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2024-01-23 16:27:50 +0100 |
commit | 43b238f1c150c5dd9d8653f0a28e1ffad95d119d (patch) | |
tree | 700857f217b95d45758a19d0fb44fc8db1370ae3 /man | |
parent | Merge pull request #31057 from aafeijoo-suse/bootctl-print-fix (diff) | |
download | systemd-43b238f1c150c5dd9d8653f0a28e1ffad95d119d.tar.xz systemd-43b238f1c150c5dd9d8653f0a28e1ffad95d119d.zip |
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
Diffstat (limited to 'man')
-rw-r--r-- | man/org.freedesktop.import1.xml | 12 | ||||
-rw-r--r-- | man/org.freedesktop.login1.xml | 74 | ||||
-rw-r--r-- | man/org.freedesktop.machine1.xml | 10 | ||||
-rw-r--r-- | man/org.freedesktop.oom1.xml | 6 | ||||
-rw-r--r-- | man/org.freedesktop.systemd1.xml | 36 |
5 files changed, 61 insertions, 77 deletions
diff --git a/man/org.freedesktop.import1.xml b/man/org.freedesktop.import1.xml index d981bc0d4b..e230a69f4c 100644 --- a/man/org.freedesktop.import1.xml +++ b/man/org.freedesktop.import1.xml @@ -131,9 +131,9 @@ node /org/freedesktop/import1 { <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--> @@ -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 simple numeric identifier, the object path references an <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 ongoing import operation.</para> @@ -220,11 +220,11 @@ node /org/freedesktop/import1 { <refsect2> <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 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 the result of the operation, which is one of <literal>done</literal> (on success), <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-signal" generated="True" extra-ref="LogMessage"/> + <variablelist class="dbus-signal" generated="True" extra-ref="LogMessage()"/> <variablelist class="dbus-property" generated="True" extra-ref="Id"/> diff --git a/man/org.freedesktop.login1.xml b/man/org.freedesktop.login1.xml index 9151926e64..8b84f227ff 100644 --- a/man/org.freedesktop.login1.xml +++ b/man/org.freedesktop.login1.xml @@ -428,23 +428,23 @@ node /org/freedesktop/login1 { <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"/> @@ -726,14 +726,14 @@ node /org/freedesktop/login1 { <para>Whenever the inhibition state or idle hint changes, <function>PropertyChanged</function> signals are sent out to which clients can subscribe.</para> - <para>The <function>SessionNew</function>, <function>SessionRemoved</function>, - <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 + <para>The <function>SessionNew()</function>, <function>SessionRemoved()</function>, + <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 logs in or out, or a seat is added or removed. They each contain the ID of the object plus the object path.</para> - <para>The <function>PrepareForShutdown</function>, - <function>PrepareForShutdownWithMetadata</function>, and <function>PrepareForSleep</function> + <para>The <function>PrepareForShutdown()</function>, + <function>PrepareForShutdownWithMetadata()</function>, and <function>PrepareForSleep()</function> 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, 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 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 - sent first, followed by <function>PrepareForShutdown</function> (for backward compatibility).</para> + sent first, followed by <function>PrepareForShutdown()</function> (for backward compatibility).</para> </refsect2> <refsect2> @@ -788,8 +788,8 @@ node /org/freedesktop/login1 { for more information.</para> <para>The <varname>PreparingForShutdown</varname> and <varname>PreparingForSleep</varname> boolean - properties are true during the interval between the two <function>PrepareForShutdown</function> and - <function>PrepareForSleep</function> signals respectively. Note that these properties do not + properties are true during the interval between the two <function>PrepareForShutdown()</function> and + <function>PrepareForSleep()</function> signals respectively. Note that these properties do not send out <function>PropertyChanged</function> signals.</para> <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 <varname>RebootToBootLoaderEntry</varname> are true when the resprective post-reboot operation was - selected with <function>SetRebootToFirmwareSetup</function>, - <function>SetRebootToBootLoaderMenu</function>, or - <function>SetRebootToBootLoaderEntry</function>.</para> + selected with <function>SetRebootToFirmwareSetup()</function>, + <function>SetRebootToBootLoaderMenu()</function>, or + <function>SetRebootToBootLoaderEntry()</function>.</para> <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 @@ -847,15 +847,15 @@ node /org/freedesktop/login1 { the inhibits of the auto-selected sleep operation. <function>SetRebootParameter()</function> requires <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>. - <function>SetRebootToBootLoaderMenu</function> requires + <function>SetRebootToBootLoaderMenu()</function> requires <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>. </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> <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-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"/> @@ -1393,28 +1393,28 @@ node /org/freedesktop/login1/session/1 { <refsect2> <title>Signals</title> - <para>The active session controller exclusively gets <function>PauseDevice</function> and - <function>ResumeDevice</function> events for any device it requested via + <para>The active session controller exclusively gets <function>PauseDevice()</function> and + <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 - 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 - <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. </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 <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 <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 - 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 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 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 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> @@ -1422,7 +1422,7 @@ node /org/freedesktop/login1/session/1 { <para>Whenever <function>Active</function> or the idle state changes, <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 accordingly. This signal is sent out as a result of the <function>Lock()</function> and <function>Unlock()</function> methods, respectively.</para> @@ -1568,7 +1568,7 @@ node /org/freedesktop/login1/session/1 { <varname>HandleSuspendKeyLongPress</varname>, and <varname>HandleHibernateKeyLongPress</varname> were added in version 251.</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> <para><function>Sleep()</function>, <function>CanSleep()</function>, diff --git a/man/org.freedesktop.machine1.xml b/man/org.freedesktop.machine1.xml index a748b7652d..cc4e61d2d4 100644 --- a/man/org.freedesktop.machine1.xml +++ b/man/org.freedesktop.machine1.xml @@ -184,8 +184,6 @@ node /org/freedesktop/machine1 { <!--method UnregisterMachine is not documented!--> - <!--method CopyToMachineWithFlags is not documented!--> - <!--method OpenMachineRootDirectory 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-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"/> @@ -411,7 +409,7 @@ node /org/freedesktop/machine1 { host as arguments. <function>CopyToMachine()</function> does the opposite and copies files from a source 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> @@ -434,7 +432,7 @@ node /org/freedesktop/machine1 { <refsect2> <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 <interfacename>org.freedesktop.machine1.Machine</interfacename> interface (see below).</para> </refsect2> diff --git a/man/org.freedesktop.oom1.xml b/man/org.freedesktop.oom1.xml index d7b2b9c5d8..1b549c347c 100644 --- a/man/org.freedesktop.oom1.xml +++ b/man/org.freedesktop.oom1.xml @@ -59,14 +59,14 @@ node /org/freedesktop/oom1 { <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--> <refsect2> <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> <table> <title>Killing reasons</title> @@ -100,7 +100,7 @@ node /org/freedesktop/oom1 { <title>History</title> <refsect2> <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> </refsect1> </refentry> diff --git a/man/org.freedesktop.systemd1.xml b/man/org.freedesktop.systemd1.xml index 5f1a5988a0..fa2ebb6fe5 100644 --- a/man/org.freedesktop.systemd1.xml +++ b/man/org.freedesktop.systemd1.xml @@ -617,20 +617,6 @@ node /org/freedesktop/systemd1 { <!--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 SecurityFinishTimestamp is not documented!--> @@ -997,19 +983,19 @@ node /org/freedesktop/systemd1 { <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"/> @@ -1878,7 +1864,7 @@ node /org/freedesktop/systemd1 { enablement state (<function>EnableUnitFiles()</function>, <function>DisableUnitFiles()</function>, <function>EnableUnitFilesWithFlags()</function>, <function>DisableUnitFilesWithFlags()</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 exported environment (<function>SetEnvironment()</function>, <function>UnsetEnvironment()</function>, <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-signal" generated="True" extra-ref="RequestStop"/> + <variablelist class="dbus-signal" generated="True" extra-ref="RequestStop()"/> <variablelist class="dbus-property" generated="True" extra-ref="Controller"/> @@ -11786,7 +11772,7 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { <refsect2> <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 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> @@ -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><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 <constant>SIGTERM</constant> directly.</para> </refsect2> |