[igt-dev] [PATCH i-g-t 2/2] autoconf: Drop gtkdoc support

Daniel Vetter daniel.vetter at ffwll.ch
Thu Dec 13 12:43:55 UTC 2018


It's a huge kludge (doesn't track dependencies correctly) and compared
to the meson one, real slow. Throw it out.

Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>
---
 Makefile.am                              |   2 -
 configure.ac                             |  13 --
 docs/Makefile.am                         |   6 -
 docs/reference/Makefile.am               |   1 -
 docs/reference/igt-gpu-tools/Makefile.am | 218 -----------------------
 5 files changed, 240 deletions(-)
 delete mode 100644 docs/Makefile.am
 delete mode 100644 docs/reference/Makefile.am
 delete mode 100644 docs/reference/igt-gpu-tools/Makefile.am

diff --git a/Makefile.am b/Makefile.am
index 044c0a07f742..2ca522a0cb2a 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -43,8 +43,6 @@ endif
 SUBDIRS += overlay benchmarks
 endif
 
-SUBDIRS += docs
-
 MAINTAINERCLEANFILES = ChangeLog INSTALL
 
 .PHONY: ChangeLog INSTALL
diff --git a/configure.ac b/configure.ac
index b80e905ea478..73064fb92b30 100644
--- a/configure.ac
+++ b/configure.ac
@@ -43,14 +43,6 @@ AC_PROG_CC
 AC_PROG_LEX
 AC_PROG_YACC
 
-# check for gtk-doc
-m4_ifdef([GTK_DOC_CHECK], [
-GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
-],[
-AM_CONDITIONAL([ENABLE_GTK_DOC], false)
-enable_gtk_doc=no
-])
-
 # check for rst2man for generating man pages
 AC_CHECK_PROG(RST2MAN, rst2man, yes, no)
 AM_CONDITIONAL(HAVE_RST2MAN, [test "x$RST2MAN" = xyes])
