about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api/Makefile.am140
-rw-r--r--docs/api/network-manager-docs.xml1
-rw-r--r--docs/libnm/Makefile.am117
-rw-r--r--docs/libnm/libnm-docs.xml2
4 files changed, 3 insertions, 257 deletions
diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am
deleted file mode 100644
index 069fd639..00000000
--- a/docs/api/Makefile.am
+++ /dev/null
@@ -1,140 +0,0 @@
-AUTOMAKE_OPTIONS = 1.7
-
-XSLTPROC = xsltproc --xinclude --nonet
-XMLS = $(wildcard $(top_srcdir)/introspection/nm-*.xml)
-GENERATED_FILES =
-
-if BUILD_DOCS
-GENERATED_FILES += settings-spec.xml
-endif
-
-# The name of the module.
-DOC_MODULE=NetworkManager
-
-# The top-level SGML file.
-DOC_MAIN_SGML_FILE=network-manager-docs.xml
-
-DOC_SOURCE_DIR=$(srcdir)
-
-# Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--sgml-mode --output-format=xml
-
-# Extra options to supply to gtkdoc-mktmpl
-MKTMPL_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkhtml
-MKHTML_OPTIONS=--path="$(abs_srcdir)"
-
-# Files to be included in $(DOC_MAIN_SGML_FILE)
-content_files = \
-	$(GENERATED_FILES) \
-	dbus-org.freedesktop.NetworkManager.AccessPoint.xml \
-	dbus-org.freedesktop.NetworkManager.AgentManager.xml \
-	dbus-org.freedesktop.NetworkManager.Connection.Active.xml \
-	dbus-org.freedesktop.NetworkManager.DHCP4Config.xml \
-	dbus-org.freedesktop.NetworkManager.DHCP6Config.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Adsl.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Bluetooth.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Bond.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Bridge.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Dummy.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Generic.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Hsr.xml \
-	dbus-org.freedesktop.NetworkManager.Device.IPTunnel.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Infiniband.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Loopback.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Macsec.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Macvlan.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Modem.xml \
-	dbus-org.freedesktop.NetworkManager.Device.OlpcMesh.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Statistics.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Team.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Tun.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Veth.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Vlan.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Vxlan.xml \
-	dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml \
-	dbus-org.freedesktop.NetworkManager.Device.WireGuard.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Wired.xml \
-	dbus-org.freedesktop.NetworkManager.Device.Wireless.xml \
-	dbus-org.freedesktop.NetworkManager.Device.xml \
-	dbus-org.freedesktop.NetworkManager.DnsManager.xml \
-	dbus-org.freedesktop.NetworkManager.IP4Config.xml \
-	dbus-org.freedesktop.NetworkManager.IP6Config.xml \
-	dbus-org.freedesktop.NetworkManager.PPP.xml \
-	dbus-org.freedesktop.NetworkManager.SecretAgent.xml \
-	dbus-org.freedesktop.NetworkManager.Settings.Connection.xml \
-	dbus-org.freedesktop.NetworkManager.Settings.xml \
-	dbus-org.freedesktop.NetworkManager.VPN.Connection.xml \
-	dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml \
-	dbus-org.freedesktop.NetworkManager.xml \
-	$(top_builddir)/src/libnm-core-public/nm-dbus-types.xml \
-	$(top_builddir)/src/libnm-core-public/nm-vpn-dbus-types.xml \
-	$(top_builddir)/man/nmcli.xml \
-	$(top_builddir)/man/nmtui.xml \
-	$(top_builddir)/man/nm-online.xml \
-	$(top_builddir)/man/nm-initrd-generator.xml \
-	$(top_builddir)/man/NetworkManager.xml \
-	$(top_builddir)/man/NetworkManager-dispatcher.xml \
-	$(top_builddir)/man/NetworkManager.conf.xml \
-	$(top_builddir)/man/NetworkManager-wait-online.service.xml \
-	$(top_builddir)/man/nmcli-examples.xml \
-	$(top_builddir)/man/nm-settings-dbus.xml \
-	$(top_builddir)/man/nm-settings-keyfile.xml \
-	$(top_builddir)/man/nm-settings-nmcli.xml \
-	version.xml \
-	$(NULL)
-
-
-if WITH_OPENVSWITCH
-content_files += $(top_builddir)/man/nm-openvswitch.xml
-endif
-
-if BUILD_NM_CLOUD_SETUP
-content_files += $(top_builddir)/man/nm-cloud-setup.xml
-endif
-
-if CONFIG_PLUGIN_IFCFG_RH
-content_files += $(top_builddir)/man/nm-settings-ifcfg-rh.xml
-endif
-
-include $(top_srcdir)/gtk-doc.make
-
-# workaround setup-build.stamp from gtk-doc.make, which copies
-# the file as read-only. That breaks later build steps, as the
-# file can no longer be written. Instead, copy the file with `cp -f`
-# only.
-setup-build.stamp:
-	-$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
-	  files=`echo $(SETUP_FILES) $(DOC_MODULE).types`; \
-	  if test "x$$files" != "x" ; then \
-	    for file in $$files ; do \
-	      destdir=`dirname $(abs_builddir)/$$file`; \
-	      test -d "$$destdir" || mkdir -p "$$destdir"; \
-	      test -f $(abs_srcdir)/$$file && \
-	        ( cp -pf $(abs_srcdir)/$$file $(abs_builddir)/$$file ; \
-	        chmod u+w $(abs_builddir)/$$file ) || true; \
-	    done; \
-	  fi; \
-	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 \
-	settings-spec.xsl \
-	meson.build \
-	$(GENERATED_FILES) \
-	$(NULL)
-
-CLEANFILES += \
-	html/* \
-	tmpl/* \
-	xml/* \
-	NetworkManager-overrides.txt \
-	NetworkManager-sections.txt \
-	NetworkManager.actions \
-	settings-spec.xml \
-	$(NULL)
diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml
index a7cf2461..caff6fa4 100644
--- a/docs/api/network-manager-docs.xml
+++ b/docs/api/network-manager-docs.xml
@@ -186,6 +186,7 @@
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Hsr.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.IPTunnel.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Infiniband.xml"/>
+      <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Ipvlan.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Loopback.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Lowpan.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Macsec.xml"/>
diff --git a/docs/libnm/Makefile.am b/docs/libnm/Makefile.am
deleted file mode 100644
index 87ab81cc..00000000
--- a/docs/libnm/Makefile.am
+++ /dev/null
@@ -1,117 +0,0 @@
-## Process this file with automake to produce Makefile.in
-AUTOMAKE_OPTIONS = 1.6
-
-check_local =
-
-# The name of the module
-DOC_MODULE=libnm
-
-# The top-level SGML file.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
-
-# The directory containing the source code. Relative to $(srcdir).
-# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting functions and macros.
-DOC_SOURCE_DIR= \
-	$(top_builddir)/src/libnm-core-public \
-	$(top_srcdir)/src/libnm-core-public \
-	$(top_builddir)/src/libnm-core-impl \
-	$(top_srcdir)/src/libnm-core-impl \
-	$(top_srcdir)/src/libnm-client-public \
-	$(top_builddir)/src/libnm-client-public \
-	$(top_srcdir)/src/libnm-client-impl \
-	$(top_builddir)/src/libnm-client-impl \
-	$(NULL)
-
-# Extra options to supply to gtkdoc-scan.
-SCAN_OPTIONS=--rebuild-types --rebuild-sections --ignore-decorators='NM_AVAILABLE_IN_\d+_\d+|NM_DEPRECATED_IN_\d+_\d+|NM_DEPRECATED_IN_\d+_\d+_FOR\(\)'
-
-# Extra options to supply to gtkdoc-mkdb.
-MKDB_OPTIONS=--sgml-mode --output-format=xml
-
-# Extra options to supply to gtkdoc-fixref.
-FIXXREF_OPTIONS=
-
-# Used for dependencies.
-HFILE_GLOB=$(top_srcdir)/src/libnm-core-public/*.h $(top_srcdir)/src/libnm-client-public/*.h
-CFILE_GLOB=$(top_srcdir)/src/libnm-core-impl/*.c $(top_srcdir)/src/libnm-client-impl/*.c
-
-# Header files to ignore when scanning.
-IGNORE_HFILES= \
-	nm-dbus-helpers.h \
-	nm-default-libnm.h \
-	nm-device-private.h \
-	nm-dhcp4-config.h \
-	nm-dhcp6-config.h \
-	nm-dns-manager.h \
-	nm-ip4-config.h \
-	nm-ip6-config.h \
-	nm-libnm-utils.h \
-	nm-object-private.h \
-	nm-remote-connection-private.h \
-	\
-	nm-connection-private.h \
-	nm-default-libnm-core.h \
-	nm-setting-private.h \
-	nm-team-utils.h \
-	nm-utils-private.h \
-	\
-	nm-core-tests-enum-types.h \
-	test-general-enums.h \
-	\
-	$(NULL)
-
-# Images to copy into HTML directory.
-HTML_IMAGES = libnm.png
-
-# Extra XML files that are included by $(DOC_MAIN_SGML_FILE).
-content_files = version.xml
-
-# Other files to distribute.
-extra_files = libnm.png
-
-
-# CFLAGS and LDFLAGS for compiling scan program. Only needed
-# if $(DOC_MODULE).types is non-empty.
-GTKDOC_CFLAGS = \
-	-I$(top_builddir)/src/libnm-core-public \
-	-I$(top_srcdir)/src/libnm-core-public \
-	-I$(top_srcdir)/src/libnm-client-public \
-	-I$(top_builddir)/src/libnm-client-public \
-	-DNM_VERSION_MIN_REQUIRED=NM_VERSION_0_9_8 \
-	$(GLIB_CFLAGS) \
-	$(SANITIZER_EXEC_CFLAGS)
-
-GTKDOC_LIBS = \
-	$(top_builddir)/src/libnm-client-impl/libnm.la \
-	$(GLIB_LIBS) \
-	$(SANITIZER_EXEC_LDFLAGS)
-
-
-# include common portion ...
-include $(top_srcdir)/gtk-doc.make
-
-EXTRA_DIST += \
-	version.xml.in \
-	meson.build \
-	$(NULL)
-
-CLEANFILES += \
-	html/* \
-	tmpl/* \
-	xml/* \
-	libnm-overrides.txt \
-	libnm-sections.txt \
-	libnm.actions \
-	$(NULL)
-
-if GTK_DOC_BUILD_HTML
-check-local-gtk-doc-patch:
-	@if grep -q -F '<a href="libnm-nm-setting-user.html">nm-setting-user</a>' "$(top_builddir)/docs/libnm/html/index.html"; then \
-		echo "WARNING: The generated documentation has issues. Patch your gtk-doc (see https://gitlab.gnome.org/GNOME/gtk-doc/merge_requests/2). Let this check fail with NMTST_CHECK_GTK_DOC=1"; \
-		test "$$NMTST_CHECK_GTK_DOC" != 1; \
-	fi
-check_local += check-local-gtk-doc-patch
-endif
-
-check-local: $(check_local)
diff --git a/docs/libnm/libnm-docs.xml b/docs/libnm/libnm-docs.xml
index 1b37fdd2..4ed07939 100644
--- a/docs/libnm/libnm-docs.xml
+++ b/docs/libnm/libnm-docs.xml
@@ -325,6 +325,7 @@ print ("NetworkManager version " + client.get_version())]]></programlisting></in
     <xi:include href="xml/nm-setting-ip-tunnel.xml"/>
     <xi:include href="xml/nm-setting-ip4-config.xml"/>
     <xi:include href="xml/nm-setting-ip6-config.xml"/>
+    <xi:include href="xml/nm-setting-ipvlan.xml"/>
     <xi:include href="xml/nm-setting-link.xml"/>
     <xi:include href="xml/nm-setting-loopback.xml"/>
     <xi:include href="xml/nm-setting-macsec.xml"/>
@@ -378,6 +379,7 @@ print ("NetworkManager version " + client.get_version())]]></programlisting></in
     <xi:include href="xml/nm-device-hsr.xml"/>
     <xi:include href="xml/nm-device-infiniband.xml"/>
     <xi:include href="xml/nm-device-ip-tunnel.xml"/>
+    <xi:include href="xml/nm-device-ipvlan.xml"/>
     <xi:include href="xml/nm-device-loopback.xml"/>
     <xi:include href="xml/nm-device-macsec.xml"/>
     <xi:include href="xml/nm-device-macvlan.xml"/>
generated by cgit-pink 1.3.0-6-gf8a5 (git 2.35.1) at 2026-08-27 14:03:00 +0000