summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLubomir Rintel <lkundrak@v3.sk>2022-03-18 14:57:08 +0100
committerLubomir Rintel <lkundrak@v3.sk>2022-03-22 14:48:45 +0100
commitd1e73f0ece03529a51ab5d12a85ae6239111d0c8 (patch)
tree6cd718dcb4a403ba55b4a9c49a123eeb13240fa3
parent87d16e7020a0add6996f77887bd233e995520a4b (diff)
introspection: unbreak a couple of docstrings
A couple of argument documentation strings were long enough to be broken up to span over multiple lines. gdbus-codegen, on the other hand, was of differing opinion and promptly punished the offense by garbling the resulting docbook. Merge the string into single lines.
-rw-r--r--introspection/org.freedesktop.NetworkManager.Settings.xml5
-rw-r--r--introspection/org.freedesktop.NetworkManager.xml22
2 files changed, 15 insertions, 12 deletions
diff --git a/introspection/org.freedesktop.NetworkManager.Settings.xml b/introspection/org.freedesktop.NetworkManager.Settings.xml
index ace4011b53..7e6ff802da 100644
--- a/introspection/org.freedesktop.NetworkManager.Settings.xml
+++ b/introspection/org.freedesktop.NetworkManager.Settings.xml
@@ -117,7 +117,6 @@
LoadConnections:
@filenames: Array of paths to on-disk connection profiles in directories monitored by NetworkManager.
@status: Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied).
- Note that before 1.20, NetworkManager had a bug and this @status value was wrong. It is better to assume success if the method does not return with a D-Bus error. On top of that, you can look at @failures to know whether any of the requested files failed.
@failures: Paths of connection files that could not be loaded.
Loads or reloads the indicated connections from disk. You should call this
@@ -125,6 +124,10 @@
that NetworkManager sees the changes.
As with AddConnection(), this operation does not necessarily
start the network connection.
+
+ Note that before 1.20, NetworkManager had a bug and this @status value was wrong.
+ It is better to assume success if the method does not return with a D-Bus error.
+ On top of that, you can look at @failures to know whether any of the requested files failed.
-->
<method name="LoadConnections">
<arg name="filenames" type="as" direction="in"/>
diff --git a/introspection/org.freedesktop.NetworkManager.xml b/introspection/org.freedesktop.NetworkManager.xml
index 475f329f2c..9b5ceb04d7 100644
--- a/introspection/org.freedesktop.NetworkManager.xml
+++ b/introspection/org.freedesktop.NetworkManager.xml
@@ -119,8 +119,7 @@
@options: Further options for the method call.
@path: Object path of the new connection that was just added.
@active_connection: The path of the active connection object representing this active connection.
- @result: a dictionary of additional output arguments for future extension. Currently, not additional
- output arguments are supported.
+ @result: a dictionary of additional output arguments for future extension. Currently, not additional output arguments are supported.
Adds a new connection using the given details (if any) as a template
(automatically filling in missing settings with the capabilities of the
@@ -287,18 +286,19 @@
<!--
CheckpointAdjustRollbackTimeout:
- @add_timeout: number of seconds from ~now~ in which the
- timeout will expire. Set to 0 to disable the timeout.
- Note that the added seconds start counting from now,
- not "Created" timestamp or the previous expiration
- time. Note that the "Created" property of the checkpoint
- will stay unchanged by this call. However, the "RollbackTimeout"
- will be recalculated to give the approximate new expiration time.
- The new "RollbackTimeout" property will be approximate up to
- one second precision, which is the accuracy of the property.
+ @checkpoint: The checkpoint to be rolled back.
+ @add_timeout: number of seconds from <emphasis>now</emphasis> in which the timeout will expire. Set to 0 to disable the timeout.
@since: 1.12
Reset the timeout for rollback for the checkpoint.
+
+ Note that the added seconds start counting from now,
+ not "Created" timestamp or the previous expiration
+ time. Note that the "Created" property of the checkpoint
+ will stay unchanged by this call. However, the "RollbackTimeout"
+ will be recalculated to give the approximate new expiration time.
+ The new "RollbackTimeout" property will be approximate up to
+ one second precision, which is the accuracy of the property.
-->
<method name="CheckpointAdjustRollbackTimeout">
<arg name="checkpoint" type="o" direction="in"/>