summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThomas Haller <thaller@redhat.com>2021-02-12 15:01:09 +0100
committerThomas Haller <thaller@redhat.com>2021-02-18 19:46:51 +0100
commitfdf9614ba793a023d9b6c0f6a078beded8143771 (patch)
tree1c21d90c0873da541302bc0e209428b667029054 /docs
parent2c1f8e9108a33eb3819b1bda1138a01bfd71746a (diff)
downloadNetworkManager-fdf9614ba793a023d9b6c0f6a078beded8143771.tar.gz
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.
Diffstat (limited to 'docs')
-rw-r--r--docs/api/Makefile.am4
-rw-r--r--docs/api/network-manager-docs.xml4
-rw-r--r--docs/libnm/Makefile.am16
-rw-r--r--docs/libnm/meson.build10
4 files changed, 17 insertions, 17 deletions
diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am
index 65eed1a534..a5b71ad3fe 100644
--- a/docs/api/Makefile.am
+++ b/docs/api/Makefile.am
@@ -79,8 +79,8 @@ content_files = \
dbus-org.freedesktop.NetworkManager.VPN.Connection.xml \
dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml \
dbus-org.freedesktop.NetworkManager.xml \
- $(top_builddir)/libnm-core/nm-dbus-types.xml \
- $(top_builddir)/libnm-core/nm-vpn-dbus-types.xml \
+ $(top_builddir)/src/libnm-core-public/nm-dbus-types.xml \
+ $(top_builddir)/src/libnm-core-public/nm-vpn-dbus-types.xml \
$(top_builddir)/man/nmcli.xml \
$(top_builddir)/man/nmtui.xml \
$(top_builddir)/man/nm-online.xml \
diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml
index 7a57582caa..f921b08604 100644
--- a/docs/api/network-manager-docs.xml
+++ b/docs/api/network-manager-docs.xml
@@ -265,7 +265,7 @@
<chapter id="dbus-types">
<title>Types</title>
- <xi:include href="../../libnm-core/nm-dbus-types.xml"/>
+ <xi:include href="../../src/libnm-core-public/nm-dbus-types.xml"/>
</chapter>
</part>
@@ -289,7 +289,7 @@
</chapter>
<chapter id="dbus-vpn-types">
<title>Types</title>
- <xi:include href="../../libnm-core/nm-vpn-dbus-types.xml"/>
+ <xi:include href="../../src/libnm-core-public/nm-vpn-dbus-types.xml"/>
</chapter>
</part>
diff --git a/docs/libnm/Makefile.am b/docs/libnm/Makefile.am
index ae61d85af0..c868fff790 100644
--- a/docs/libnm/Makefile.am
+++ b/docs/libnm/Makefile.am
@@ -13,8 +13,10 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR= \
- $(top_srcdir)/libnm-core \
- $(top_builddir)/libnm-core \
+ $(top_builddir)/src/libnm-core-public \
+ $(top_srcdir)/src/libnm-core-public \
+ $(top_builddir)/src/libnm-core-impl \
+ $(top_srcdir)/src/libnm-core-impl \
$(top_srcdir)/libnm \
$(top_builddir)/libnm
@@ -28,8 +30,8 @@ MKDB_OPTIONS=--sgml-mode --output-format=xml
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
+HFILE_GLOB=$(top_srcdir)/src/libnm-core-public/*.h $(top_srcdir)/libnm/*.h
+CFILE_GLOB=$(top_srcdir)/src/libnm-core-impl/*.c $(top_srcdir)/libnm/*.c
# Header files to ignore when scanning.
IGNORE_HFILES= \
@@ -84,10 +86,10 @@ extra_files = libnm.png
# CFLAGS and LDFLAGS for compiling scan program. Only needed
# if $(DOC_MODULE).types is non-empty.
GTKDOC_CFLAGS = \
- -I$(top_srcdir)/libnm-core \
- -I$(top_builddir)/libnm-core \
- -I$(top_srcdir)/libnm \
+ -I$(top_builddir)/src/libnm-core-public \
+ -I$(top_srcdir)/src/libnm-core-public \
-I$(top_builddir)/libnm \
+ -I$(top_srcdir)/libnm \
-DNM_VERSION_MIN_REQUIRED=NM_VERSION_0_9_8 \
$(GLIB_CFLAGS) \
$(SANITIZER_EXEC_CFLAGS)
diff --git a/docs/libnm/meson.build b/docs/libnm/meson.build
index 102009899d..7cb5c646ee 100644
--- a/docs/libnm/meson.build
+++ b/docs/libnm/meson.build
@@ -1,10 +1,5 @@
# SPDX-License-Identifier: LGPL-2.1-or-later
-src_dirs = [
- libnm_core_inc,
- libnm_inc,
-]
-
private_headers = [
'common.h',
'nm-core-internal.h',
@@ -57,7 +52,10 @@ version_xml = configure_file(
gnome.gtkdoc(
libnm_name,
main_xml: libnm_name + '-docs.xml',
- src_dir: src_dirs,
+ src_dir: [
+ libnm_core_public_inc,
+ libnm_inc,
+ ],
dependencies: libnm_dep,
scan_args: scan_args,
scanobjs_args: '--type-init-func="g_type_init();"',