[thirdparty/util-linux.git] / config / gtk-doc.make

#
# WARNING: this is not gtk-doc.make file from gtk-doc project. This
#          file has been modified to match with util-linux requirements:
#
#          * install files to $datadir
#          * don't maintain generated files in git repository
#          * don't distribute the final html files
#          * don't require --enable-gtk-doc for "make dist"
#          * support out-of-tree build ($srcdir != $builddir)
#
# -- kzak, Nov 2009
#

####################################
# Everything below here is generic #
####################################

if GTK_DOC_USE_LIBTOOL
GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
GTKDOC_RUN = $(LIBTOOL) --mode=execute
else
GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
GTKDOC_RUN =
endif

# We set GPATH here; this gives us semantics for GNU make
# which are more like other make's VPATH, when it comes to
# whether a source that is a target of one rule is then
# searched for in VPATH/GPATH.
#
GPATH = $(srcdir)

TARGET_DIR=$(docdir)/$(DOC_MODULE)

DISTCLEANFILES =

EXTRA_DIST = 				\
	$(content_files)		\
	$(HTML_IMAGES)			\
	$(DOC_MAIN_SGML_FILE)		\
	$(DOC_MODULE)-sections.txt
#	$(DOC_MODULE)-overrides.txt

DOC_STAMPS=scan-build.stamp sgml-build.stamp html-build.stamp \
	   $(srcdir)/setup.stamp $(srcdir)/sgml.stamp \
	   $(srcdir)/html.stamp

SCANOBJ_FILES = 		 \
	$(DOC_MODULE).args 	 \
	$(DOC_MODULE).hierarchy  \
	$(DOC_MODULE).interfaces \
	$(DOC_MODULE).prerequisites \
	$(DOC_MODULE).signals    \
        $(DOC_MODULE).types            # util-linux: we don't use types

REPORT_FILES = \
	$(DOC_MODULE)-undocumented.txt \
	$(DOC_MODULE)-undeclared.txt \
	$(DOC_MODULE)-unused.txt

CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)

if ENABLE_GTK_DOC
all-local: html-build.stamp
else
all-local:
endif

docs: html-build.stamp

$(REPORT_FILES): sgml-build.stamp

#### setup ####

setup-build.stamp:
	-@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
	   echo 'gtk-doc: Preparing build'; \
	   files=`echo $(EXTRA_DIST) $(expand_content_files) $(srcdir)/$(DOC_MODULE).types`; \
	   if test "x$$files" != "x" ; then \
	       for file in $$files ; do \
	           test -f $(abs_srcdir)/$$file && \
	               cp -p $(abs_srcdir)/$$file $(abs_builddir)/; \
	       done \
	   fi \
	fi
	@touch setup-build.stamp


setup.stamp: setup-build.stamp
	@true


#### scan ####

scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) $(srcdir)/$(DOC_MODULE)-*.txt $(content_files)

	@test -f $(DOC_MODULE)-sections.txt || \
		cp $(srcdir)/$(DOC_MODULE)-sections.txt $(builddir)

	$(AM_V_GEN)gtkdoc-scan --module=$(DOC_MODULE) \
	            --source-dir=$(srcdir)/$(DOC_SOURCE_DIR) \
	            --source-dir=$(builddir)/$(DOC_SOURCE_DIR) \
	            --ignore-headers="$(IGNORE_HFILES)" \
	            --output-dir=$(builddir) \
	            $(SCAN_OPTIONS) $(EXTRA_HFILES)

	@ if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
	    CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" \
	    CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) \
            $(LDFLAGS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) \
			--module=$(DOC_MODULE) --output-dir=$(builddir) ; \
	else \
	    for i in $(SCANOBJ_FILES) ; do \
               test -f $$i || touch $$i ; \
	    done \
	fi
	@ touch scan-build.stamp

$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
	@true

