mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2025-12-25 15:20:08 +01:00
f0e3ca09c9
Marking "nm-core-types.h" as to be ignored by gtk-doc, causes many files
to have the wrong names:
/docs/libnm/html/{NMConnection.html => libnm-NMConnection.html}
/docs/libnm/html/{NMSetting.html => libnm-NMSetting.html}
/docs/libnm/html/{NMSetting6Lowpan.html => libnm-NMSetting6Lowpan.html}
/docs/libnm/html/{NMSetting8021x.html => libnm-NMSetting8021x.html}
/docs/libnm/html/{NMSettingAdsl.html => libnm-NMSettingAdsl.html}
/docs/libnm/html/{NMSettingBluetooth.html => libnm-NMSettingBluetooth.html}
/docs/libnm/html/{NMSettingBond.html => libnm-NMSettingBond.html}
/docs/libnm/html/{NMSettingBondPort.html => libnm-NMSettingBondPort.html}
/docs/libnm/html/{NMSettingBridge.html => libnm-NMSettingBridge.html}
/docs/libnm/html/{NMSettingBridgePort.html => libnm-NMSettingBridgePort.html}
/docs/libnm/html/{NMSettingCdma.html => libnm-NMSettingCdma.html}
/docs/libnm/html/{NMSettingConnection.html => libnm-NMSettingConnection.html}
/docs/libnm/html/{NMSettingDcb.html => libnm-NMSettingDcb.html}
/docs/libnm/html/{NMSettingDummy.html => libnm-NMSettingDummy.html}
/docs/libnm/html/{NMSettingEthtool.html => libnm-NMSettingEthtool.html}
/docs/libnm/html/{NMSettingGeneric.html => libnm-NMSettingGeneric.html}
/docs/libnm/html/{NMSettingGsm.html => libnm-NMSettingGsm.html}
/docs/libnm/html/{NMSettingHostname.html => libnm-NMSettingHostname.html}
/docs/libnm/html/{NMSettingIP4Config.html => libnm-NMSettingIP4Config.html}
/docs/libnm/html/{NMSettingIP6Config.html => libnm-NMSettingIP6Config.html}
/docs/libnm/html/{NMSettingIPConfig.html => libnm-NMSettingIPConfig.html}
/docs/libnm/html/{NMSettingIPTunnel.html => libnm-NMSettingIPTunnel.html}
/docs/libnm/html/{NMSettingInfiniband.html => libnm-NMSettingInfiniband.html}
/docs/libnm/html/{NMSettingMacsec.html => libnm-NMSettingMacsec.html}
/docs/libnm/html/{NMSettingMacvlan.html => libnm-NMSettingMacvlan.html}
/docs/libnm/html/{NMSettingMatch.html => libnm-NMSettingMatch.html}
/docs/libnm/html/{NMSettingOlpcMesh.html => libnm-NMSettingOlpcMesh.html}
/docs/libnm/html/{NMSettingOvsBridge.html => libnm-NMSettingOvsBridge.html}
/docs/libnm/html/{NMSettingOvsDpdk.html => libnm-NMSettingOvsDpdk.html}
/docs/libnm/html/{NMSettingOvsExternalIDs.html => libnm-NMSettingOvsExternalIDs.html}
/docs/libnm/html/{NMSettingOvsInterface.html => libnm-NMSettingOvsInterface.html}
/docs/libnm/html/{NMSettingOvsPatch.html => libnm-NMSettingOvsPatch.html}
/docs/libnm/html/{NMSettingOvsPort.html => libnm-NMSettingOvsPort.html}
/docs/libnm/html/{NMSettingPpp.html => libnm-NMSettingPpp.html}
/docs/libnm/html/{NMSettingPppoe.html => libnm-NMSettingPppoe.html}
/docs/libnm/html/{NMSettingProxy.html => libnm-NMSettingProxy.html}
/docs/libnm/html/{NMSettingSerial.html => libnm-NMSettingSerial.html}
/docs/libnm/html/{NMSettingSriov.html => libnm-NMSettingSriov.html}
/docs/libnm/html/{NMSettingTCConfig.html => libnm-NMSettingTCConfig.html}
/docs/libnm/html/{NMSettingTeam.html => libnm-NMSettingTeam.html}
/docs/libnm/html/{NMSettingTeamPort.html => libnm-NMSettingTeamPort.html}
/docs/libnm/html/{NMSettingTun.html => libnm-NMSettingTun.html}
/docs/libnm/html/{NMSettingUser.html => libnm-NMSettingUser.html}
/docs/libnm/html/{NMSettingVeth.html => libnm-NMSettingVeth.html}
/docs/libnm/html/{NMSettingVlan.html => libnm-NMSettingVlan.html}
/docs/libnm/html/{NMSettingVpn.html => libnm-NMSettingVpn.html}
/docs/libnm/html/{NMSettingVrf.html => libnm-NMSettingVrf.html}
/docs/libnm/html/{NMSettingVxlan.html => libnm-NMSettingVxlan.html}
/docs/libnm/html/{NMSettingWifiP2P.html => libnm-NMSettingWifiP2P.html}
/docs/libnm/html/{NMSettingWimax.html => libnm-NMSettingWimax.html}
/docs/libnm/html/{NMSettingWireGuard.html => libnm-NMSettingWireGuard.html}
/docs/libnm/html/{NMSettingWired.html => libnm-NMSettingWired.html}
/docs/libnm/html/{NMSettingWireless.html => libnm-NMSettingWireless.html}
/docs/libnm/html/{NMSettingWirelessSecurity.html => libnm-NMSettingWirelessSecurity.html}
/docs/libnm/html/{NMSettingWpan.html => libnm-NMSettingWpan.html}
/docs/libnm/html/{NMSimpleConnection.html => libnm-NMSimpleConnection.html}
Revert that part of the change. Even if this regresses other problems.
Fixes: 1330292d05 ('docs/libnm: fix gtkdoc-scan ignore lists')
118 lines
3.2 KiB
Makefile
118 lines
3.2 KiB
Makefile
## 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-property-compare.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)
|