summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLubomir Rintel <lkundrak@v3.sk>2019-03-20 08:52:46 +0100
committerLubomir Rintel <lkundrak@v3.sk>2019-03-20 08:53:10 +0100
commitcfcd746260b0dc1af80dd769d67dfa2649569b36 (patch)
treedd734015ccf393d1b8a03e2d2720a49bde4ab970
parent0750ff1f814f3034d5245d0215874c787fc30db5 (diff)
downloadNetworkManager-cfcd746260b0dc1af80dd769d67dfa2649569b36.tar.gz
settings: remove README
It is out of date and doesn't seem to serve any real purpose.
-rw-r--r--Makefile.am1
-rw-r--r--src/settings/plugins/README33
2 files changed, 0 insertions, 34 deletions
diff --git a/Makefile.am b/Makefile.am
index e322b44990..21c43884b7 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -4556,7 +4556,6 @@ EXTRA_DIST += \
tools/test-sudo-wrapper.sh \
tools/enums-to-docbook.pl \
\
- src/settings/plugins/README \
src/settings/plugins/meson.build \
\
$(NULL)
diff --git a/src/settings/plugins/README b/src/settings/plugins/README
deleted file mode 100644
index 307d0bb1ed..0000000000
--- a/src/settings/plugins/README
+++ /dev/null
@@ -1,33 +0,0 @@
-Plugins generally have three components:
-
-1) plugin object: manages the individual "connections", which are
- just objects wrapped around on-disk config data. The plugin handles requests
- to add new connections via the NM D-Bus API, and also watches config
- directories for changes to configuration data. Plugins implement the
- NMSettingsPlugin interface. See plugin.c.
-
-2) "connections": subclasses of NMSettingsConnection. They handle updates to
- configuration data, deletion, etc. See NMKeyfileConnection.
-
-3) reader/writer code: typically a separate static library that gets linked
- into the main plugin shared object, so they can be unit tested separately
- from the plugin. This code should read config data from disk and create
- an NMConnection from it, and be capable of taking an NMConnection and writing
- out appropriate configuration data to disk.
-
-NM will first call the "factory" function that every module must provide, which
-is nm_settings_plugin_factory(). That function creates and returns a singleton
-instance of the plugin's main object, which implements NMSettingsPlugin.
-That interface is implemented via the object definition in G_DEFINE_TYPE_EXTENDED
-in plugin.c, which registers the interface setup function
-settings_plugin_interface_init(), which when called actually sets up the vtables
-for the functions defined by NMSettingsPluginInterface. Thus there are two
-entry points into the plugin: nm_settings_plugin_factory() and
-the NMSettingsPluginInterface methods.
-
-The plugin also emits various signals (defined by NMSettingsPluginInterface)
-which NetworkManager listens for. These include notifications of new
-connections if they were created via changes to the on-disk files. The
-"connection" objects can also emit signals (defined by the NMSettingsConnection
-and NMConnection superclasses) when the connections' backing storage gets
-changed or deleted.