#### templates ####
#
#tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(srcdir)/$(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
#	@echo 'gtk-doc: Rebuilding template files'
#	test -z $(builddir)/tmpl || $(MKDIR_P) $(builddir)/tmpl
#	gtkdoc-mktmpl --module=$(DOC_MODULE) \
#	              $(MKTMPL_OPTIONS)
#	touch tmpl-build.stamp
#
#tmpl.stamp: tmpl-build.stamp
#	@true
#
#tmpl/*.sgml:
#	@true
#

#### xml ####

sgml-build.stamp: setup.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-decl.txt  $(DOC_MODULE)-sections.txt $(expand_content_files)
	$(AM_V_GEN)gtkdoc-mkdb --module=$(DOC_MODULE) \
	            --source-dir=$(srcdir)/$(DOC_SOURCE_DIR) \
	            --source-dir=$(builddir)/$(DOC_SOURCE_DIR) \
	            --output-format=xml \
	            --ignore-files="$(IGNORE_HFILES)" \
	            --expand-content-files="$(expand_content_files)" \
	            --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
	            $(MKDB_OPTIONS)
	@touch sgml-build.stamp

sgml.stamp: sgml-build.stamp
	@true

#### html ####

html-build.stamp: sgml.stamp $(srcdir)/$(DOC_MAIN_SGML_FILE) $(content_files)
	@rm -rf $(builddir)/html
	@$(MKDIR_P) $(builddir)/html
	$(AM_V_GEN)cd $(builddir)/html && \
	  gtkdoc-mkhtml --path="$(abs_builddir):$(abs_builddir)/xml:$(abs_srcdir)" \
	                $(MKHTML_OPTIONS) \
	                $(DOC_MODULE) \
	                $(abs_srcdir)/$(DOC_MAIN_SGML_FILE)

	@test "x$(HTML_IMAGES)" = "x" || \
		( cd $(srcdir) && cp $(HTML_IMAGES) $(abs_builddir)/html )

	$(AM_V_GEN)gtkdoc-fixxref --module-dir=html \
	               --html-dir=$(HTML_DIR) \
	               $(FIXXREF_OPTIONS)
	@touch html-build.stamp

##############

clean-local:
	rm -f *~ *.bak
	rm -rf .libs

distclean-local:
	rm -rf xml html $(REPORT_FILES) *.stamp \
	       $(DOC_MODULE)-overrides.txt \
	       $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
	test $(abs_builddir) ==  $(abs_srcdir) || \
	       rm -f $(DOC_MODULE)-*.txt $(DOC_MODULE)-*.xml *.xml.in

install-data-local:
	installfiles=`echo $(builddir)/html/*`; \
	if test "$$installfiles" = '$(builddir)/html/*'; \
	then echo '-- Nothing to install' ; \
	else \
	  if test -n "$(DOC_MODULE_VERSION)"; then \
	    installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
	  else \
	    installdir="$(DESTDIR)$(TARGET_DIR)"; \
	  fi; \
	  $(mkinstalldirs) $${installdir} ; \
	  for i in $$installfiles; do \
	    echo '-- Installing '$$i ; \
	    $(INSTALL_DATA) $$i $${installdir}; \
	  done; \
	  if test -n "$(DOC_MODULE_VERSION)"; then \
	    mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
	    mv -f $${installdir}/$(DOC_MODULE).devhelp \
	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp; \
	  fi; \
	  ! which gtkdoc-rebase >/dev/null 2>&1 || \
	    gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir} ; \
	fi

uninstall-local:
	if test -n "$(DOC_MODULE_VERSION)"; then \
	  installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
	else \
	  installdir="$(DESTDIR)$(TARGET_DIR)"; \
	fi; \
	rm -rf $${installdir}

#
# Require gtk-doc when making dist
#
if ENABLE_GTK_DOC
dist-check-gtkdoc:
else
dist-check-gtkdoc:
	@echo "*** gtk-doc must be installed and enabled in order to make dist"
	@false
endif

