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

109 lines
5.1 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
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)/introspection/generic-types.xml
docs: replace spec.html with docbook D-Bus API reference May use a lot of improvement (actually documenting the names and objects that use the interfaces in question), but at least this looks a lot better on developer.gnome.org.
2016-03-26 10:17:34 +01:00
GENERATED_FILES =
build: fix nm-setting-docs build in various configurations Certain build configurations (like --enable-gtk-doc --disable-introspection) were broken with respect to nm-setting-docs. Fix this. Also, we don't require just gobject-introspection, we need pygobject specifically as well.
2014-06-27 12:25:54 -04:00
if SETTING_DOCS_AVAILABLE
libnm, libnm-util: move settings doc generation to libnm-core 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.)
2014-10-28 09:58:25 -04:00
settings-spec.xml: settings-spec.xsl $(top_builddir)/libnm/nm-setting-docs.xml
build: fix nm-setting-docs build in various configurations Certain build configurations (like --enable-gtk-doc --disable-introspection) were broken with respect to nm-setting-docs. Fix this. Also, we don't require just gobject-introspection, we need pygobject specifically as well.
2014-06-27 12:25:54 -04:00
$(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
build: always generate docs at dist time (bgo #700093) dist tarballs shouldn't ever be released without the documentation, and this allows us to build the tarballs with pre-generated docs that get installed on the end system, but don't need to be built there. So the end system doesn't need gtk-doc installed, only the dist system does. https://bugzilla.gnome.org/show_bug.cgi?id=700093
2013-05-10 09:55:09 -05:00
all: $(GENERATED_FILES)
endif
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=
docs: generate settings-spec.xml from libnm-util/nm-setting-docs.xml Generate docs/api/settings-spec.xml via an XSLT stylesheet applied to libnm-util/nm-setting-docs.xml.
2014-06-13 11:08:56 -04:00
# Extra options to supply to gtkdoc-mkhtml
MKHTML_OPTIONS=--path="$(abs_srcdir)"
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
content_files = \
docs: replace spec.html with docbook D-Bus API reference May use a lot of improvement (actually documenting the names and objects that use the interfaces in question), but at least this looks a lot better on developer.gnome.org.
2016-03-26 10:17:34 +01:00
$(top_builddir)/introspection/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml \
$(top_builddir)/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml \
$(top_builddir)/introspection/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml \
$(top_builddir)/introspection/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml \
$(top_builddir)/introspection/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml \
$(top_builddir)/introspection/nmdbus-manager-org.freedesktop.NetworkManager.xml \
$(top_builddir)/introspection/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml \
$(top_builddir)/introspection/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml \
$(top_builddir)/introspection/nmdbus-device-org.freedesktop.NetworkManager.Device.xml \
$(top_builddir)/introspection/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml \
$(top_builddir)/introspection/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml \
$(top_builddir)/introspection/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml \
$(top_builddir)/introspection/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml \
$(top_builddir)/introspection/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml \
$(top_builddir)/introspection/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml \
$(top_builddir)/introspection/nmdbus-ppp-manager-org.freedesktop.NetworkManager.PPP.xml \
$(top_builddir)/introspection/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml \
$(top_builddir)/introspection/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml \
$(top_builddir)/introspection/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml \
$(top_builddir)/introspection/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml \
$(top_builddir)/introspection/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml \
$(top_builddir)/introspection/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml \
$(top_builddir)/introspection/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml \
$(top_builddir)/introspection/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml \
$(top_builddir)/introspection/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml \
$(top_builddir)/introspection/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml \
$(top_builddir)/introspection/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml \
$(top_builddir)/introspection/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml \
$(top_builddir)/introspection/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml \
$(top_builddir)/introspection/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml \
$(top_builddir)/introspection/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml \
$(top_builddir)/introspection/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml \
docs: add manual pages to docbook documentation This way they will make it to developer.gnome.org.
2016-03-24 13:30:52 +01:00
$(top_builddir)/introspection/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml \
man: convert nmcli(1) manual to docbook refentry
2016-03-28 14:32:30 +02:00
$(top_builddir)/man/nmcli.xml \
docs: add manual pages to docbook documentation This way they will make it to developer.gnome.org.
2016-03-24 13:30:52 +01:00
$(top_builddir)/man/NetworkManager.xml \
$(top_builddir)/man/NetworkManager.conf.xml \
$(top_builddir)/man/nmcli-examples.xml \
$(top_builddir)/man/nm-settings.xml \
docs: load the dbus documentation and manuals from original location There's nothing to expand there.
2016-04-04 20:32:38 +02:00
$(top_builddir)/man/nm-settings-keyfile.xml \
version.xml \
../../COPYING \
$(NULL)
docs: fix build without ifcfg-rh
2016-03-31 22:15:51 +02:00
if CONFIG_PLUGIN_IFCFG_RH
docs: load the dbus documentation and manuals from original location There's nothing to expand there.
2016-04-04 20:32:38 +02:00
content_files += $(top_builddir)/man/nm-settings-ifcfg-rh.xml
docs: fix build without ifcfg-rh
2016-03-31 22:15:51 +02:00
endif
docs: replace spec.html with docbook D-Bus API reference May use a lot of improvement (actually documenting the names and objects that use the interfaces in question), but at least this looks a lot better on developer.gnome.org.
2016-03-26 10:17:34 +01:00
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
include $(top_srcdir)/gtk-doc.make
####################################
docs: generate settings-spec.xml from libnm-util/nm-setting-docs.xml Generate docs/api/settings-spec.xml via an XSLT stylesheet applied to libnm-util/nm-setting-docs.xml.
2014-06-13 11:08:56 -04:00
EXTRA_DIST += version.xml.in settings-spec.xsl $(GENERATED_FILES)
build: clean all files on 'make distclean'
2012-11-13 23:13:25 +01:00
CLEANFILES += html/* tmpl/* xml/* \
NetworkManager-sections.txt \
docs: generate settings-spec.xml from libnm-util/nm-setting-docs.xml Generate docs/api/settings-spec.xml via an XSLT stylesheet applied to libnm-util/nm-setting-docs.xml.
2014-06-13 11:08:56 -04:00
NetworkManager-overrides.txt
docs: make the settings docs work from tarball builds docs/api/settings-spec.xml was accidentally not getting disted, because gtk-doc.make explicitly removes all DISTCLEANFILES from distdir. However, it doesn't actually make sense for the settings docs files to be in DISTCLEANFILES anyway; they were put there rather than CLEANFILES (IIRC) so that "make clean" in a tarball build wouldn't delete them and break things. But the right fix is to just make them only be in CLEANFILES when BUILD_SETTING_DOCS is true, and not ever get deleted otherwise. Also adjust the build rules to ensure that the generated docs don't get rebuilt in tarball builds, since that can cause problems when building from a read-only source tree, etc. Meanwhile, in an unrelated but also fatal bug, configure.ac's check for if the generated docs were already present never got updated for the cli/src -> clients/cli move, and so even if we had been disting settings-spec.xml, configure would still think that the tarball didn't have all of the generated docs in it, so SETTING_DOCS_AVAILABLE would be set false and none of the generated docs would get used. https://bugzilla.gnome.org/show_bug.cgi?id=740035
2014-11-12 15:50:39 -05:00
if BUILD_SETTING_DOCS
CLEANFILES += settings-spec.xml
endif
Reference in a new issue Copy permalink