diff options
| author | Michael Biebl <biebl@debian.org> | 2022-12-03 22:59:09 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2022-12-03 22:59:09 +0100 |
| commit | 06356c8ac470c1fa46f881b0598ec48a653e69ae (patch) | |
| tree | 42e7714b4caedf4d23ebefd42d8d0afebc6f3569 /docs/api | |
| parent | 78ecd0c8a4a337e38470f3fae5db74daf61ba86a (diff) | |
| parent | 372b62c2c25eb1f2e811f84849e9b69c40ae6245 (diff) | |
Merge branch 'debian/master' into debian/bullseye-backports
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/Makefile.am | 16 | ||||
| -rw-r--r-- | docs/api/Makefile.in | 15 | ||||
| -rw-r--r-- | docs/api/dbus-org.freedesktop.NetworkManager.xml | 2 | ||||
| -rw-r--r-- | docs/api/html/gdbus-org.freedesktop.NetworkManager.html | 2 | ||||
| -rw-r--r-- | docs/api/html/index.html | 2 | ||||
| -rw-r--r-- | docs/api/html/nm-dbus-types.html | 5 | ||||
| -rw-r--r-- | docs/api/html/nm-settings-dbus.html | 8 | ||||
| -rw-r--r-- | docs/api/html/nm-settings-nmcli.html | 2 | ||||
| -rw-r--r-- | docs/api/version.xml | 2 |
9 files changed, 14 insertions, 40 deletions
diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am index c89dbc44..359e91fd 100644 --- a/docs/api/Makefile.am +++ b/docs/api/Makefile.am @@ -2,25 +2,12 @@ AUTOMAKE_OPTIONS = 1.7 XSLTPROC = xsltproc --xinclude --nonet XMLS = $(wildcard $(top_srcdir)/introspection/nm-*.xml) - GENERATED_FILES = if BUILD_DOCS - -settings-spec.xml: settings-spec.xsl $(top_builddir)/man/nm-settings-docs-dbus.xml - $(AM_V_GEN) (! test -f $@ || chmod u+w $@) && xsltproc --output $@ $^ - -# Top-level SGML file includes (depends on) settings-spec.xml -$(DOC_MAIN_SGML_FILE): settings-spec.xml - GENERATED_FILES += settings-spec.xml - -all: $(GENERATED_FILES) - endif -#################################### - # The name of the module. DOC_MODULE=NetworkManager @@ -130,7 +117,8 @@ setup-build.stamp: fi $(AM_V_at)touch setup-build.stamp -#################################### +settings-spec.xml: settings-spec.xsl $(top_builddir)/man/nm-settings-docs-dbus.xml + $(AM_V_GEN) (! test -f $@ || chmod u+w $@) && xsltproc --output $@ $^ EXTRA_DIST += \ version.xml.in \ diff --git a/docs/api/Makefile.in b/docs/api/Makefile.in index dfa37d09..3ba87ce5 100644 --- a/docs/api/Makefile.in +++ b/docs/api/Makefile.in @@ -457,8 +457,6 @@ AUTOMAKE_OPTIONS = 1.7 XMLS = $(wildcard $(top_srcdir)/introspection/nm-*.xml) GENERATED_FILES = $(am__append_1) -#################################### - # The name of the module. DOC_MODULE = NetworkManager @@ -550,8 +548,6 @@ SETUP_FILES = \ $(DOC_MODULE)-sections.txt \ $(DOC_MODULE)-overrides.txt - -#################################### EXTRA_DIST = $(HTML_IMAGES) $(SETUP_FILES) version.xml.in \ settings-spec.xsl meson.build $(GENERATED_FILES) $(NULL) DOC_STAMPS = setup-build.stamp scan-build.stamp sgml-build.stamp \ @@ -815,14 +811,6 @@ uninstall-am: uninstall-local .PRECIOUS: Makefile -@BUILD_DOCS_TRUE@settings-spec.xml: settings-spec.xsl $(top_builddir)/man/nm-settings-docs-dbus.xml -@BUILD_DOCS_TRUE@ $(AM_V_GEN) (! test -f $@ || chmod u+w $@) && xsltproc --output $@ $^ - -# Top-level SGML file includes (depends on) settings-spec.xml -@BUILD_DOCS_TRUE@$(DOC_MAIN_SGML_FILE): settings-spec.xml - -@BUILD_DOCS_TRUE@all: $(GENERATED_FILES) - gtkdoc-check.test: Makefile $(AM_V_GEN)echo "#!/bin/sh -e" > $@; \ echo "$(GTKDOC_CHECK_PATH) || exit 1" >> $@; \ @@ -1038,6 +1026,9 @@ setup-build.stamp: fi $(AM_V_at)touch setup-build.stamp +settings-spec.xml: settings-spec.xsl $(top_builddir)/man/nm-settings-docs-dbus.xml + $(AM_V_GEN) (! test -f $@ || chmod u+w $@) && xsltproc --output $@ $^ + # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. .NOEXPORT: diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.xml b/docs/api/dbus-org.freedesktop.NetworkManager.xml index 31d0ad28..68c1cdbb 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.xml @@ -309,7 +309,7 @@ This method extends AddAndActivateConnection to allow passing further parameters. At this time the following options are supported: </para><para> * persist: A string value of either "disk" (default), "memory" or "volatile". If "memory" is passed, the connection will not be saved to disk. If "volatile" is passed, the connection will not be saved to disk and will be destroyed when disconnected. -* bind-activation: Bind the activation lifetime. Set to "dbus-name" to automatically disconnect when the requesting process disappears from the bus. The default of "none" means the connection is kept activated normally. +* bind-activation: Bind the activation lifetime. Set to "dbus-client" to automatically disconnect when the requesting process disappears from the bus. The default of "none" means the connection is kept activated normally. </para> <variablelist role="params"> <varlistentry> diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.html index 628636fd..96ae6b68 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.html @@ -371,7 +371,7 @@ parameters. At this time the following options are supported: </p> <p> * persist: A string value of either "disk" (default), "memory" or "volatile". If "memory" is passed, the connection will not be saved to disk. If "volatile" is passed, the connection will not be saved to disk and will be destroyed when disconnected. -* bind-activation: Bind the activation lifetime. Set to "dbus-name" to automatically disconnect when the requesting process disappears from the bus. The default of "none" means the connection is kept activated normally. +* bind-activation: Bind the activation lifetime. Set to "dbus-client" to automatically disconnect when the requesting process disappears from the bus. The default of "none" means the connection is kept activated normally. </p> <div class="variablelist"><table border="0" class="variablelist"> <colgroup> diff --git a/docs/api/html/index.html b/docs/api/html/index.html index e753eef1..ad46bacb 100644 --- a/docs/api/html/index.html +++ b/docs/api/html/index.html @@ -16,7 +16,7 @@ <div> <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">NetworkManager Reference Manual</p></th></tr></table></div> <div><p class="releaseinfo"> - for NetworkManager 1.40.0 + for NetworkManager 1.40.6 The latest version of this documentation can be found on-line at <a class="ulink" href="https://networkmanager.dev/docs/api/latest/" target="_top">https://networkmanager.dev/docs/api/latest/</a>. diff --git a/docs/api/html/nm-dbus-types.html b/docs/api/html/nm-dbus-types.html index 46152667..d940c0f8 100644 --- a/docs/api/html/nm-dbus-types.html +++ b/docs/api/html/nm-dbus-types.html @@ -32,6 +32,7 @@ <a name="NMCapability"></a><h3>enum NMCapability</h3> <p><a class="link" href="nm-dbus-types.html#NMCapability" title="enum NMCapability">NMCapability</a> names the numbers in the Capabilities property. Capabilities are positive numbers. They are part of stable API and a certain capability number is guaranteed not to change.</p> <p>The range 0x7000 - 0x7FFF of capabilities is guaranteed not to be used by upstream NetworkManager. It could thus be used for downstream extensions.</p> +<p>Since: 1.6</p> <p></p> <div class="refsect3"> <a name="id-1.4.17.2.3.4"></a><h4>Values</h4> @@ -3070,7 +3071,7 @@ <hr> <div class="refsect2"> <a name="NMMetered"></a><h3>enum NMMetered</h3> -<p>The NMMetered enum has two different purposes: one is to configure "connection.metered" setting of a connection profile in NMSettingConnection, and the other is to express the actual metered state of the NMDevice at a given moment.</p> +<p>The NMMetered enum has two different purposes: one is to configure "connection.metered" setting of a connection profile in NMSettingConnection, and the other is to express the actual metered state of the <a href="/usr/share/gtk-doc/html/libnm/NMDevice.html#NMDevice-struct">NMDevice</a> at a given moment.</p> <p>For the connection profile only NM_METERED_UNKNOWN, NM_METERED_NO and NM_METERED_YES are allowed.</p> <p>The device's metered state at runtime is determined by the profile which is currently active. If the profile explicitly specifies NM_METERED_NO or NM_METERED_YES, then the device's metered state is as such. If the connection profile leaves it undecided at NM_METERED_UNKNOWN (the default), then NetworkManager tries to guess the metered state, for example based on the device type or on DHCP options (like Android devices exposing a "ANDROID_METERED" DHCP vendor option). This then leads to either NM_METERED_GUESS_NO or NM_METERED_GUESS_YES.</p> <p>Most applications probably should treat the runtime state NM_METERED_GUESS_YES like NM_METERED_YES, and all other states as not metered.</p> @@ -3961,7 +3962,7 @@ <div class="refsect2"> <a name="NMCheckpointCreateFlags"></a><h3>enum NMCheckpointCreateFlags</h3> <p>The flags for CheckpointCreate call</p> -<p>Since: 1.4 (gi flags generated since 1.12)</p> +<p>Since: 1.12 (public since 1.4, g-ir since 1.12)</p> <p></p> <div class="refsect3"> <a name="id-1.4.17.2.24.4"></a><h4>Values</h4> diff --git a/docs/api/html/nm-settings-dbus.html b/docs/api/html/nm-settings-dbus.html index 0903c329..854ca8f0 100644 --- a/docs/api/html/nm-settings-dbus.html +++ b/docs/api/html/nm-settings-dbus.html @@ -1742,9 +1742,7 @@ <a name="nm-settings-dbus.property.ipv4.dhcp-vendor-class-identifier"></a>dhcp-vendor-class-identifier</td> <td align="left">string</td> <td align="left"> </td> -<td> The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server. - - Since 1.28</td> +<td> The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</td> </tr> <tr> <td align="left"> @@ -1832,9 +1830,7 @@ <td align="left">0</td> <td> Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. - When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default". - - Since 1.40</td> + When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</td> </tr> <tr> <td align="left"> diff --git a/docs/api/html/nm-settings-nmcli.html b/docs/api/html/nm-settings-nmcli.html index 6968e035..17ef394f 100644 --- a/docs/api/html/nm-settings-nmcli.html +++ b/docs/api/html/nm-settings-nmcli.html @@ -2101,7 +2101,6 @@ <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-vendor-class-identifier"></a>dhcp-vendor-class-identifier</code></span></p></td> <td> <p> The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</p> -<p> Since 1.28</p> <p> Format: string</p> </td> @@ -2184,7 +2183,6 @@ <td> <p> Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.</p> <p> When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</p> -<p> Since 1.40</p> <p> Format: int32</p> </td> diff --git a/docs/api/version.xml b/docs/api/version.xml index 32b7211c..4adfc24b 100644 --- a/docs/api/version.xml +++ b/docs/api/version.xml @@ -1 +1 @@ -1.40.0 +1.40.6 |