c14486984e
Move the settings/plugins doc generation from libnm-util to libnm-core, since libnm-util isn't being updated for all new properties. With this commit, the keyfile and ifcfg-rh documentation is basically unchanged, except that deprecated properties are now gone, and new properties have been added, and the sections are in a different order. (generate-plugin-docs.pl just outputs the settings in Makefile order, and they were unsorted in libnm-util, but are sorted in libnm-core). The settings documentation used for nm-settings.5, the D-Bus API docs, and the nmcli help is changed a bit more at this point, and mostly for the worse, since the libnm-core setting properties don't match up with the D-Bus API as well as the libnm-util ones do. To be fixed... (I also removed the "plugins docs" line in each plugin docs comment block while moving them, since those blocks will be used for more than just plugins soon, and it's sort of obvious anyway.)
80 lines
1.9 KiB
Makefile
80 lines
1.9 KiB
Makefile
AUTOMAKE_OPTIONS = 1.7
|
|
|
|
XSLTPROC = xsltproc --xinclude --nonet
|
|
XMLS = $(wildcard $(top_srcdir)/introspection/nm-*.xml)
|
|
|
|
OTHER_FILES= \
|
|
$(top_builddir)/introspection/all.xml \
|
|
$(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
|
|
|
|
GENERATED_FILES = spec.html
|
|
|
|
if SETTING_DOCS_AVAILABLE
|
|
|
|
settings-spec.xml: settings-spec.xsl $(top_builddir)/libnm/nm-setting-docs.xml
|
|
$(AM_V_GEN) xsltproc --output $@ $^
|
|
|
|
# Top-level SGML file includes (depends on) settings-spec.xml
|
|
$(DOC_MAIN_SGML_FILE): settings-spec.xml
|
|
|
|
GENERATED_FILES += settings-spec.xml
|
|
|
|
endif
|
|
|
|
if ENABLE_GTK_DOC
|
|
|
|
spec.html: $(XMLS) $(OTHER_FILES) html-build.stamp
|
|
$(XSLTPROC) --path "$(top_builddir)/introspection:$(top_srcdir)/introspection" $(top_srcdir)/tools/doc-generator.xsl $(top_builddir)/introspection/all.xml > spec.html
|
|
mkdir -p $(builddir)/html/
|
|
cp spec.html $(builddir)/html/
|
|
|
|
all: $(GENERATED_FILES)
|
|
|
|
endif
|
|
|
|
####################################
|
|
|
|
# The name of the module.
|
|
DOC_MODULE=NetworkManager
|
|
|
|
# The top-level SGML file.
|
|
DOC_MAIN_SGML_FILE=network-manager-docs.xml
|
|
|
|
DOC_SOURCE_DIR=$(srcdir)
|
|
|
|
# Extra options to supply to gtkdoc-mkdb
|
|
MKDB_OPTIONS=--sgml-mode --output-format=xml
|
|
|
|
# Extra options to supply to gtkdoc-mktmpl
|
|
MKTMPL_OPTIONS=
|
|
|
|
# Extra options to supply to gtkdoc-mkhtml
|
|
MKHTML_OPTIONS=--path="$(abs_srcdir)"
|
|
|
|
# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
|
|
content_files = \
|
|
version.xml \
|
|
migrating-to-09.xml \
|
|
$(NULL)
|
|
|
|
include $(top_srcdir)/gtk-doc.make
|
|
|
|
####################################
|
|
|
|
EXTRA_DIST += version.xml.in settings-spec.xsl $(GENERATED_FILES)
|
|
CLEANFILES += html/* tmpl/* xml/* \
|
|
NetworkManager-sections.txt \
|
|
NetworkManager-overrides.txt
|
|
|
|
if BUILD_SETTING_DOCS
|
|
CLEANFILES += settings-spec.xml
|
|
endif
|
|
|
|
if ENABLE_GTK_DOC
|
|
CLEANFILES += spec.html
|
|
endif
|