@@ -398,10 +390,6 @@ AC_CONFIG_FILES([
 		 benchmarks/Makefile
 		 benchmarks/ezbench.d/Makefile
 		 benchmarks/wsim/Makefile
-		 docs/Makefile
-		 docs/reference/Makefile
-		 docs/reference/igt-gpu-tools/Makefile
-		 docs/reference/igt-gpu-tools/version.xml
 		 lib/Makefile
 		 lib/tests/Makefile
 		 man/Makefile
@@ -447,7 +435,6 @@ echo "       Overlay            : X: ${enable_overlay_xlib}, Xv: ${enable_overla
 echo "       x86-specific tools : ${build_x86}"
 echo "       Test runner        : ${BUILD_RUNNER}"
 echo ""
-echo " • API-Documentation      : ${enable_gtk_doc}"
 echo " • Fail on warnings       : ${enable_werror}"
 echo ""
 
diff --git a/docs/Makefile.am b/docs/Makefile.am
deleted file mode 100644
index 68cb80a51514..000000000000
--- a/docs/Makefile.am
+++ /dev/null
@@ -1,6 +0,0 @@
-SUBDIRS=reference
-
-EXTRA_DIST = \
-	audio.txt \
-	chamelium.txt \
-	$(NULL)
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
deleted file mode 100644
index 13a1954e4aeb..000000000000
--- a/docs/reference/Makefile.am
+++ /dev/null
@@ -1 +0,0 @@
-SUBDIRS = igt-gpu-tools
diff --git a/docs/reference/igt-gpu-tools/Makefile.am b/docs/reference/igt-gpu-tools/Makefile.am
deleted file mode 100644
index c77c6a657fc2..000000000000
--- a/docs/reference/igt-gpu-tools/Makefile.am
+++ /dev/null
@@ -1,218 +0,0 @@
-## Process this file with automake to produce Makefile.in
-
-TESTLISTS = $(top_builddir)/tests/test-list.txt
-KEYWORDS = (invalid|hang|swap|thrash|crc|tiled|tiling|rte|ctx|render|blt|bsd|vebox|exec|rpm)
-
-xml/igt_test_programs_%_programs.xml: $(TESTLISTS)
-	mkdir -p `dirname $@`
-	echo "<?xml version=\"1.0\"?>" > $@
-	echo "<!DOCTYPE refsect1 PUBLIC \"-//OASIS//DTD DocBook XML V4.3//EN\"" >> $@
-	echo "               \"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd\"" >> $@
-	echo "[" >> $@
-	echo "  <!ENTITY % local.common.attrib \"xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'\">" >> $@
-	echo "  <!ENTITY version SYSTEM \"version.xml\">" >> $@
-	echo "]>" >> $@
-	echo "<refsect1>" >> $@
-	echo "<title>Programs</title>" >> $@
-	echo "<informaltable pgwide=\"1\" frame=\"none\"><tgroup cols=\"2\"><tbody>" >> $@
-	for test in `cat $(TESTLISTS) | tr ' ' '\n' | grep "^$*" | sort`; do \
-		echo "<row><entry role=\"program_name\">" >> $@; \
-		echo "<link linkend=\"$$test\">$$test</link></entry></row>" >> $@; \
-	done;
-	echo "</tbody></tgroup></informaltable>" >> $@
-	echo "</refsect1>" >> $@
-
-xml/igt_test_programs_%_description.xml: $(TESTLISTS)
-	mkdir -p `dirname $@`
-	echo "<?xml version=\"1.0\"?>" > $@
-	echo "<!DOCTYPE refsect1 PUBLIC \"-//OASIS//DTD DocBook XML V4.3//EN\"" >> $@
-	echo "               \"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd\"" >> $@
-	echo "[" >> $@
-	echo "  <!ENTITY % local.common.attrib \"xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'\">" >> $@
-	echo "  <!ENTITY version SYSTEM \"version.xml\">" >> $@
-	echo "]>" >> $@
-	echo "<refsect1>" >> $@
-	echo "<title>Description</title>" >> $@
-	for test in `cat $(TESTLISTS) | tr ' ' '\n' | grep "^$*" | sort`; do \
-		echo "<refsect2 id=\"$$test\"><title>" >> $@; \
-		echo "$$test" | perl -pe 's/(?<=_)$(KEYWORDS)(?=(_|\W))/<acronym>\1<\/acronym>/g' >> $@; \
-		echo "</title><para><![CDATA[" >> $@; \
-		if [ -x $(top_builddir)/tests/$$test ]; then \
-			testprog=$(top_builddir)/tests/$$test; \
-		else \
-			testprog=$(top_srcdir)/tests/$$test; \
-		fi; \
-		 ./$$testprog --help-description >> $@; \
-		echo "]]></para>" >> $@; \
-		if ./$$testprog --list-subtests > /dev/null ; then \
-			echo "<refsect3><title>Subtests</title>" >> $@; \
-			subtest_list=`./$$testprog --list-subtests`; \
-			subtest_count=`echo $$subtest_list | wc -w`; \
-			if [ $$subtest_count -gt 100 ]; then \
-				echo "<para>This test has over 100 subtests. " >> $@; \
-				echo "Run <command>$$test</command> <option>--list-subtests</option> to list them.</para>" >> $@; \
-			else \
-				echo "<simplelist>" >> $@; \
-				for subtest in $$subtest_list; do \
-					echo "<member>" >> $@; \
-					echo "$$subtest" | perl -pe 's/\b$(KEYWORDS)\b/<acronym>\1<\/acronym>/g' >> $@; \
-					echo "</member>" >> $@; \
-				done; \
-				echo "</simplelist>" >> $@; \
-			fi; \
-			echo "</refsect3>" >> $@; \
-		fi; \
-		echo "</refsect2>" >> $@; \
-	done;
-	echo "</refsect1>" >> $@
-
-# We require automake 1.6 at least.
-AUTOMAKE_OPTIONS = 1.6
-
-# This is a blank Makefile.am for using gtk-doc.
-# Copy this to your project's API docs directory and modify the variables to
-# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
-# of using the various options.
-
-# The name of the module, e.g. 'glib'.
-DOC_MODULE=igt-gpu-tools
-
-# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
-#DOC_MODULE_VERSION=2
-
-
-# The top-level XML file (SGML in the past). You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
-
-# Directories containing the source code.
-# gtk-doc will search all .c and .h files beneath these paths
-# for inline comments documenting functions and macros.
-# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
-DOC_SOURCE_DIR=$(top_srcdir)/lib
-
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
-
-# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=--rebuild-sections
-
-# Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
-MKDB_OPTIONS=--output-format=xml
-
-# Extra options to supply to gtkdoc-mktmpl
-# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkhtml
-MKHTML_OPTIONS=
-
-# Extra options to supply to gtkdoc-fixref. Not normally needed.
-# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
-
-# Used for dependencies. The docs will be rebuilt if any of these change.
-# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
-# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/lib/*.h
-CFILE_GLOB=$(top_srcdir)/lib/*.c
-
-# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
-# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
-EXTRA_HFILES=
-
-# Header files or dirs to ignore when scanning. Use base file/dir names
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
-IGNORE_HFILES=gen6_render.h gen7_media.h gen7_render.h gen8_media.h \
-	      gen8_render.h gpgpu_fill.h i830_reg.h i915_3d.h i915_pciids.h \
-	      i915_reg.h igt_edid_template.h intel_reg.h debug.h instdone.h \
-	      media_fill.h rendercopy.h media_spin.h media_fill_gen9.h \
-	      gen9_render.h version.h
-
-# Images to copy into HTML directory.
-# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
-
-test_program_files = xml/igt_test_programs_amdgpu_description.xml \
-		     xml/igt_test_programs_amdgpu_programs.xml \
-		     xml/igt_test_programs_chamelium_description.xml \
-		     xml/igt_test_programs_chamelium_programs.xml \
-		     xml/igt_test_programs_core_description.xml \
-		     xml/igt_test_programs_core_programs.xml \
-		     xml/igt_test_programs_debugfs_description.xml \
-		     xml/igt_test_programs_debugfs_programs.xml \
-		     xml/igt_test_programs_drm_description.xml \
-		     xml/igt_test_programs_drm_programs.xml \
-		     xml/igt_test_programs_gem_description.xml \
-		     xml/igt_test_programs_gem_programs.xml \
-		     xml/igt_test_programs_gen3_description.xml \
-		     xml/igt_test_programs_gen3_programs.xml \
-		     xml/igt_test_programs_gen7_description.xml \
-		     xml/igt_test_programs_gen7_programs.xml \
-		     xml/igt_test_programs_gvt_description.xml \
-		     xml/igt_test_programs_gvt_programs.xml \
-		     xml/igt_test_programs_i915_description.xml \
-		     xml/igt_test_programs_i915_programs.xml \
-		     xml/igt_test_programs_kms_description.xml \
-		     xml/igt_test_programs_kms_programs.xml \
-		     xml/igt_test_programs_meta_description.xml \
-		     xml/igt_test_programs_meta_programs.xml \
-		     xml/igt_test_programs_perf_description.xml \
-		     xml/igt_test_programs_perf_programs.xml \
-		     xml/igt_test_programs_pm_description.xml \
-		     xml/igt_test_programs_pm_programs.xml \
-		     xml/igt_test_programs_prime_description.xml \
-		     xml/igt_test_programs_prime_programs.xml \
-		     xml/igt_test_programs_sw_sync_description.xml \
-		     xml/igt_test_programs_sw_sync_programs.xml \
-		     xml/igt_test_programs_testdisplay_description.xml \
-		     xml/igt_test_programs_testdisplay_programs.xml \
-		     xml/igt_test_programs_tools_description.xml \
-		     xml/igt_test_programs_tools_programs.xml \
-		     xml/igt_test_programs_vgem_description.xml \
-		     xml/igt_test_programs_vgem_programs.xml \
-		     $(NULL)
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=igt_test_programs.xml $(test_program_files) \
-	      $(NULL)
-
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
-# These files must be listed here *and* in content_files
-# e.g. expand_content_files=running.sgml
-expand_content_files=igt_test_programs.xml
-
-# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
-# Only needed if you are using gtkdoc-scangobj to dynamically query widget
-# signals and properties.
-# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-GTKDOC_CFLAGS=
-GTKDOC_LIBS=
-
-# This includes the standard gtk-doc make rules, copied by gtkdocize.
-include $(top_srcdir)/gtk-doc.make
-
-# Other files to distribute
-# e.g. EXTRA_DIST += version.xml.in
-# EXTRA_DIST +=
-
-# Files not to distribute
-# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
-# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-DISTCLEANFILES = $(DOC_MODULE)-sections.txt $(test_program_files)
-
-CLEANFILES += $(test_program_files)
-
-# Comment this out if you want 'make check' to test you doc status
-# and run some sanity checks
-if ENABLE_GTK_DOC
-TESTS_ENVIRONMENT = cd $(srcdir) && \
-  DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
-  SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
-#TESTS = $(GTKDOC_CHECK)
-endif
-
--include $(top_srcdir)/git.mk
-- 
2.20.0.rc1



More information about the igt-dev mailing list