build: merge branch 'th/check-gtk-doc-behavior'

https://github.com/NetworkManager/NetworkManager/pull/196

(cherry picked from commit aa8a7559a3)
This commit is contained in:
Thomas Haller 2018-09-14 08:59:44 +02:00
commit 71d06e23b2
3 changed files with 21 additions and 1 deletions

View file

@ -1217,7 +1217,7 @@ else
if test "$enable_gtk_doc" = "yes"; then
# large parts of the documentation require introspection/pygobject to extract
# the documentation out of the source files. You cannot enable gtk-doc without alone.
AC_MSG_ERROR(["--with-gtk-doc requires --enable-introspection"])
AC_MSG_ERROR(["--enable-gtk-doc requires --enable-introspection"])
fi
have_introspection=no
fi

View file

@ -24,6 +24,7 @@ usage() {
echo " -w|--with \$OPTION: pass --with \$OPTION to rpmbuild. For example --with debug"
echo " -W|--without \$OPTION: pass --without \$OPTION to rpmbuild. For example --without debug"
echo " -s|--snapshot TEXT: use TEXT as the snapshot version for the new package (overwrites \$NM_BUILD_SNAPSHOT environment)"
echo " -r|--release: built a release tarball (this option must be alone)"
}
@ -44,6 +45,8 @@ WITH_LIST=()
SOURCE_FROM_GIT=0
SNAPSHOT="$NM_BUILD_SNAPSHOT"
NARGS=$#
while [[ $# -gt 0 ]]; do
A="$1"
shift
@ -55,6 +58,11 @@ while [[ $# -gt 0 ]]; do
-f|--force)
IGNORE_DIRTY=1
;;
-r|--release)
[[ $NARGS -eq 1 ]] || die "--release option must be alone"
export NMTST_CHECK_GTK_DOC=1
BUILDTYPE=SRPM
;;
-c|--clean)
GIT_CLEAN=1
;;

View file

@ -1,6 +1,8 @@
## Process this file with automake to produce Makefile.in
AUTOMAKE_OPTIONS = 1.6
check_local =
# The name of the module
DOC_MODULE=libnm
@ -94,3 +96,13 @@ CLEANFILES += \
tmpl/* \
xml/*
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)