1
0
mirror of https://github.com/systemd/systemd.git synced 2024-10-27 10:25:37 +03:00

Merge pull request #29150 from abderrahim/version-info-dbus

man: add version information for dbus interfaces
This commit is contained in:
Luca Boccassi 2023-09-19 16:04:41 +01:00 committed by GitHub
commit 02ee98d46f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 251 additions and 3 deletions

View File

@ -418,4 +418,16 @@ node /org/freedesktop/hostname1 {
<para>David Zeuthen's original Fedora
<ulink url="https://fedoraproject.org/wiki/Features/BetterHostname">Feature page about xdg-hostname</ulink></para>
</refsect1>
<refsect1>
<title>History</title>
<refsect2>
<title>The D-Bus API</title>
<para><varname>FirmwareVersion</varname> and
<function>GetHardwareSerial()</function> were added in version 251.</para>
<para><varname>OperatingSystemSupportEnd</varname>,
<varname>FirmwareVendor</varname>, and
<varname>FirmwareDate</varname> were added in version 253.</para>
</refsect2>
</refsect1>
</refentry>

View File

@ -1505,4 +1505,23 @@ node /org/freedesktop/login1/session/1 {
</refsect1>
<xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/>
<refsect1>
<title>History</title>
<refsect2>
<title>The Manager Object</title>
<para><varname>HandlePowerKeyLongPress</varname>,
<varname>HandleRebootKey</varname>,
<varname>HandleRebootKeyLongPress</varname>,
<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> was added in version 255.</para>
</refsect2>
<refsect2>
<title>Session Objects</title>
<para><function>SetDisplay()</function> was added in version 252.</para>
<para><function>SetTTY()</function> was added in version 254.</para>
</refsect2>
</refsect1>
</refentry>

View File

@ -670,4 +670,18 @@ $ gdbus introspect --system \
</refsect1>
<xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/>
<refsect1>
<title>History</title>
<refsect2>
<title>The Manager Object</title>
<para><function>CopyFromMachineWithFlags()</function> and
<function>CopyToMachineWithFlags()</function> were added in version 252.</para>
</refsect2>
<refsect2>
<title>Machine Objects</title>
<para><function>CopyFromWithFlags()</function> and
<function>CopyToWithFlags()</function> were added in version 252.</para>
</refsect2>
</refsect1>
</refentry>

View File

@ -573,4 +573,16 @@ $ gdbus introspect --system \
</refsect1>
<xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/>
<refsect1>
<title>History</title>
<refsect2>
<title>DHCPv4 Client Object</title>
<para><varname>State</varname> was added in version 255.</para>
</refsect2>
<refsect2>
<title>DHCPv6 Client Object</title>
<para><varname>State</varname> was added in version 255.</para>
</refsect2>
</refsect1>
</refentry>

View File

@ -95,4 +95,12 @@ node /org/freedesktop/oom1 {
</refsect1>
<xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/>
<refsect1>
<title>History</title>
<refsect2>
<title>The Manager Object</title>
<para><function>Killed</function> was added in version 252.</para>
</refsect2>
</refsect1>
</refentry>

View File

@ -566,4 +566,17 @@ node /org/freedesktop/portable1 {
</refsect1>
<xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/>
<refsect1>
<title>History</title>
<refsect2>
<title>The Manager Object</title>
<para><function>GetImageStateWithExtensions()</function> was added in version 251.</para>
</refsect2>
<refsect2>
<title>The Image Object</title>
<para><function>GetStateWithExtensions()</function> was added in version 251.</para>
<para><function>ReattachWithExtensions()</function> was added in version 254.</para>
</refsect2>
</refsect1>
</refentry>

View File

@ -11502,4 +11502,168 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \
</refsect1>
<xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/>
<refsect1>
<title>History</title>
<refsect2>
<title>The Manager Object</title>
<para><varname>RuntimeWatchdogPreUSec</varname> and
<varname>RuntimeWatchdogPreGovernor</varname> were added in version 251.</para>
<para><varname>WatchdogDevice</varname>,
<varname>WatchdogLastPingTimestamp</varname>,
<varname>WatchdogLastPingTimestampMonotonic</varname>,
<varname>DefaultDeviceTimeoutUSec</varname>,
<function>DumpUnitsMatchingPatterns()</function>, and
<function>DumpUnitsMatchingPatternsByFileDescriptor()</function> were added in version 252.</para>
<para><function>GetUnitByPIDFD()</function> and
<function>DisableUnitFilesWithFlagsAndInstallInfo()</function> were added in version 253.</para>
<para><varname>ConfidentialVirtualization</varname>,
<varname>DefaultIOAccounting</varname>,
<varname>DefaultIPAccounting</varname>,
<varname>DefaultMemoryPressureThresholdUSec</varname>,
<varname>DefaultMemoryPressureWatch</varname>,
<function>QueueSignalUnit()</function>,
<function>SoftReboot()</function>, and
<function>DumpUnitFileDescriptorStore()</function> were added in version 254.</para>
</refsect2>
<refsect2>
<title>Unit Objects</title>
<para><varname>Upholds</varname> and
<varname>UpheldBy</varname> were added in version 251.</para>
<para><varname>AccessSELinuxContext</varname> and
<varname>ActivationDetails</varname> were added in version 252.</para>
<para><function>QueueSignal()</function> was added in version 254.</para>
</refsect2>
<refsect2>
<title>Service Unit Objects</title>
<para><varname>ControlGroupId</varname> and
<varname>ExtensionDirectories</varname> were added in version 251.</para>
<para><varname>OpenFile</varname>,
<varname>ReloadSignal</varname>,
<varname>MemoryZSwapMax</varname>, and
<varname>LogFilterPatterns</varname> were added in version 253.</para>
<para><varname>RestartMode</varname>,
<varname>RestartSteps</varname>,
<varname>RestartMaxDelayUSec</varname>,
<varname>RestartUSecNext</varname>,
<varname>FileDescriptorStorePreserve</varname>,
<function>DumpFileDescriptorStore()</function>,
<varname>DelegateSubgroup</varname>,
<varname>DefaultStartupMemoryLow</varname>,
<varname>StartupMemoryLow</varname>,
<varname>StartupMemoryHigh</varname>,
<varname>StartupMemoryMax</varname>,
<varname>StartupMemorySwapMax</varname>,
<varname>StartupMemoryZSwapMax</varname>,
<varname>MemoryPressureWatch</varname>,
<varname>MemoryPressureThresholdUSec</varname>,
<varname>RootEphemeral</varname>,
<varname>ImportCredential</varname>,
<varname>MemoryKSM</varname>,
<varname>RootImagePolicy</varname>,
<varname>MountImagePolicy</varname>, and
<varname>ExtensionImagePolicy</varname> were added in version 254.</para>
</refsect2>
<refsect2>
<title>Socket Unit Objects</title>
<para><varname>ControlGroupId</varname> and
<varname>ExtensionDirectories</varname> were added in version 251.</para>
<para><varname>MemoryZSwapMax</varname> and
<varname>LogFilterPatterns</varname> were added in version 253.</para>
<para><varname>DelegateSubgroup</varname>,
<varname>DefaultStartupMemoryLow</varname>,
<varname>StartupMemoryLow</varname>,
<varname>StartupMemoryHigh</varname>,
<varname>StartupMemoryMax</varname>,
<varname>StartupMemorySwapMax</varname>,
<varname>StartupMemoryZSwapMax</varname>,
<varname>MemoryPressureWatch</varname>,
<varname>MemoryPressureThresholdUSec</varname>,
<varname>RootEphemeral</varname>,
<varname>ImportCredential</varname>,
<varname>MemoryKSM</varname>,
<varname>RootImagePolicy</varname>,
<varname>MountImagePolicy</varname>, and
<varname>ExtensionImagePolicy</varname> were added in version 254.</para>
<para><varname>PollLimitIntervalUSec</varname> and
<varname>PollLimitBurst</varname> were added in version 255.</para>
</refsect2>
<refsect2>
<title>Mount Unit Objects</title>
<para><varname>ControlGroupId</varname> and
<varname>ExtensionDirectories</varname> were added in version 251.</para>
<para><varname>MemoryZSwapMax</varname> and
<varname>LogFilterPatterns</varname> were added in version 253.</para>
<para><varname>DelegateSubgroup</varname>,
<varname>DefaultStartupMemoryLow</varname>,
<varname>StartupMemoryLow</varname>,
<varname>StartupMemoryHigh</varname>,
<varname>StartupMemoryMax</varname>,
<varname>StartupMemorySwapMax</varname>,
<varname>StartupMemoryZSwapMax</varname>,
<varname>MemoryPressureWatch</varname>,
<varname>MemoryPressureThresholdUSec</varname>,
<varname>RootEphemeral</varname>,
<varname>ImportCredential</varname>,
<varname>MemoryKSM</varname>,
<varname>RootImagePolicy</varname>,
<varname>MountImagePolicy</varname>, and
<varname>ExtensionImagePolicy</varname> were added in version 254.</para>
</refsect2>
<refsect2>
<title>Swap Unit Objects</title>
<para><varname>ControlGroupId</varname> and
<varname>ExtensionDirectories</varname> were added in version 251.</para>
<para><varname>MemoryZSwapMax</varname> and
<varname>LogFilterPatterns</varname> were added in version 253.</para>
<para><varname>DelegateSubgroup</varname>,
<varname>DefaultStartupMemoryLow</varname>,
<varname>StartupMemoryLow</varname>,
<varname>StartupMemoryHigh</varname>,
<varname>StartupMemoryMax</varname>,
<varname>StartupMemorySwapMax</varname>,
<varname>StartupMemoryZSwapMax</varname>,
<varname>MemoryPressureWatch</varname>,
<varname>MemoryPressureThresholdUSec</varname>,
<varname>RootEphemeral</varname>,
<varname>ImportCredential</varname>,
<varname>MemoryKSM</varname>,
<varname>RootImagePolicy</varname>,
<varname>MountImagePolicy</varname>, and
<varname>ExtensionImagePolicy</varname> were added in version 254.</para>
</refsect2>
<refsect2>
<title>Slice Unit Objects</title>
<para><varname>ControlGroupId</varname> was added in version 251.</para>
<para><varname>MemoryZSwapMax</varname> was added in version 253.</para>
<para><varname>DelegateSubgroup</varname>,
<varname>DefaultStartupMemoryLow</varname>,
<varname>StartupMemoryLow</varname>,
<varname>StartupMemoryHigh</varname>,
<varname>StartupMemoryMax</varname>,
<varname>StartupMemorySwapMax</varname>,
<varname>StartupMemoryZSwapMax</varname>,
<varname>MemoryPressureWatch</varname>, and
<varname>MemoryPressureThresholdUSec</varname> were added in version 254.</para>
</refsect2>
<refsect2>
<title>Scope Unit Objects</title>
<para><varname>ControlGroupId</varname> was added in version 251.</para>
<para><varname>OOMPolicy</varname> and
<varname>MemoryZSwapMax</varname> were added in version 253.</para>
<para><varname>DelegateSubgroup</varname>,
<varname>DefaultStartupMemoryLow</varname>,
<varname>StartupMemoryLow</varname>,
<varname>StartupMemoryHigh</varname>,
<varname>StartupMemoryMax</varname>,
<varname>StartupMemorySwapMax</varname>,
<varname>StartupMemoryZSwapMax</varname>,
<varname>MemoryPressureWatch</varname>, and
<varname>MemoryPressureThresholdUSec</varname> were added in version 254.</para>
</refsect2>
<refsect2>
<title>Job Objects</title>
<para><varname>ActivationDetails</varname> was added in version 252.</para>
</refsect2>
</refsect1>
</refentry>

View File

@ -141,10 +141,16 @@ def print_interface(iface, *, prefix, file, print_boring, only_interface, declar
print(f'''{prefix}}};''', file=file)
def document_has_elem_with_text(document, elem, item_repr):
predicate = f".//{elem}" # [text() = 'foo'] doesn't seem supported :(
predicate = f".//{elem}[. = '{item_repr}']"
# Ignore mentions in the History section
history = document.find(".//refsect1[title = 'History']")
history_mentions = history.findall(predicate) if history else []
for loc in document.findall(predicate):
if loc.text == item_repr:
return True
if loc in history_mentions:
continue
return True
return False
def check_documented(document, declarations, stats):