fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2025-12-21 05:10:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
NetworkManager/docs/api/Makefile.am

73 lines
1.9 KiB
Text
Raw Normal View History

docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
AUTOMAKE_OPTIONS = 1.7
build: improve documentation and test configure options Use --enable-doc and --enable-tests instead of --with-docs and --with-tests. This is consistent with other features and with --enable-gtk-doc option. Support current variants as fallback. Don't build tests unless --enable-tests is specified.
2012-11-05 11:35:34 +01:00
if ENABLE_DOC
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
XSLTPROC = xsltproc --xinclude --nonet
XMLS = $(wildcard $(top_srcdir)/introspection/nm-*.xml)
OTHER_FILES= \
api: update version based on configure version Instead of manually which is error-prone.
2011-08-06 10:59:19 +02:00
$(top_builddir)/introspection/all.xml \
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
$(top_srcdir)/introspection/generic-types.xml \
$(top_srcdir)/introspection/errors.xml \
$(top_srcdir)/introspection/vpn-errors.xml \
$(top_srcdir)/tools/doc-generator.xsl \
$(top_srcdir)/introspection/generic-types.xml
docs: convert settings specification to docbook
2011-02-18 11:25:48 -06:00
GENERATED_FILES = spec.html settings-spec.xml
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
docs: fix distcheck and ensure spec.html gets put in the right place gtk-doc removes the 'html' directory as part of the build process so we need to have spec.html generation depend on the gtk-doc html target. Also, fix up the paths to make sure the generated spec.html gets copied into the final 'html' directory.
2011-03-04 14:38:28 -06:00
spec.html: $(XMLS) $(OTHER_FILES) html-build.stamp
docs: fix 'make distcheck' API doc xslt paths Since all.xml is a built file these days, and will contain paths relative to $(top_srcdir)/introspection even though it's not in that directory, it seems we need to clue xsltproc into where the other API XML files really are.
2012-03-14 12:48:51 -05:00
$(XSLTPROC) --path "$(top_builddir)/introspection:$(top_srcdir)/introspection" $(top_srcdir)/tools/doc-generator.xsl $(top_builddir)/introspection/all.xml > $@
docs: ensure dbus spec can be copied to html dir (bgo #642853)
2011-02-21 18:26:55 -06:00
mkdir -p $(builddir)/html/
docs: fix distcheck and ensure spec.html gets put in the right place gtk-doc removes the 'html' directory as part of the build process so we need to have spec.html generation depend on the gtk-doc html target. Also, fix up the paths to make sure the generated spec.html gets copied into the final 'html' directory.
2011-03-04 14:38:28 -06:00
cp $@ $(builddir)/html/
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
build: fix distcheck when building settings specification XML The generated settings-spec.xml should not be DIST-ed because it's regenerated every time libnm-util changes. That meants it gets rebuilt during 'make' even from a dist tarball. Thus, it shouldn't be part of the dist tarball itself. In addition, settings-spec.html shouldn't be included in $(content_files) becuase this is added to EXTRA_DIST by gtk-doc.make. Since generate-settings-spec.c the move from docs/api/ to tools/, this started breaking distcheck even though the original Makefile rules were wrong too.
2013-02-05 15:23:07 -06:00
# settings-spec.xml should *not* be DISTed because it must be regenerated
# whenever the libnm-util source changes
tools: move generate-settings-spec to tools
2013-01-16 19:40:47 +01:00
settings-spec.xml: $(top_builddir)/tools/generate-settings-spec $(top_builddir)/libnm-util/libnm-util.la
build: fix distcheck when building settings specification XML The generated settings-spec.xml should not be DIST-ed because it's regenerated every time libnm-util changes. That meants it gets rebuilt during 'make' even from a dist tarball. Thus, it shouldn't be part of the dist tarball itself. In addition, settings-spec.html shouldn't be included in $(content_files) becuase this is added to EXTRA_DIST by gtk-doc.make. Since generate-settings-spec.c the move from docs/api/ to tools/, this started breaking distcheck even though the original Makefile rules were wrong too.
2013-02-05 15:23:07 -06:00
$(top_builddir)/tools/generate-settings-spec book $@
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
build: fix build with --enable-doc (docs/api/Makefile.am) "./autogen.sh --enable-doc && make" produced this error: warning: failed to load external entity "../settings-spec.xml" ../network-manager-docs.xml:57: element include: XInclude error : could not load ../settings-spec.xml, and no fallback was found Removing settings-spec.xml from $(content_files) made the file non-DISTed but it also removed the file as a dependency for html-build.stamp that also runs cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) and $(DOC_MAIN_SGML_FILE) includes settings-spec.xml. Fix that by making $(DOC_MAIN_SGML_FILE) dependent on setting-spec.xml.
2013-02-12 14:47:29 +01:00
# Top-level SGML file includes (depends on) settings-spec.xml
$(DOC_MAIN_SGML_FILE): settings-spec.xml
docs: fix distcheck
2011-02-23 16:27:16 -06:00
all: $(GENERATED_FILES)
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
####################################
# The name of the module.
DOC_MODULE=NetworkManager
# The top-level SGML file.
DOC_MAIN_SGML_FILE=network-manager-docs.xml
doc: fix build with build with gtk-doc < 1.15 gtk-doc < 1.15 does not handle a missing DOC_SOURCE_DIR
2012-07-02 12:29:52 -05:00
DOC_SOURCE_DIR=$(srcdir)
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--sgml-mode --output-format=xml
# Extra options to supply to gtkdoc-mktmpl
MKTMPL_OPTIONS=
# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
content_files = \
version.xml \
docs: add in-progress section on migrating to NM 0.9
2011-02-18 14:58:03 -06:00
migrating-to-09.xml \
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
$(NULL)
include $(top_srcdir)/gtk-doc.make
####################################
build: fix distcheck when building settings specification XML The generated settings-spec.xml should not be DIST-ed because it's regenerated every time libnm-util changes. That meants it gets rebuilt during 'make' even from a dist tarball. Thus, it shouldn't be part of the dist tarball itself. In addition, settings-spec.html shouldn't be included in $(content_files) becuase this is added to EXTRA_DIST by gtk-doc.make. Since generate-settings-spec.c the move from docs/api/ to tools/, this started breaking distcheck even though the original Makefile rules were wrong too.
2013-02-05 15:23:07 -06:00
EXTRA_DIST += spec.html
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
CLEANFILES += $(GENERATED_FILES)
else
tools: move generate-settings-spec to tools
2013-01-16 19:40:47 +01:00
EXTRA_DIST =
docs: fix distcheck
2011-02-16 16:39:43 -06:00
CLEANFILES =
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
endif
EXTRA_DIST += version.xml.in
build: clean all files on 'make distclean'
2012-11-13 23:13:25 +01:00
CLEANFILES += html/* tmpl/* xml/* \
NetworkManager-sections.txt \
NetworkManager-overrides.txt
Reference in a new issue Copy permalink