Blame docs/libnm/Makefile.am

Packit 5756e2
## Process this file with automake to produce Makefile.in
Packit 5756e2
AUTOMAKE_OPTIONS = 1.6
Packit 5756e2
Packit 5756e2
check_local =
Packit 5756e2
Packit 5756e2
# The name of the module
Packit 5756e2
DOC_MODULE=libnm
Packit 5756e2
Packit 5756e2
# The top-level SGML file.
Packit 5756e2
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
Packit 5756e2
Packit 5756e2
# The directory containing the source code. Relative to $(srcdir).
Packit 5756e2
# gtk-doc will search all .c & .h files beneath here for inline comments
Packit 5756e2
# documenting functions and macros.
Packit 5756e2
DOC_SOURCE_DIR= \
Packit 5756e2
	$(top_srcdir)/libnm-core \
Packit 5756e2
	$(top_builddir)/libnm-core \
Packit 5756e2
	$(top_srcdir)/libnm \
Packit 5756e2
	$(top_builddir)/libnm
Packit 5756e2
Packit 5756e2
# Extra options to supply to gtkdoc-scan.
Packit 5756e2
SCAN_OPTIONS=--rebuild-types --rebuild-sections --ignore-decorators="NM_AVAILABLE_IN_\d_\d\d?|NM_DEPRECATED_IN_\d_\d\d?"
Packit 5756e2
Packit 5756e2
# Extra options to supply to gtkdoc-mkdb.
Packit 5756e2
MKDB_OPTIONS=--sgml-mode --output-format=xml
Packit 5756e2
Packit 5756e2
# Extra options to supply to gtkdoc-fixref.
Packit 5756e2
FIXXREF_OPTIONS=
Packit 5756e2
Packit 5756e2
# Used for dependencies.
Packit 5756e2
HFILE_GLOB=$(top_srcdir)/libnm-core/*.h $(top_srcdir)/libnm/*.h
Packit 5756e2
CFILE_GLOB=$(top_srcdir)/libnm-core/*.c $(top_srcdir)/libnm/*.c
Packit 5756e2
Packit 5756e2
# Header files to ignore when scanning.
Packit 5756e2
IGNORE_HFILES= \
Packit 5756e2
	common.h \
Packit 5756e2
	nm-core-internal.h \
Packit 5756e2
	nm-core-tests-enum-types.h \
Packit 5756e2
	nm-core-types-internal.h \
Packit 5756e2
	nm-crypto-impl.h \
Packit 5756e2
	nm-crypto.h \
Packit 5756e2
	nm-dbus-helpers.h \
Packit 5756e2
	nm-device-private.h \
Packit 5756e2
	nm-dhcp4-config.h \
Packit 5756e2
	nm-dhcp6-config.h \
Packit 5756e2
	nm-dns-manager.h \
Packit 5756e2
	nm-ip4-config.h \
Packit 5756e2
	nm-ip6-config.h \
Packit 5756e2
	nm-manager.h \
Packit 5756e2
	nm-object-private.h \
Packit 5756e2
	nm-property-compare.h \
Packit 5756e2
	nm-remote-connection-private.h \
Packit 5756e2
	nm-setting-private.h \
Packit 5756e2
	nm-utils-private.h \
Packit 5756e2
	\
Packit 5756e2
	test-general-enums.h \
Packit 5756e2
	\
Packit 5756e2
	nm-keyfile-internal.h \
Packit 5756e2
	nm-keyfile-utils.h \
Packit 5756e2
	\
Packit 5756e2
	nm-auth-subject.h \
Packit 5756e2
	nm-common-macros.h \
Packit 5756e2
	nm-ethtool-utils.h \
Packit 5756e2
	nm-libnm-core-utils.h \
Packit 5756e2
	\
Packit 5756e2
	nm-dispatcher-api.h \
Packit 5756e2
	nm-libnm-core-aux.h \
Packit 5756e2
	\
Packit 5756e2
	nm-libnm-aux.h \
Packit 5756e2
	\
Packit 5756e2
	$(NULL)
Packit 5756e2
Packit 5756e2
# Images to copy into HTML directory.
Packit 5756e2
HTML_IMAGES = libnm.png
Packit 5756e2
Packit 5756e2
# Extra XML files that are included by $(DOC_MAIN_SGML_FILE).
Packit 5756e2
content_files = version.xml
Packit 5756e2
Packit 5756e2
# Other files to distribute.
Packit 5756e2
extra_files = libnm.png
Packit 5756e2
Packit 5756e2
Packit 5756e2
# CFLAGS and LDFLAGS for compiling scan program. Only needed
Packit 5756e2
# if $(DOC_MODULE).types is non-empty.
Packit 5756e2
GTKDOC_CFLAGS = \
Packit 5756e2
	-I$(top_srcdir)/libnm-core \
Packit 5756e2
	-I$(top_builddir)/libnm-core \
Packit 5756e2
	-I$(top_srcdir)/libnm \
Packit 5756e2
	-I$(top_builddir)/libnm \
Packit 5756e2
	-DNM_VERSION_MIN_REQUIRED=NM_VERSION_0_9_8 \
Packit 5756e2
	$(GLIB_CFLAGS) \
Packit 5756e2
	$(SANITIZER_EXEC_CFLAGS)
Packit 5756e2
Packit 5756e2
GTKDOC_LIBS = \
Packit 5756e2
	$(top_builddir)/libnm/libnm.la \
Packit 5756e2
	$(GLIB_LIBS) \
Packit 5756e2
	$(SANITIZER_EXEC_LDFLAGS)
Packit 5756e2
Packit 5756e2
Packit 5756e2
# include common portion ...
Packit 5756e2
include $(top_srcdir)/gtk-doc.make
Packit 5756e2
Packit 5756e2
EXTRA_DIST += version.xml.in meson.build
Packit 5756e2
Packit 5756e2
CLEANFILES += \
Packit 5756e2
	libnm-sections.txt \
Packit 5756e2
	libnm-overrides.txt \
Packit 5756e2
	html/* \
Packit 5756e2
	tmpl/* \
Packit 5756e2
	xml/*
Packit 5756e2
Packit Service a1bd4f
DISTCLEANFILES = libnm.actions
Packit Service a1bd4f
Packit 5756e2
if GTK_DOC_BUILD_HTML
Packit 5756e2
check-local-gtk-doc-patch:
Packit 5756e2
	@if grep -q -F 'nm-setting-user' "$(top_builddir)/docs/libnm/html/index.html"; then \
Packit 5756e2
		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"; \
Packit 5756e2
		test "$$NMTST_CHECK_GTK_DOC" != 1; \
Packit 5756e2
	fi
Packit 5756e2
check_local += check-local-gtk-doc-patch
Packit 5756e2
endif
Packit 5756e2
Packit 5756e2
check-local: $(check_local)