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

109 lines
2.7 KiB
Text
Raw Normal View History

docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
## Process this file with automake to produce Makefile.in
AUTOMAKE_OPTIONS = 1.6
docs/test: add check that gtk-doc contains patch to generate proper documentation In libnm, we prefer opaque typedefs. gtk-doc needs to be patched to properly generate documentation. Add a check for that. Add a test. By default, this does not fail but just prints a warning. The test can be made failing by setting NMTST_CHECK_GTK_DOC=1. See-also: https://gitlab.gnome.org/GNOME/gtk-doc/merge_requests/2 (cherry picked from commit 02464c052e2f8a1e88b012e0a29f5f66fce310ad)
2018-09-09 21:41:40 +02:00
check_local =
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
# The name of the module
DOC_MODULE=libnm
# The top-level SGML file.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
docs: fix libnm docs out-of-tree build
2014-11-07 15:46:33 -05:00
DOC_SOURCE_DIR= \
$(top_srcdir)/libnm-core \
$(top_builddir)/libnm-core \
$(top_srcdir)/libnm \
$(top_builddir)/libnm
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=--rebuild-types --rebuild-sections
# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode --output-format=xml
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=
# Used for dependencies.
HFILE_GLOB=$(top_srcdir)/libnm-core/*.h $(top_srcdir)/libnm/*.h
CFILE_GLOB=$(top_srcdir)/libnm-core/*.c $(top_srcdir)/libnm/*.c
# Header files to ignore when scanning.
IGNORE_HFILES= \
libnm, docs: docs fixes Update the docs build to include and exclude the correct files. Fill in some missing documentation, and fix problems in the existing docs. (In particular, "<" can't appear as a literal in documentation, so change it to "&lt;". Also, "PKCS#12" has to be written as "PKCS#<!-- -->12", or gtk-doc will think "#12" is a reference to a type named "12".)
2014-11-07 12:38:17 -05:00
common.h \
libnm/crypto: rename libnm's crypto files "crypto.h" did not follow our common NM style naming. Rename the files.
2018-08-29 18:58:14 +02:00
nm-crypto.h \
libnm/crypto: add header "nm-crypto-impl.h" for crypto implementation There are two aspects: the public crypto API that is provided by "nm-crypto.h" header, and the internal header which crypto backends need to implement. Split them.
2018-08-29 20:46:17 +02:00
nm-crypto-impl.h \
libnm, docs: docs fixes Update the docs build to include and exclude the correct files. Fill in some missing documentation, and fix problems in the existing docs. (In particular, "<" can't appear as a literal in documentation, so change it to "&lt;". Also, "PKCS#12" has to be written as "PKCS#<!-- -->12", or gtk-doc will think "#12" is a reference to a type named "12".)
2014-11-07 12:38:17 -05:00
nm-dbus-helpers.h \
all: add nm-core-internal.h header Add a header file to expose private utility functions from libnm-core that can be used by NetworkManager (core) and libnm.so. The header is also used to give privileged access to libnm-core. Since NM links statically, these functions are not exported and not part of public ABI. This also removes the NM_UTILS_PRIVATE_CALL() macro and libnm.so no longer exports nm_utils_get_private(). Before, this functionality was partly declared in nm-utils-private.h. This was wrong because nm-utils-private.h is for functionality entirely private to libnm-core. Signed-off-by: Thomas Haller <thaller@redhat.com>
2014-07-27 20:35:17 +02:00
nm-core-internal.h \
libnm: add internal header file "nm-core-types-internal.h" This shall contain type definitions, with similar use to "nm-core-internal.h". However, it should contain a minimal set, so that we can include this header in other headers under "src/", without including the whole "nm-core-internal.h" in headers.
2015-10-30 11:29:56 +01:00
nm-core-types-internal.h \
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
nm-device-private.h \
libnm: create NMDhcpConfig as parent of NMDhcp4Config and NMDhcp6Config As with NMIP4Config and NMIP6Config, merge the two DHCP config classes into one in the public API.
2014-10-22 13:48:18 -04:00
nm-dhcp4-config.h \
nm-dhcp6-config.h \
libnm: implement support for DNS manager properties
2016-10-25 11:11:12 +02:00
nm-dns-manager.h \
libnm: create NMIPConfig as parent of NMIP4Config and NMIP6Config Create NMIPConfig as the parent of NMIP4Config and NMIP6Config, and remove the two subclasses from the public API; while it's convenient to still have both internally, they are now identical to the outside world.
2014-10-22 13:48:18 -04:00
nm-ip4-config.h \
nm-ip6-config.h \
libnm: merge NMRemoteSettings into NMClient Make NMRemoteSettings internal and have NMClient wrap all of its APIs, just like it does with NMManager.
2014-09-29 10:58:16 -04:00
nm-manager.h \
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
nm-object-private.h \
libnm, docs: docs fixes Update the docs build to include and exclude the correct files. Fill in some missing documentation, and fix problems in the existing docs. (In particular, "<" can't appear as a literal in documentation, so change it to "&lt;". Also, "PKCS#12" has to be written as "PKCS#<!-- -->12", or gtk-doc will think "#12" is a reference to a type named "12".)
2014-11-07 12:38:17 -05:00
nm-property-compare.h \
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
nm-remote-connection-private.h \
libnm: merge NMRemoteSettings into NMClient Make NMRemoteSettings internal and have NMClient wrap all of its APIs, just like it does with NMManager.
2014-09-29 10:58:16 -04:00
nm-remote-settings.h \
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
nm-setting-private.h \
libnm, docs: docs fixes Update the docs build to include and exclude the correct files. Fill in some missing documentation, and fix problems in the existing docs. (In particular, "<" can't appear as a literal in documentation, so change it to "&lt;". Also, "PKCS#12" has to be written as "PKCS#<!-- -->12", or gtk-doc will think "#12" is a reference to a type named "12".)
2014-11-07 12:38:17 -05:00
nm-utils-private.h \
docs: ignore some private libnm & libnm-core headers
2016-01-20 11:08:57 -06:00
nm-core-tests-enum-types.h \
nm-keyfile-internal.h \
nm-keyfile-utils.h \
test-general-enums.h
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
# Images to copy into HTML directory.
HTML_IMAGES = libnm.png
# Extra XML files that are included by $(DOC_MAIN_SGML_FILE).
content_files = version.xml
# Other files to distribute.
extra_files = libnm.png
# CFLAGS and LDFLAGS for compiling scan program. Only needed
# if $(DOC_MODULE).types is non-empty.
all: replace non-leading tabs with spaces We commonly only allow tabs at the beginning of a line, not afterwards. The reason for this style is so that the code looks formated right with tabstop=4 and tabstop=8.
2018-02-02 10:55:34 +01:00
GTKDOC_CFLAGS = \
-I$(top_srcdir)/libnm-core \
-I$(top_builddir)/libnm-core \
-I$(top_srcdir)/libnm \
-I$(top_builddir)/libnm \
build: disable deprecation checks for internal compilation For internal compilation we want to be able to use deprecated API without warnings. Define the version min/max macros to effectively disable deprecation warnings. However, don't do it via CFLAGS option in the makefiles, instead hack it to "nm-default.h". After all, *every* source file that is for internal compilation needs to include this header as first.
2016-04-05 21:18:43 +02:00
-DNM_VERSION_MIN_REQUIRED=NM_VERSION_0_9_8 \
build: allow building with address sanitizer only for executables Shared libraries built with sanitizers are a bit inconvenient to use because they require that any application linking to them is run with libasan preloaded using LD_PRELOAD. This limitation makes the sanitizer support less useful because applications will refuse to start unless there is a special environment variable set. Let's turn the --enable-address-sanitizer configure flag into --with-address-sanitizer=yes|no|exec so that is possible to enable asan only for executables.
2018-02-07 11:10:31 +01:00
$(GLIB_CFLAGS) \
$(SANITIZER_EXEC_CFLAGS)
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
all: replace non-leading tabs with spaces We commonly only allow tabs at the beginning of a line, not afterwards. The reason for this style is so that the code looks formated right with tabstop=4 and tabstop=8.
2018-02-02 10:55:34 +01:00
GTKDOC_LIBS = \
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
$(top_builddir)/libnm/libnm.la \
build: allow building with address sanitizer only for executables Shared libraries built with sanitizers are a bit inconvenient to use because they require that any application linking to them is run with libasan preloaded using LD_PRELOAD. This limitation makes the sanitizer support less useful because applications will refuse to start unless there is a special environment variable set. Let's turn the --enable-address-sanitizer configure flag into --with-address-sanitizer=yes|no|exec so that is possible to enable asan only for executables.
2018-02-07 11:10:31 +01:00
$(GLIB_LIBS) \
$(SANITIZER_EXEC_LDFLAGS)
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
# include common portion ...
include $(top_srcdir)/gtk-doc.make
build: Add meson build files to distributable files Although it is possible to generate distributable files on meson since version 0.41 by using the `ninja dist` command, autotools does different things that end up creating a different distributable file. meson build files have been added to autotools build files as distributable files, so the whole meson port would also be distributed. https://mail.gnome.org/archives/networkmanager-list/2018-January/msg00047.html
2018-01-08 13:06:54 +01:00
EXTRA_DIST += version.xml.in meson.build
docs: add libnm documentation Add docs infrastructure
2014-07-24 08:59:21 -04:00
CLEANFILES += \
libnm-sections.txt \
libnm-overrides.txt \
html/* \
tmpl/* \
xml/*
docs/test: add check that gtk-doc contains patch to generate proper documentation In libnm, we prefer opaque typedefs. gtk-doc needs to be patched to properly generate documentation. Add a check for that. Add a test. By default, this does not fail but just prints a warning. The test can be made failing by setting NMTST_CHECK_GTK_DOC=1. See-also: https://gitlab.gnome.org/GNOME/gtk-doc/merge_requests/2 (cherry picked from commit 02464c052e2f8a1e88b012e0a29f5f66fce310ad)
2018-09-09 21:41:40 +02:00
if GTK_DOC_BUILD_HTML
check-local-gtk-doc-patch:
@if grep -q -F '<a href="libnm-nm-setting-user.html">nm-setting-user</a>' "$(top_builddir)/docs/libnm/html/index.html"; then \
echo "WARNING: The generated documentation has issues. Patch your gtk-doc (see https://gitlab.gnome.org/GNOME/gtk-doc/merge_requests/2). Let this check fail with NMTST_CHECK_GTK_DOC=1"; \
test "$$NMTST_CHECK_GTK_DOC" != 1; \
fi
check_local += check-local-gtk-doc-patch
endif
check-local: $(check_local)
Reference in a new issue Copy permalink