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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

140 lines
4.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
XSLTPROC = xsltproc --xinclude --nonet
XMLS = $(wildcard $(top_srcdir)/introspection/nm-*.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
build: combine handling of setting docs and man pages Building the man pages via xsltproc requires "docbook.xsl" which is part of docbook. Previously, we would build the man pages solely based on "--enable-introspection", which checks for the presence of xsltproc, but not docbook. This can lead to build failure when docbook is not available, but "--enable-introspection" is given. Instead of adding yet another configure option to fine-tune and say "--with-docbook --disable-gtk-doc", just simplify it. Now, documentation (both man pages and setting docs) will be generated with "--enable-gtk-doc" and "--enable-introspection". If the documentation is not about to be generated, pre-generated docs will be installed if they are available. That is commonly the case with a source tarball, but not with a git checkout. Finally, if documentation is nither generated nor pre-generated, no documentation will be installed *duh*. This removes the possibility to treat man pages separate from settings docs. Now you either generate both, install both pre-generated, or don't get any of them. https://bugzilla.gnome.org/show_bug.cgi?id=778551
2017-02-13 16:26:20 +01:00
if BUILD_DOCS
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
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
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/api: make the connection settings look better Turn the it into a chapter with refentries to better fit the structure of the table of contects. Also, include the properties in the index.
2017-03-10 18:40:03 +01:00
# Files to be included in $(DOC_MAIN_SGML_FILE)
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
content_files = \
docs/api: make the connection settings look better Turn the it into a chapter with refentries to better fit the structure of the table of contects. Also, include the properties in the index.
2017-03-10 18:40:03 +01:00
$(GENERATED_FILES) \
all: rename the introspection data to use the interface paths in names This makes it easier to install the files with proper names. Also, it makes the makefile rules slightly simpler. Lastly, the documentation is now generated into docs/api, which makes it possible to get rid of the awkward relative file names in docbook.
2016-11-23 13:14:08 +01:00
dbus-org.freedesktop.NetworkManager.AccessPoint.xml \
core/devices: Add P2P Wifi device and peer tracking This only adds the new device type and simple peer list handling.
2018-10-10 23:30:46 +02:00
dbus-org.freedesktop.NetworkManager.AgentManager.xml \
all: rename the introspection data to use the interface paths in names This makes it easier to install the files with proper names. Also, it makes the makefile rules slightly simpler. Lastly, the documentation is now generated into docs/api, which makes it possible to get rid of the awkward relative file names in docbook.
2016-11-23 13:14:08 +01:00
dbus-org.freedesktop.NetworkManager.Connection.Active.xml \
core/devices: Add P2P Wifi device and peer tracking This only adds the new device type and simple peer list handling.
2018-10-10 23:30:46 +02:00
dbus-org.freedesktop.NetworkManager.DHCP4Config.xml \
all: rename the introspection data to use the interface paths in names This makes it easier to install the files with proper names. Also, it makes the makefile rules slightly simpler. Lastly, the documentation is now generated into docs/api, which makes it possible to get rid of the awkward relative file names in docbook.
2016-11-23 13:14:08 +01:00
dbus-org.freedesktop.NetworkManager.DHCP6Config.xml \
core/devices: Add P2P Wifi device and peer tracking This only adds the new device type and simple peer list handling.
2018-10-10 23:30:46 +02:00
dbus-org.freedesktop.NetworkManager.Device.Adsl.xml \
all: rename the introspection data to use the interface paths in names This makes it easier to install the files with proper names. Also, it makes the makefile rules slightly simpler. Lastly, the documentation is now generated into docs/api, which makes it possible to get rid of the awkward relative file names in docbook.
2016-11-23 13:14:08 +01:00
dbus-org.freedesktop.NetworkManager.Device.Bluetooth.xml \
dbus-org.freedesktop.NetworkManager.Device.Bond.xml \
dbus-org.freedesktop.NetworkManager.Device.Bridge.xml \
core/devices: Add P2P Wifi device and peer tracking This only adds the new device type and simple peer list handling.
2018-10-10 23:30:46 +02:00
dbus-org.freedesktop.NetworkManager.Device.Dummy.xml \
all: rename the introspection data to use the interface paths in names This makes it easier to install the files with proper names. Also, it makes the makefile rules slightly simpler. Lastly, the documentation is now generated into docs/api, which makes it possible to get rid of the awkward relative file names in docbook.
2016-11-23 13:14:08 +01:00
dbus-org.freedesktop.NetworkManager.Device.Generic.xml \
core/devices: Add P2P Wifi device and peer tracking This only adds the new device type and simple peer list handling.
2018-10-10 23:30:46 +02:00
dbus-org.freedesktop.NetworkManager.Device.IPTunnel.xml \
all: rename the introspection data to use the interface paths in names This makes it easier to install the files with proper names. Also, it makes the makefile rules slightly simpler. Lastly, the documentation is now generated into docs/api, which makes it possible to get rid of the awkward relative file names in docbook.
2016-11-23 13:14:08 +01:00
dbus-org.freedesktop.NetworkManager.Device.Infiniband.xml \
support loopback interface Support managing the loopback interface through NM as the users want to set the proper mtu for loopback interface when forwarding the packets. Additionally, the IP addresses, DNS, route and routing rules are also allowed to configure for the loopback connection profiles. https://bugzilla.redhat.com/show_bug.cgi?id=2060905
2022-06-12 19:50:09 -04:00
dbus-org.freedesktop.NetworkManager.Device.Loopback.xml \
core/devices: Add P2P Wifi device and peer tracking This only adds the new device type and simple peer list handling.
2018-10-10 23:30:46 +02:00
dbus-org.freedesktop.NetworkManager.Device.Macsec.xml \
dbus-org.freedesktop.NetworkManager.Device.Macvlan.xml \
all: rename the introspection data to use the interface paths in names This makes it easier to install the files with proper names. Also, it makes the makefile rules slightly simpler. Lastly, the documentation is now generated into docs/api, which makes it possible to get rid of the awkward relative file names in docbook.
2016-11-23 13:14:08 +01:00
dbus-org.freedesktop.NetworkManager.Device.Modem.xml \
core/devices: Add P2P Wifi device and peer tracking This only adds the new device type and simple peer list handling.
2018-10-10 23:30:46 +02:00
dbus-org.freedesktop.NetworkManager.Device.OlpcMesh.xml \
dbus-org.freedesktop.NetworkManager.Device.Statistics.xml \
dbus-org.freedesktop.NetworkManager.Device.Team.xml \
dbus-org.freedesktop.NetworkManager.Device.Tun.xml \
all: rename the introspection data to use the interface paths in names This makes it easier to install the files with proper names. Also, it makes the makefile rules slightly simpler. Lastly, the documentation is now generated into docs/api, which makes it possible to get rid of the awkward relative file names in docbook.
2016-11-23 13:14:08 +01:00
dbus-org.freedesktop.NetworkManager.Device.Veth.xml \
core/devices: Add P2P Wifi device and peer tracking This only adds the new device type and simple peer list handling.
2018-10-10 23:30:46 +02:00
dbus-org.freedesktop.NetworkManager.Device.Vlan.xml \
dbus-org.freedesktop.NetworkManager.Device.Vxlan.xml \
wifi-p2p: rename Wi-Fi P2P After renaming the files, also rename all the content to follow the "Wi-Fi P2P" naming scheme.
2019-01-28 15:21:59 +01:00
dbus-org.freedesktop.NetworkManager.Device.WifiP2P.xml \
core: introduce NMDeviceWireGuard For now, the device only exposes partial link status (not including peers). It cannot create new links.
2018-03-13 13:42:38 +00:00
dbus-org.freedesktop.NetworkManager.Device.WireGuard.xml \
core/devices: Add P2P Wifi device and peer tracking This only adds the new device type and simple peer list handling.
2018-10-10 23:30:46 +02:00
dbus-org.freedesktop.NetworkManager.Device.Wired.xml \
dbus-org.freedesktop.NetworkManager.Device.Wireless.xml \
dbus-org.freedesktop.NetworkManager.Device.xml \
build: build documentation for o.fd.NM.DnsManager Fixes: 14105ece56b65fed64bade4013b105f7adaad27b
2016-12-15 20:13:40 +01:00
dbus-org.freedesktop.NetworkManager.DnsManager.xml \
core/devices: Add P2P Wifi device and peer tracking This only adds the new device type and simple peer list handling.
2018-10-10 23:30:46 +02:00
dbus-org.freedesktop.NetworkManager.IP4Config.xml \
dbus-org.freedesktop.NetworkManager.IP6Config.xml \
dbus-org.freedesktop.NetworkManager.PPP.xml \
dbus-org.freedesktop.NetworkManager.SecretAgent.xml \
dbus-org.freedesktop.NetworkManager.Settings.Connection.xml \
dbus-org.freedesktop.NetworkManager.Settings.xml \
dbus-org.freedesktop.NetworkManager.VPN.Connection.xml \
dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml \
dbus-org.freedesktop.NetworkManager.xml \
build: move "libnm-core/" to "src/" and split it "libnm-core/" is rather complicated. It provides a static library that is linked into libnm.so and NetworkManager. It also contains public headers (like "nm-setting.h") which are part of public libnm API. Then we have helper libraries ("libnm-core/nm-libnm-core-*/") which only rely on public API of libnm-core, but are themself static libraries that can be used by anybody who uses libnm-core. And "libnm-core/nm-libnm-core-intern" is used by libnm-core itself. Move "libnm-core/" to "src/". But also split it in different directories so that they have a clearer purpose. The goal is to have a flat directory hierarchy. The "src/libnm-core*/" directories correspond to the different modules (static libraries and set of headers that we have). We have different kinds of such modules because of how we combine various code together. The directory layout now reflects this.
2021-02-12 15:01:09 +01:00
$(top_builddir)/src/libnm-core-public/nm-dbus-types.xml \
$(top_builddir)/src/libnm-core-public/nm-vpn-dbus-types.xml \
man: convert nmcli(1) manual to docbook refentry
2016-03-28 14:32:30 +02:00
$(top_builddir)/man/nmcli.xml \
man: convert nmtui(1) manual to docbook refentry
2016-04-04 18:29:46 +02:00
$(top_builddir)/man/nmtui.xml \
man: convert nm-online(1) manual to docbook refentry
2016-04-04 18:05:49 +02:00
$(top_builddir)/man/nm-online.xml \
initrd: add configuration generator nm-initrd-generator scans the command line for options relevant to network configuration and creates configuration files for an early instance of NetworkManager run from the initial ramdisk during early boot.
2018-04-28 20:36:15 +02:00
$(top_builddir)/man/nm-initrd-generator.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 \
man: split NetworkManager-dispatcher(8) manual page out of NetworkManager(8) https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/784
2021-03-16 14:30:58 +01:00
$(top_builddir)/man/NetworkManager-dispatcher.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.conf.xml \
man: add NetworkManager-wait-online.service.8 manual NetworkManager-wait-online is a constant source of confusion, as it seems to delay the boot (when it's often just the messenger or either a network problem, a NetworkManager misconfiguration or a misconfiguration of other systemd services). Try to clear that up with a manual page. https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/1130
2022-03-02 11:05:45 +01:00
$(top_builddir)/man/NetworkManager-wait-online.service.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/nmcli-examples.xml \
docs: add more nm-settings manpages (dbus,nmcli,keyfile,ifcfg-rh) A significant part of NetworkManager's API are the connection profiles, documented in `man nm-settings*`. But there are different aspects about profiles, depending on what you are interested. There is the D-Bus API, nmcli options, keyfile format, and ifcfg-rh format. Additionally, there is also libnm API. Add distinct manual pages for the four aspects. Currently the two new manual pages "nm-settings-dbus" and "nm-settings-nmcli" are still identical to the former "nm-settings.5" manual. In the future, they will diverge to account for the differences. There are the following aspects: - "dbus" - "keyfile" - "ifcfg-rh" - "nmcli" For "libnm" we don't generate a separate "nm-settings-libnm" manual page. That is instead documented via gtk-doc. Currently the keyfile and ifcfg-rh manual pages only detail settings which differ. But later I think also these manual pages should contain all settings that apply.
2020-06-02 19:24:12 +02:00
$(top_builddir)/man/nm-settings-dbus.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 \
docs: add more nm-settings manpages (dbus,nmcli,keyfile,ifcfg-rh) A significant part of NetworkManager's API are the connection profiles, documented in `man nm-settings*`. But there are different aspects about profiles, depending on what you are interested. There is the D-Bus API, nmcli options, keyfile format, and ifcfg-rh format. Additionally, there is also libnm API. Add distinct manual pages for the four aspects. Currently the two new manual pages "nm-settings-dbus" and "nm-settings-nmcli" are still identical to the former "nm-settings.5" manual. In the future, they will diverge to account for the differences. There are the following aspects: - "dbus" - "keyfile" - "ifcfg-rh" - "nmcli" For "libnm" we don't generate a separate "nm-settings-libnm" manual page. That is instead documented via gtk-doc. Currently the keyfile and ifcfg-rh manual pages only detail settings which differ. But later I think also these manual pages should contain all settings that apply.
2020-06-02 19:24:12 +02:00
$(top_builddir)/man/nm-settings-nmcli.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
version.xml \
$(NULL)
docs: fix build without ifcfg-rh
2016-03-31 22:15:51 +02:00
docs: include openvswitch(7) man page only when ovs is enabled
2018-09-14 18:14:46 +02:00
if WITH_OPENVSWITCH
content_files += $(top_builddir)/man/nm-openvswitch.xml
endif
man: add `man 8 nm-cloud-setup` https://bugzilla.redhat.com/show_bug.cgi?id=1867997 https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues/ ## 600
2020-12-03 18:12:21 +01:00
if BUILD_NM_CLOUD_SETUP
content_files += $(top_builddir)/man/nm-cloud-setup.xml
endif
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: fix dependency of "nm-settings*xml" to "common.ent" "man/nm-settings%.xml" really should depend on "common.ent". The reason is that XSL files like "man/nm-settings.xsl" include "common.ent". The previous code already tried to express that, but for some reasons this dependency was not honored. Fix that. However, that uncovers another problem with gtk-doc.make. If we do that without the workaround for "docs/api/Makefile.am", then $ ./autogen.sh && make V=1 SHELL='sh -x' distcheck breaks. The reason is not clear to me. The new dependency leads to rebuild "man/nm-settings-keyfile.xml". But that is worse, somehow the file "$(top_srcdir)/man/nm-settings-keyfile.xml" ends up being read-only. Afterwards, gtk-doc.make does setup-build.stamp: -$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ files=`echo $(SETUP_FILES) $(DOC_MODULE).types`; \ if test "x$$files" != "x" ; then \ for file in $$files ; do \ destdir=`dirname $(abs_builddir)/$$file`; \ test -d "$$destdir" || mkdir -p "$$destdir"; \ test -f $(abs_srcdir)/$$file && \ cp -pf $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \ done; \ fi; \ fi $(AM_V_at)touch setup-build.stamp so that the files in build dir are also read-only. Then, make distcheck goes ahead and builds the files once again, which fails. You are welcome to understand why this workaround is necessary. Please then create a better fix.
2020-06-02 17:47:30 +02:00
# workaround setup-build.stamp from gtk-doc.make, which copies
# the file as read-only. That breaks later build steps, as the
# file can no longer be written. Instead, copy the file with `cp -f`
# only.
setup-build.stamp:
-$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
files=`echo $(SETUP_FILES) $(DOC_MODULE).types`; \
if test "x$$files" != "x" ; then \
for file in $$files ; do \
destdir=`dirname $(abs_builddir)/$$file`; \
test -d "$$destdir" || mkdir -p "$$destdir"; \
test -f $(abs_srcdir)/$$file && \
( cp -pf $(abs_srcdir)/$$file $(abs_builddir)/$$file ; \
chmod u+w $(abs_builddir)/$$file ) || true; \
done; \
fi; \
fi
$(AM_V_at)touch setup-build.stamp
docs/api: fix ugly things in Makefile Turns out automake doesn't like either that we add dependencies to a target conditionally. Not sure why, but it's a tasteless thing to do nevertheless: gtk-doc.make:174: warning: $(DOC_MAIN_SGML_FILE) was already defined in condition BUILD_DOCS, which is included in condition TRUE ... docs/api/Makefile.am:112: 'gtk-doc.make' included from here docs/api/Makefile.am:14: ... '$(DOC_MAIN_SGML_FILE)' previously defined here In any case, the dependency is wrong in the first place -- the source document doesn't depend on other source. The target (which is a stamp file, since the xslt processor produces multiple files) does! Moreover, there's a dependency of the stamp file on $(content_files) already, so including GENERATED_FILES (like we already do) in content_files should be sufficient. While at that, deal with other not-so-nice things; don't extend "all" target needlessly and don't define a target conditionally.
2022-11-07 19:52:21 +01:00
settings-spec.xml: settings-spec.xsl $(top_builddir)/man/nm-settings-docs-dbus.xml
$(AM_V_GEN) (! test -f $@ || chmod u+w $@) && xsltproc --output $@ $^
docs: create new master NM documentation module
2011-02-16 16:24:16 -06:00
build: ignore "docs/api/NetworkManager.actions" build artifact I still don't understand why we get now these ".actions" build artifacts. Anyway, I don't think we need to care. Just ignore it.
2020-12-03 15:19:56 +01:00
EXTRA_DIST += \
version.xml.in \
settings-spec.xsl \
meson.build \
$(GENERATED_FILES) \
$(NULL)
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
build: ignore "docs/api/NetworkManager.actions" build artifact I still don't understand why we get now these ".actions" build artifacts. Anyway, I don't think we need to care. Just ignore it.
2020-12-03 15:19:56 +01:00
CLEANFILES += \
html/* \
tmpl/* \
xml/* \
NetworkManager-overrides.txt \
NetworkManager-sections.txt \
NetworkManager.actions \
settings-spec.xml \
$(NULL)
Reference in a new issue Copy permalink