#dist-hook: dist-check-gtkdoc dist-hook-local sgml.stamp html-build.stamp
#	mkdir $(distdir)/tmpl
#	mkdir $(distdir)/xml
#	mkdir $(distdir)/html
#	-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
#	-cp $(srcdir)/xml/*.xml $(distdir)/xml
#	cp $(srcdir)/html/* $(distdir)/html
#	-cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
#	-cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
#	cd $(distdir) && rm -f $(DISTCLEANFILES)
#	! which gtkdoc-rebase >/dev/null 2>&1 || \
#	  gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
#
#.PHONY : dist-hook-local docs
Commit	Line	Data
e42b25eb KZ	1	#
e42b25eb KZ	2	# WARNING: this is not gtk-doc.make file from gtk-doc project. This
601d12fb	3	# file has been modified to match with util-linux requirements:
e42b25eb KZ	4	#
	5	# * install files to $datadir
	6	# * don't maintain generated files in git repository
	7	# * don't distribute the final html files
	8	# * don't require --enable-gtk-doc for "make dist"
	9	# * support out-of-tree build ($srcdir != $builddir)
	10	#
	11	# -- kzak, Nov 2009
	12	#
a77bfc3a KZ	13
	14	####################################
	15	# Everything below here is generic #
	16	####################################
	17
	18	if GTK_DOC_USE_LIBTOOL
99152a95 KZ	19	GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
99152a95 KZ	20	GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
a77bfc3a KZ	21	GTKDOC_RUN = $(LIBTOOL) --mode=execute
	22	else
	23	GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
	24	GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
99152a95	25	GTKDOC_RUN =
a77bfc3a KZ	26	endif
	27
	28	# We set GPATH here; this gives us semantics for GNU make
	29	# which are more like other make's VPATH, when it comes to
	30	# whether a source that is a target of one rule is then
	31	# searched for in VPATH/GPATH.
	32	#
	33	GPATH = $(srcdir)
	34
e42b25eb	35	TARGET_DIR=$(docdir)/$(DOC_MODULE)
a77bfc3a	36
3fe1b06a KZ	37	DISTCLEANFILES =
3fe1b06a KZ	38
a77bfc3a KZ	39	EXTRA_DIST = \
	40	$(content_files) \
	41	$(HTML_IMAGES) \
	42	$(DOC_MAIN_SGML_FILE) \
e42b25eb KZ	43	$(DOC_MODULE)-sections.txt
e42b25eb KZ	44	# $(DOC_MODULE)-overrides.txt
a77bfc3a	45
99152a95 KZ	46	DOC_STAMPS=scan-build.stamp sgml-build.stamp html-build.stamp \
	47	$(srcdir)/setup.stamp $(srcdir)/sgml.stamp \
	48	$(srcdir)/html.stamp
a77bfc3a KZ	49
	50	SCANOBJ_FILES = \
	51	$(DOC_MODULE).args \
	52	$(DOC_MODULE).hierarchy \
	53	$(DOC_MODULE).interfaces \
	54	$(DOC_MODULE).prerequisites \
3fe1b06a KZ	55	$(DOC_MODULE).signals \
3fe1b06a KZ	56	$(DOC_MODULE).types # util-linux: we don't use types
a77bfc3a KZ	57
	58	REPORT_FILES = \
	59	$(DOC_MODULE)-undocumented.txt \
	60	$(DOC_MODULE)-undeclared.txt \
	61	$(DOC_MODULE)-unused.txt
	62
	63	CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
	64
	65	if ENABLE_GTK_DOC
	66	all-local: html-build.stamp
	67	else
	68	all-local:
	69	endif
	70
	71	docs: html-build.stamp
	72
	73	$(REPORT_FILES): sgml-build.stamp
	74
