docs: include missing documentation in libnm and D-Bus docs

Check that we don't repeat the omission in future.

(cherry picked from commit cb1172ee3d)

Makefile.am

@@ -382,6 +382,11 @@ EXTRA_DIST += \
 	$(dbusinterfaces_DATA) \
 	introspection/meson.build
 
+check-docs:
+	$(srcdir)/tools/check-docs.sh "$(srcdir)"
+
+check_local += check-docs
+
 ###############################################################################
 
 libnm_core_lib_h_pub_real = \
@@ -4815,6 +4820,7 @@ EXTRA_DIST += \
 	shared/nm-version-macros.h.in \
 	shared/meson.build \
 	\
+	tools/check-docs.sh \
 	tools/check-exports.sh \
 	tools/create-exports-NetworkManager.sh \
 	tools/debug-helper.py \

docs/api/Makefile.am

@@ -62,7 +62,6 @@ content_files = \
 	dbus-org.freedesktop.NetworkManager.Device.Vlan.xml \
 	dbus-org.freedesktop.NetworkManager.Device.Adsl.xml \
 	dbus-org.freedesktop.NetworkManager.AgentManager.xml \
-	dbus-org.freedesktop.NetworkManager.Device.WiMax.xml \
 	dbus-org.freedesktop.NetworkManager.Device.IPTunnel.xml \
 	dbus-org.freedesktop.NetworkManager.Device.Tun.xml \
 	dbus-org.freedesktop.NetworkManager.Device.Bridge.xml \

docs/api/network-manager-docs.xml

@@ -192,13 +192,16 @@
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Macvlan.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Modem.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.OlpcMesh.xml"/>
+      <xi:include href="dbus-org.freedesktop.NetworkManager.Device.OvsBridge.xml"/>
+      <xi:include href="dbus-org.freedesktop.NetworkManager.Device.OvsInterface.xml"/>
+      <xi:include href="dbus-org.freedesktop.NetworkManager.Device.OvsPort.xml"/>
+      <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Ppp.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Team.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Tun.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Veth.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Vlan.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Vxlan.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.Device.Wireless.xml"/>
-      <xi:include href="dbus-org.freedesktop.NetworkManager.Device.WiMax.xml"/>
       <xi:include href="dbus-org.freedesktop.NetworkManager.PPP.xml"/>
     </chapter>
 
@@ -239,10 +242,25 @@
       <xi:include href="dbus-org.freedesktop.NetworkManager.AccessPoint.xml"/>
     </chapter>
 
