colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

introspection: unbreak o.fd.NM.Settings AddConnection2() docstring

Browse Source 
There has been a lot wrong with this one. Aside from the messy
capitalization, it broke the argument documentation into multiple lines,
baffling gdbus-codegen, which, in turn, generated garbage documentation.

Overhaul it.
This commit is contained in:
Lubomir Rintel
2022-03-18 15:38:05 +01:00
parent b5715b82b6
commit fe9ef5e151
1 changed files with 32 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
introspection/org.freedesktop.NetworkManager.Settings.xml
View File

@@ -66,28 +66,44 @@
<!--
AddConnection2:
@settings: New connection settings, properties, and (optionally) secrets.
@flags: optional flags argument. Currently, the following flags are supported:
"0x1" (to-disk),
"0x2" (in-memory),
"0x20" (block-autoconnect).
Unknown flags cause the call to fail.
@args: optional arguments dictionary, for extentibility. Currently, no
arguments are accepted. Specifying unknown keys causes the call
to fail.
@flags: Flags. Unknown flags cause the call to fail.
@args: Optional arguments dictionary, for extentibility. Currently, no arguments are accepted. Specifying unknown keys causes the call to fail.
@path: Object path of the new connection that was just added.
@result: output argument, currently no additional results are returned.
@result: Output argument, currently no additional results are returned.
@since: 1.20
Add a new connection profile.
Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified.
The effect is whether to behave like AddConnection or AddConnectionUnsaved.
If 0x20 (block-autoconnect) is specified, autoconnect for the new profile
is blocked from the beginning. Otherwise, the profile might automatically
connect if a suitable device is around.
AddConnection2 is a extensible alternative to AddConnection, and AddConnectionUnsaved.
AddConnection2 is an alternative to
<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings.AddConnection">AddConnection</link> and
<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings.AddConnectionUnsaved">AddConnectionUnsaved</link>.
The new variant can do everything that the older variants could, and more.
Its behavior is extensible via extra %flags and %args arguments.
The %flags argument accepts the combination of following values,
logically or-ed together:
<variablelist>
<varlistentry>
<term><literal>0x1 (to-disk)</literal>:</term>
<listitem><para>The connection is persisted to disk.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>0x2 (in-memory)</literal>:</term>
<listitem><para>The change is only made in memory (without touching an eventual
profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory
only, if the connection is already in memory only.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>0x20 (block-autoconnect)</literal>:</term>
<listitem><para>Blocks auto-connect on the new profile</para></listitem>
</varlistentry>
</variablelist>
Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified.
The effect is whether to behave like
<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings.AddConnection">AddConnection</link> or
<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings.AddConnectionUnsaved">AddConnectionUnsaved</link>.
-->
<method name="AddConnection2">
<arg name="settings" type="a{sa{sv}}" direction="in"/>