99152a95 KZ	75	#### setup ####
	76
	77	setup-build.stamp:
	78	-@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
	79	echo 'gtk-doc: Preparing build'; \
	80	files=`echo $(EXTRA_DIST) $(expand_content_files) $(srcdir)/$(DOC_MODULE).types`; \
	81	if test "x$$files" != "x" ; then \
	82	for file in $$files ; do \
	83	test -f $(abs_srcdir)/$$file && \
	84	cp -p $(abs_srcdir)/$$file $(abs_builddir)/; \
	85	done \
	86	fi \
	87	fi
	88	@touch setup-build.stamp
	89
	90
	91	setup.stamp: setup-build.stamp
	92	@true
	93
	94
a77bfc3a KZ	95	#### scan ####
a77bfc3a KZ	96
e42b25eb KZ	97	scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) $(srcdir)/$(DOC_MODULE)-*.txt $(content_files)
e42b25eb KZ	98
9f06f52b	99	@test -f $(DOC_MODULE)-sections.txt \|\| \
e42b25eb KZ	100	cp $(srcdir)/$(DOC_MODULE)-sections.txt $(builddir)
e42b25eb KZ	101
9f06f52b	102	$(AM_V_GEN)gtkdoc-scan --module=$(DOC_MODULE) \
e42b25eb KZ	103	--source-dir=$(srcdir)/$(DOC_SOURCE_DIR) \
	104	--source-dir=$(builddir)/$(DOC_SOURCE_DIR) \
	105	--ignore-headers="$(IGNORE_HFILES)" \
	106	--output-dir=$(builddir) \
	107	$(SCAN_OPTIONS) $(EXTRA_HFILES)
	108
99152a95	109	@ if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
e42b25eb KZ	110	CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" \
	111	CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) \
	112	$(LDFLAGS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) \
	113	--module=$(DOC_MODULE) --output-dir=$(builddir) ; \
a77bfc3a	114	else \
a77bfc3a KZ	115	for i in $(SCANOBJ_FILES) ; do \
	116	test -f $$i \|\| touch $$i ; \
	117	done \
	118	fi
99152a95	119	@ touch scan-build.stamp
a77bfc3a	120
e96a05a9	121	$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
a77bfc3a KZ	122	@true
	123
	124	#### templates ####
99152a95 KZ	125	#
	126	#tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(srcdir)/$(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
	127	# @echo 'gtk-doc: Rebuilding template files'
	128	# test -z $(builddir)/tmpl \|\| $(MKDIR_P) $(builddir)/tmpl
	129	# gtkdoc-mktmpl --module=$(DOC_MODULE) \
	130	# $(MKTMPL_OPTIONS)
	131	# touch tmpl-build.stamp
	132	#
	133	#tmpl.stamp: tmpl-build.stamp
	134	# @true
	135	#
	136	#tmpl/*.sgml:
	137	# @true
	138	#
a77bfc3a KZ	139
	140	#### xml ####
	141
e96a05a9	142	sgml-build.stamp: setup.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-decl.txt $(DOC_MODULE)-sections.txt $(expand_content_files)
9f06f52b	143	$(AM_V_GEN)gtkdoc-mkdb --module=$(DOC_MODULE) \
e42b25eb KZ	144	--source-dir=$(srcdir)/$(DOC_SOURCE_DIR) \
	145	--source-dir=$(builddir)/$(DOC_SOURCE_DIR) \
	146	--output-format=xml \
	147	--ignore-files="$(IGNORE_HFILES)" \
	148	--expand-content-files="$(expand_content_files)" \
	149	--main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
	150	$(MKDB_OPTIONS)
9f06f52b	151	@touch sgml-build.stamp
a77bfc3a KZ	152
	153	sgml.stamp: sgml-build.stamp
	154	@true
	155
	156	#### html ####
	157
e42b25eb	158	html-build.stamp: sgml.stamp $(srcdir)/$(DOC_MAIN_SGML_FILE) $(content_files)
9f06f52b KZ	159	@rm -rf $(builddir)/html
	160	@$(MKDIR_P) $(builddir)/html
	161	$(AM_V_GEN)cd $(builddir)/html && \
