Some minor improvements to D-Bus docs (#36467)

See the commit messages for details:
 - Fix some confusing wording
 - Clarify about signal emission on convenience objects for login1
This commit is contained in:
Lennart Poettering
2025-02-20 20:48:55 +01:00
committed by GitHub
3 changed files with 21 additions and 7 deletions

View File

@@ -131,7 +131,7 @@ node /org/freedesktop/locale1 {
<title>Signals</title>
<para>Whenever the system locale or keymap is changed via the daemon,
<function>PropertyChanged</function> signals are sent out to which clients can subscribe.</para>
<function>PropertyChanged</function> signals are sent out to clients which have subscribed.</para>
</refsect2>
<refsect2>

View File

@@ -754,7 +754,7 @@ node /org/freedesktop/login1 {
<title>Signals</title>
<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 clients which have subscribed.</para>
<para>The <function>SecureAttentionKey()</function> signal is sent when the user presses Ctrl+Alt+Shift+Esc to
request the login manager to display the greeter, for instance in the case of a deadlocked compositor.
@@ -1000,8 +1000,13 @@ node /org/freedesktop/login1/seat/seat0 {
<para>Whenever <function>ActiveSession</function>, <function>Sessions</function>,
<function>CanGraphical</function>, <function>CanTTY</function>,
or the idle state changes, <function>PropertyChanged</function> signals are sent out to which clients
can subscribe.</para>
or the idle state changes, <function>PropertyChanged</function> signals are sent out to clients which
have subscribed.</para>
<para>Signals are only emitted on objects referencing a specific seat ID, not on the
<literal>/org/freedesktop/login1/seat/self</literal> or
<literal>/org/freedesktop/login1/seat/auto</literal> convenience objects, as they can only be
dereferenced relative to a method caller.</para>
</refsect2>
<refsect2>
@@ -1121,7 +1126,11 @@ node /org/freedesktop/login1/user/_1000 {
<title>Signals</title>
<para>Whenever <varname>Sessions</varname> 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 clients which have subscribed.</para>
<para>Signals are only emitted on objects referencing a specific UID, not on the
<literal>/org/freedesktop/login1/user/self</literal> convenience object, as <varname>self</varname>
can only be dereferenced relative to a method caller.</para>
</refsect2>
<refsect2>
@@ -1477,12 +1486,17 @@ node /org/freedesktop/login1/session/1 {
open file descriptor in the kernel (except for a limited set of device types).</para>
<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 clients which have subscribed.</para>
<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>
<para>Signals are only emitted on objects referencing a specific session ID, not on the
<literal>/org/freedesktop/login1/session/self</literal> or
<literal>/org/freedesktop/login1/session/auto</literal> convenience objects, as they can only be
dereferenced relative to a method caller.</para>
</refsect2>
<refsect2>

View File

@@ -148,7 +148,7 @@ node /org/freedesktop/timedate1 {
over D-Bus. Local clients can access the information directly.</para>
<para>Whenever the <varname>Timezone</varname> and <varname>LocalRTC</varname> settings are changed via
the daemon, <function>PropertyChanged</function> signals are sent out to which clients can subscribe.
the daemon, <function>PropertyChanged</function> signals are sent out to clients which have subscribed.
</para>
<para>Note that this service will not inform you about system time changes. Use