Blame m4/gtk-doc.m4

Packit Service fb6fa5
# -*- mode: autoconf -*-
Packit Service fb6fa5
#
Packit Service fb6fa5
# gtk-doc.m4 - configure macro to check for gtk-doc
Packit Service fb6fa5
# Copyright (C) 2003 James Henstridge
Packit Service fb6fa5
#               2007-2017  Stefan Sauer
Packit Service fb6fa5
#
Packit Service fb6fa5
# This program is free software: you can redistribute it and/or modify
Packit Service fb6fa5
# it under the terms of the GNU General Public License as published by
Packit Service fb6fa5
# the Free Software Foundation, either version 3 of the License, or
Packit Service fb6fa5
# (at your option) any later version.
Packit Service fb6fa5
#
Packit Service fb6fa5
# This program is distributed in the hope that it will be useful,
Packit Service fb6fa5
# but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service fb6fa5
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service fb6fa5
# GNU General Public License for more details.
Packit Service fb6fa5
#
Packit Service fb6fa5
# You should have received a copy of the GNU General Public License
Packit Service fb6fa5
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
Packit Service fb6fa5
#
Packit Service fb6fa5
# As a special exception, the above copyright owner gives unlimited
Packit Service fb6fa5
# permission to copy, distribute and modify the configure scripts that
Packit Service fb6fa5
# are the output of Autoconf when processing the Macro. You need not
Packit Service fb6fa5
# follow the terms of the GNU General Public License when using or
Packit Service fb6fa5
# distributing such scripts, even though portions of the text of the
Packit Service fb6fa5
# Macro appear in them. The GNU General Public License (GPL) does govern
Packit Service fb6fa5
# all other use of the material that constitutes the Autoconf Macro.
Packit Service fb6fa5
Packit Service fb6fa5
# serial 2
Packit Service fb6fa5
Packit Service fb6fa5
dnl Usage:
Packit Service fb6fa5
dnl   GTK_DOC_CHECK([minimum-gtk-doc-version])
Packit Service fb6fa5
AC_DEFUN([GTK_DOC_CHECK],
Packit Service fb6fa5
[
Packit Service fb6fa5
  AC_REQUIRE([PKG_PROG_PKG_CONFIG])
Packit Service fb6fa5
  AC_BEFORE([AC_PROG_LIBTOOL],[$0])dnl setup libtool first
Packit Service fb6fa5
  AC_BEFORE([AM_PROG_LIBTOOL],[$0])dnl setup libtool first
Packit Service fb6fa5
Packit Service fb6fa5
  ifelse([$1],[],[gtk_doc_requires="gtk-doc"],[gtk_doc_requires="gtk-doc >= $1"])
Packit Service fb6fa5
  AC_MSG_CHECKING([for gtk-doc])
Packit Service fb6fa5
  PKG_CHECK_EXISTS([$gtk_doc_requires],[have_gtk_doc=yes],[have_gtk_doc=no])
Packit Service fb6fa5
  AC_MSG_RESULT($have_gtk_doc)
Packit Service fb6fa5
Packit Service fb6fa5
  if test "$have_gtk_doc" = "no"; then
Packit Service fb6fa5
      AC_MSG_WARN([
Packit Service fb6fa5
  You will not be able to create source packages with 'make dist'
Packit Service fb6fa5
  because $gtk_doc_requires is not found.])
Packit Service fb6fa5
  fi
Packit Service fb6fa5
Packit Service fb6fa5
  dnl check for tools we added during development
Packit Service fb6fa5
  dnl Use AC_CHECK_PROG to avoid the check target using an absolute path that
Packit Service fb6fa5
  dnl may not be writable by the user. Currently, automake requires that the
Packit Service fb6fa5
  dnl test name must end in '.test'.
Packit Service fb6fa5
  dnl https://bugzilla.gnome.org/show_bug.cgi?id=701638
Packit Service fb6fa5
  AC_CHECK_PROG([GTKDOC_CHECK],[gtkdoc-check],[gtkdoc-check.test])
Packit Service fb6fa5
  AC_PATH_PROG([GTKDOC_CHECK_PATH],[gtkdoc-check])
Packit Service fb6fa5
  AC_PATH_PROGS([GTKDOC_REBASE],[gtkdoc-rebase],[true])
Packit Service fb6fa5
  AC_PATH_PROG([GTKDOC_MKPDF],[gtkdoc-mkpdf])
Packit Service fb6fa5
Packit Service fb6fa5
  dnl for overriding the documentation installation directory
Packit Service fb6fa5
  AC_ARG_WITH([html-dir],
Packit Service fb6fa5
    AS_HELP_STRING([--with-html-dir=PATH], [path to installed docs]),,
Packit Service fb6fa5
    [with_html_dir='${datadir}/gtk-doc/html'])
Packit Service fb6fa5
  HTML_DIR="$with_html_dir"
Packit Service fb6fa5
  AC_SUBST([HTML_DIR])
Packit Service fb6fa5
Packit Service fb6fa5
  dnl enable/disable documentation building
Packit Service fb6fa5
  AC_ARG_ENABLE([gtk-doc],
Packit Service fb6fa5
    AS_HELP_STRING([--enable-gtk-doc],
Packit Service fb6fa5
                   [use gtk-doc to build documentation [[default=no]]]),,
Packit Service fb6fa5
    [enable_gtk_doc=no])
Packit Service fb6fa5
Packit Service fb6fa5
  AC_MSG_CHECKING([whether to build gtk-doc documentation])
Packit Service fb6fa5
  AC_MSG_RESULT($enable_gtk_doc)
Packit Service fb6fa5
Packit Service fb6fa5
  if test "x$enable_gtk_doc" = "xyes" && test "$have_gtk_doc" = "no"; then
Packit Service fb6fa5
    AC_MSG_ERROR([
Packit Service fb6fa5
  You must have $gtk_doc_requires installed to build documentation for
Packit Service fb6fa5
  $PACKAGE_NAME. Please install gtk-doc or disable building the
Packit Service fb6fa5
  documentation by adding '--disable-gtk-doc' to '[$]0'.])
Packit Service fb6fa5
  fi
Packit Service fb6fa5
Packit Service fb6fa5
  dnl don't check for glib if we build glib
Packit Service fb6fa5
  if test "x$PACKAGE_NAME" != "xglib"; then
Packit Service fb6fa5
    dnl don't fail if someone does not have glib
Packit Service fb6fa5
    PKG_CHECK_MODULES(GTKDOC_DEPS, glib-2.0 >= 2.10.0 gobject-2.0  >= 2.10.0,,[:])
Packit Service fb6fa5
  fi
Packit Service fb6fa5
Packit Service fb6fa5
  dnl enable/disable output formats
Packit Service fb6fa5
  AC_ARG_ENABLE([gtk-doc-html],
Packit Service fb6fa5
    AS_HELP_STRING([--enable-gtk-doc-html],
Packit Service fb6fa5
                   [build documentation in html format [[default=yes]]]),,
Packit Service fb6fa5
    [enable_gtk_doc_html=yes])
Packit Service fb6fa5
    AC_ARG_ENABLE([gtk-doc-pdf],
Packit Service fb6fa5
      AS_HELP_STRING([--enable-gtk-doc-pdf],
Packit Service fb6fa5
                     [build documentation in pdf format [[default=no]]]),,
Packit Service fb6fa5
      [enable_gtk_doc_pdf=no])
Packit Service fb6fa5
Packit Service fb6fa5
  if test -z "$GTKDOC_MKPDF"; then
Packit Service fb6fa5
    enable_gtk_doc_pdf=no
Packit Service fb6fa5
  fi
Packit Service fb6fa5
Packit Service fb6fa5
  if test -z "$AM_DEFAULT_VERBOSITY"; then
Packit Service fb6fa5
    AM_DEFAULT_VERBOSITY=1
Packit Service fb6fa5
  fi
Packit Service fb6fa5
  AC_SUBST([AM_DEFAULT_VERBOSITY])
Packit Service fb6fa5
Packit Service fb6fa5
  AM_CONDITIONAL([HAVE_GTK_DOC], [test x$have_gtk_doc = xyes])
Packit Service fb6fa5
  AM_CONDITIONAL([ENABLE_GTK_DOC], [test x$enable_gtk_doc = xyes])
Packit Service fb6fa5
  AM_CONDITIONAL([GTK_DOC_BUILD_HTML], [test x$enable_gtk_doc_html = xyes])
Packit Service fb6fa5
  AM_CONDITIONAL([GTK_DOC_BUILD_PDF], [test x$enable_gtk_doc_pdf = xyes])
Packit Service fb6fa5
  AM_CONDITIONAL([GTK_DOC_USE_LIBTOOL], [test -n "$LIBTOOL"])
Packit Service fb6fa5
  AM_CONDITIONAL([GTK_DOC_USE_REBASE], [test -n "$GTKDOC_REBASE"])
Packit Service fb6fa5
])