+    <chapter id="ref-dbus-checkpoint">
+      <title>The <literal>/org/freedesktop/NetworkManager/Checkpoint/*</literal> objects</title>
+      <!-- TODO: Describe the objects here -->
+      <xi:include href="dbus-org.freedesktop.NetworkManager.Checkpoint.xml"/>
+    </chapter>
+
     <chapter id="dbus-types">
       <title>Types</title>
       <xi:include href="../../libnm-core/nm-dbus-types.xml"/>
     </chapter>
+
+    <!--
+      These are obsolete and intentionally ommitted from the manual since they can't
+      appear on the D-Bus API of the present version of NetworkManager.
+      Keep them here so that "make check" won't think that they were skipped accidentally .
+      <xi:include href="dbus-org.freedesktop.NetworkManager.Device.WiMax.xml"/>
+      <xi:include href="dbus-org.freedesktop.NetworkManager.WiMax.Nsp.xml"/>
+    -->
+
   </part>
 
   <part id="secret-agents">

docs/libnm/libnm-docs.xml

@@ -194,8 +194,8 @@ print ("NetworkManager version " + client.get_version())]]></programlisting></in
     <xi:include href="xml/nm-setting-adsl.xml"/>
     <xi:include href="xml/nm-setting-bluetooth.xml"/>
     <xi:include href="xml/nm-setting-bond.xml"/>
-    <xi:include href="xml/nm-setting-bridge.xml"/>
     <xi:include href="xml/nm-setting-bridge-port.xml"/>
+    <xi:include href="xml/nm-setting-bridge.xml"/>
     <xi:include href="xml/nm-setting-cdma.xml"/>
     <xi:include href="xml/nm-setting-dcb.xml"/>
     <xi:include href="xml/nm-setting-dummy.xml"/>
@@ -209,19 +209,26 @@ print ("NetworkManager version " + client.get_version())]]></programlisting></in
     <xi:include href="xml/nm-setting-macsec.xml"/>
     <xi:include href="xml/nm-setting-macvlan.xml"/>
     <xi:include href="xml/nm-setting-olpc-mesh.xml"/>
-    <xi:include href="xml/nm-setting-ppp.xml"/>
+    <xi:include href="xml/nm-setting-ovs-bridge.xml"/>
+    <xi:include href="xml/nm-setting-ovs-interface.xml"/>
+    <xi:include href="xml/nm-setting-ovs-patch.xml"/>
+    <xi:include href="xml/nm-setting-ovs-port.xml"/>
     <xi:include href="xml/nm-setting-pppoe.xml"/>
+    <xi:include href="xml/nm-setting-ppp.xml"/>
+    <xi:include href="xml/nm-setting-proxy.xml"/>
     <xi:include href="xml/nm-setting-serial.xml"/>
-    <xi:include href="xml/nm-setting-team.xml"/>
+    <xi:include href="xml/nm-setting-tc-config.xml"/>
     <xi:include href="xml/nm-setting-team-port.xml"/>
+    <xi:include href="xml/nm-setting-team.xml"/>
     <xi:include href="xml/nm-setting-tun.xml"/>
+    <xi:include href="xml/nm-setting-user.xml"/>
     <xi:include href="xml/nm-setting-vlan.xml"/>
     <xi:include href="xml/nm-setting-vpn.xml"/>
     <xi:include href="xml/nm-setting-vxlan.xml"/>
     <xi:include href="xml/nm-setting-wimax.xml"/>
     <xi:include href="xml/nm-setting-wired.xml"/>
-    <xi:include href="xml/nm-setting-wireless.xml"/>
     <xi:include href="xml/nm-setting-wireless-security.xml"/>
+    <xi:include href="xml/nm-setting-wireless.xml"/>
     <!-- end alphabetical -->
   </chapter>
 
@@ -242,6 +249,10 @@ print ("NetworkManager version " + client.get_version())]]></programlisting></in
     <xi:include href="xml/nm-device-macvlan.xml"/>
     <xi:include href="xml/nm-device-modem.xml"/>
     <xi:include href="xml/nm-device-olpc-mesh.xml"/>
+    <xi:include href="xml/nm-device-ovs-bridge.xml"/>
+    <xi:include href="xml/nm-device-ovs-interface.xml"/>
+    <xi:include href="xml/nm-device-ovs-port.xml"/>
+    <xi:include href="xml/nm-device-ppp.xml"/>
     <xi:include href="xml/nm-device-team.xml"/>
     <xi:include href="xml/nm-device-tun.xml"/>
     <xi:include href="xml/nm-device-vlan.xml"/>
@@ -256,6 +267,7 @@ print ("NetworkManager version " + client.get_version())]]></programlisting></in
     <xi:include href="xml/nm-wimax-nsp.xml"/>
     <xi:include href="xml/nm-ip-config.xml"/>
     <xi:include href="xml/nm-dhcp-config.xml"/>
+    <xi:include href="xml/nm-checkpoint.xml"/>
   </chapter>
 
   <chapter>
@@ -266,10 +278,20 @@ print ("NetworkManager version " + client.get_version())]]></programlisting></in
 
   <chapter>
     <title>VPN Plugin API Reference</title>
-    <xi:include href="xml/nm-vpn-dbus-interface.xml"/>
+    <xi:include href="xml/nm-vpn-service-plugin.xml"/>
+    <xi:include href="xml/nm-vpn-plugin-info.xml"/>
+    <xi:include href="xml/nm-vpn-editor.xml"/>
     <xi:include href="xml/nm-vpn-editor-plugin.xml"/>
+    <xi:include href="xml/nm-vpn-plugin-old.xml"/>
   </chapter>
 
+  <!--
+    These don't contain any useful documentaiton. Keep them here,
+    so that tools/check-docs.sh knows that we did omit them intentionally.
+    <xi:include href="xml/nm-core-enum-types.xml"/>
+    <xi:include href="xml/nm-enum-types.xml"/>
+  -->
+
   <chapter id="object-tree">
     <title>Object Hierarchy</title>
      <xi:include href="xml/tree_index.sgml"/>

docs/meson.build

@@ -10,3 +10,9 @@ if enable_libnm_glib
   subdir('libnm-util')
   subdir('libnm-glib')
 endif
+
+test(
+  'check-docs',
+  find_program(join_paths(meson.source_root(), 'tools', 'check-docs.sh')),
+  args: [meson.source_root()]
+)

tools/check-docs.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+SOURCEDIR=$1
+[ -n "$SOURCEDIR" ] && SOURCEDIR="$SOURCEDIR/"
+
+# Check that the D-Bus API docs contain all known interfaces
+if (sed -n 's/.*<xi:include href="dbus-\(.*\.xml\)".*/\1\n\1/p' $SOURCEDIR''docs/api/network-manager-docs.xml;
+    cd $SOURCEDIR''introspection; ls *.xml) |sort |uniq -u| grep . >&2; then
+	echo "*** Error: D-Bus interfaces not included in docs/api/network-manager-docs.xml ***" >&2
+	exit 1
+fi
+
+# Check that files that define types that are in public libnm API are included in libnm documentation.
+# Don't complain about readability or I'll rewrite this in Perl.
+if (sed -n 's/.*<xi:include href="\(xml\/.*\.xml\)".*/\1\n\1/p' $SOURCEDIR''docs/libnm/libnm-docs.xml;
+    grep -lE "$(sed -n 's/^[\t ]*\(.*_get_type\);/\1/p' $SOURCEDIR''libnm/libnm.ver |xargs echo |sed 's/ /|/g')" $SOURCEDIR''libnm{,-core}/*.h |
+    sed 's,.*/,xml/,;s/\.h$/.xml/') |sort |uniq -u| grep . >&2; then
+	echo "*** Error: libnm classes not included in docs/libnm/libnm-docs.xml ***" >&2
+	exit 1
+fi
+
+exit 0