e42b25eb KZ	162	gtkdoc-mkhtml --path="$(abs_builddir):$(abs_builddir)/xml:$(abs_srcdir)" \
	163	$(MKHTML_OPTIONS) \
	164	$(DOC_MODULE) \
	165	$(abs_srcdir)/$(DOC_MAIN_SGML_FILE)
	166
9f06f52b	167	@test "x$(HTML_IMAGES)" = "x" \|\| \
e42b25eb KZ	168	( cd $(srcdir) && cp $(HTML_IMAGES) $(abs_builddir)/html )
e42b25eb KZ	169
9f06f52b	170	$(AM_V_GEN)gtkdoc-fixxref --module-dir=html \
e42b25eb KZ	171	--html-dir=$(HTML_DIR) \
e42b25eb KZ	172	$(FIXXREF_OPTIONS)
9f06f52b	173	@touch html-build.stamp
a77bfc3a KZ	174
	175	##############
	176
	177	clean-local:
	178	rm -f ~ .bak
	179	rm -rf .libs
	180
	181	distclean-local:
99152a95	182	rm -rf xml html $(REPORT_FILES) *.stamp \
e42b25eb KZ	183	$(DOC_MODULE)-overrides.txt \
	184	$(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
	185	test $(abs_builddir) == $(abs_srcdir) \|\| \
3fe1b06a	186	rm -f $(DOC_MODULE)-.txt $(DOC_MODULE)-.xml *.xml.in
a77bfc3a KZ	187
a77bfc3a KZ	188	install-data-local:
e42b25eb KZ	189	installfiles=`echo $(builddir)/html/*`; \
e42b25eb KZ	190	if test "$$installfiles" = '$(builddir)/html/*'; \
a77bfc3a KZ	191	then echo '-- Nothing to install' ; \
	192	else \
	193	if test -n "$(DOC_MODULE_VERSION)"; then \
	194	installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
	195	else \
	196	installdir="$(DESTDIR)$(TARGET_DIR)"; \
	197	fi; \
	198	$(mkinstalldirs) $${installdir} ; \
	199	for i in $$installfiles; do \
	200	echo '-- Installing '$$i ; \
	201	$(INSTALL_DATA) $$i $${installdir}; \
	202	done; \
	203	if test -n "$(DOC_MODULE_VERSION)"; then \
	204	mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
	205	$${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
	206	mv -f $${installdir}/$(DOC_MODULE).devhelp \
	207	$${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp; \
	208	fi; \
	209	! which gtkdoc-rebase >/dev/null 2>&1 \|\| \
	210	gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir} ; \
	211	fi
	212
	213	uninstall-local:
	214	if test -n "$(DOC_MODULE_VERSION)"; then \
	215	installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
	216	else \
	217	installdir="$(DESTDIR)$(TARGET_DIR)"; \
	218	fi; \
	219	rm -rf $${installdir}
	220
	221	#
	222	# Require gtk-doc when making dist
	223	#
	224	if ENABLE_GTK_DOC
	225	dist-check-gtkdoc:
	226	else
	227	dist-check-gtkdoc:
	228	@echo "*** gtk-doc must be installed and enabled in order to make dist"
	229	@false
	230	endif
	231
e42b25eb KZ	232	#dist-hook: dist-check-gtkdoc dist-hook-local sgml.stamp html-build.stamp
	233	# mkdir $(distdir)/tmpl
	234	# mkdir $(distdir)/xml
	235	# mkdir $(distdir)/html
	236	# -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
	237	# -cp $(srcdir)/xml/*.xml $(distdir)/xml
	238	# cp $(srcdir)/html/* $(distdir)/html
	239	# -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
	240	# -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
	241	# cd $(distdir) && rm -f $(DISTCLEANFILES)
	242	# ! which gtkdoc-rebase >/dev/null 2>&1 \|\| \
	243	# gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
	244	#
	245	#.PHONY : dist-hook-local docs