summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs/libnm: add some more documentationlr/api-docsLubomir Rintel2017-03-171-18/+124
|
* docs/api: restructureLubomir Rintel2017-03-171-29/+105
| | | | | This splits the manual into parts and groups the D-Bus interfaces into chapters by the object class. It looks considerably better.
* docs/api: move D-Bus reference after nm-settingsLubomir Rintel2017-03-171-57/+57
|
* docs/api: make the connection settings look betterLubomir Rintel2017-03-172-22/+44
| | | | | 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.
* docs/api: add abstractLubomir Rintel2017-03-171-0/+20
|
* docs/api: add standard release informationLubomir Rintel2017-03-171-1/+5
|
* docs/api: reorder the manual pagesLubomir Rintel2017-03-171-4/+4
| | | | I guess the daemon and its configuration first makes most sense.
* include: use double-quotes to include our own headersThomas Haller2017-03-091-26/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In practice, this should only matter when there are multiple header files with the same name. That is something we try to avoid already, by giving headers a distinct name. When building NetworkManager itself, we clearly want to use double-quotes for including our own headers. But we also want to do that in our public headers. For example: ./a.c #include <stdio.h> #include <nm-1.h> void main() { printf ("INCLUDED %s/nm-2.h\n", SYMB); } ./1/nm-1.h #include <nm-2.h> ./1/nm-2.h #define SYMB "1" ./2/nm-2.h #define SYMB "2" $ cc -I./2 -I./1 ./a.c $ ./a.out INCLUDED 2/nm-2.h Exceptions to this are - headers in "shared/nm-utils" that include <NetworkManager.h>. These headers are copied into projects and hence used like headers owned by those projects. - examples/C
* docs: update yearsLubomir Rintel2017-03-024-2/+18
|
* docs: add missing links to dummy and macsec device/settingBeniamino Galvani2017-02-233-0/+6
| | | | | Fixes: b42f780e045c69e6b2c350dcd6de760c673a78e0 Fixes: d252a99fa25359e3795abcacfae08c76dc5386b8
* build: combine handling of setting docs and man pagesThomas Haller2017-02-141-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* core,libnm: introduce NMDeviceMacsecBeniamino Galvani2017-01-162-0/+2
| | | | | At the moment the device only exposes the current link status, but cannot create new links.
* build: build documentation for o.fd.NM.DnsManagerLubomir Rintel2016-12-152-0/+2
| | | | Fixes: 14105ece56b65fed64bade4013b105f7adaad27b
* libnm: implement support for DNS manager propertiesBeniamino Galvani2016-12-121-0/+1
|
* build: fix gtk-doc/introspection handling for buildThomas Haller2016-11-281-2/+0
| | | | | | | | | | | | | | | | | - `make dist` requires --enable-gtk-doc --enable-introspection --with-libnm-glib - --enable-gtk-doc requires --enable-introspection - --with-nmcli requires either --enable-introspection or pregenerated settings-docs.c files from the dist tarball. It does not require --enable-gtk-doc. There is a bit of a problem in that --enable-introspection requires now xsltproc. However, gobject-introspection does itself not depend on xsltproc. So, more correct might be a special --enable-doc argument, that combines --enable-introspection --with-xsltproc. Anyway, that seems to make it more complicated then it already is so just implicitly (and surprisingly?) require xsltproc with --enable-introspection. https://bugzilla.gnome.org/show_bug.cgi?id=775003
* build: rename intermediate doc xmlsThomas Haller2016-11-241-1/+1
| | | | | | | Allows to use pattern rules by making the related files having a common naming scheme. This commit only renames files.
* all: rename the introspection data to use the interface paths in namesLubomir Rintel2016-11-232-68/+68
| | | | | | | | 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.
* libnm: use the o.fd.DBus.ObjectManager API for object managementlr/object-managerLubomir Rintel2016-11-101-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This speeds up the initial object tree load significantly. Also, it reduces the object management complexity by shifting the duties to GDBusObjectManager. The lifetime of all NMObjects is now managed by the NMClient via the object manager. The NMClient creates the NMObjects for GDBus objects, triggers the initialization and serves as an object registry (replaces the nm-cache). The ObjectManager uses the o.fd.DBus.ObjectManager API to learn of the object creation, removal and property changes. It takes care of the property changes so that we don't have to and lets us always see a consistent object state. Thus at the time we learn of a new object we already know its properties. The NMObject unfortunately can't be made synchronously initializable as the NMRemoteConnection's settings are not managed with standard o.fd.DBus Properties and ObjectManager APIs and thus are not known to the ObjectManager. Thus most of the asynchronous object property changing code in nm-object.c is preserved. The objects notify the properties that reference them of their initialization in from their init_finish() methods, thus the asynchronously created objects are not allowed to fail creation (or the dependees would wait forever). Not a problem -- if a connection can't get its Settings, it's either invisible or being removed (presumably we'd learn of the removal from the object manager soon). The NMObjects can't be created by the object manager itself, since we can't determine the resulting object type in proxy_type() yet (we can't tell from the name and can't access the interface list). Therefore the GDBusObject is coupled with a NMObject later on. Lastly, now that all the objects are managed by the object manager, the NMRemoteSettings and NMManager go away when the daemon is stopped. The complexity of dealing with calls to NMClient that would require any of the resources that these objects manage (connection or device lists, etc.) had to be moved to NMClient. The bright side is that his allows for removal all of the daemon presence tracking from NMObject.
* build: merge "docs/Makefile.am" into toplevel MakefileThomas Haller2016-10-211-7/+0
|
* docs: add device statistics interfaceAlfonso Sanchez-Beato2016-08-172-0/+2
|
* docs: libnm: add type headers to scan listBeniamino Galvani2016-05-051-2/+0
| | | | | | | | nm-core-types.h and nm-types.h contain the actual definition of types and gtk-doc won't generate a "Implemented interfaces" section if they are not included. https://bugzilla.gnome.org/show_bug.cgi?id=765983
* docs: include the D-Bus enums reference with the API documentationLubomir Rintel2016-04-222-0/+7
| | | | | | Otherwise the types links would be dangling or resolved to slightly irrelevant documentation in libnm or completely irrelevant documentation in libnm-util.
* docs: toplevel document nitpicksLubomir Rintel2016-04-081-15/+17
|
* docs: don't set the online-location attributeLubomir Rintel2016-04-083-3/+3
| | | | | It causes the links to be based on a latest online version rather than on the current one.
* build: disable deprecation checks for internal compilationThomas Haller2016-04-053-0/+3
| | | | | | | | | | | | 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.
* dbus: remove the telepathy annotationsLubomir Rintel2016-04-051-7/+0
| | | | | We now generate documentation with gdbus-codegen and these are now useless.
* man: convert nm-online(1) manual to docbook refentryLubomir Rintel2016-04-052-0/+2
|
* man: convert nmtui(1) manual to docbook refentryLubomir Rintel2016-04-052-0/+2
|
* man: convert nmcli(1) manual to docbook refentryLubomir Rintel2016-04-052-0/+2
|
* docs: load the dbus documentation and manuals from original locationLubomir Rintel2016-04-052-46/+44
| | | | There's nothing to expand there.
* docs: fix build without ifcfg-rhJan Alexander Steffens (heftig)2016-03-311-2/+5
|
* docs: add manual pages to docbook documentationLubomir Rintel2016-03-262-1/+18
| | | | This way they will make it to developer.gnome.org.
* docs: remove some outdated documentationLubomir Rintel2016-03-264-676/+0
| | | | The migration guide and the old D-Bus API are not needed anymore.
* docs: replace spec.html with docbook D-Bus API referenceLubomir Rintel2016-03-262-18/+79
| | | | | | 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.
* docs: ignore some private libnm & libnm-core headersDan Williams2016-01-201-2/+4
|
* libnm,vpn: restore export of deprecated NMVpnPluginOld symbolsDan Williams2016-01-201-1/+0
| | | | | | Deprecated of course, but shouldn't have been removed from the ABI. Fixes: 867227dd4aac8371b3cacc366b32a3fa96eba42a
* build: rename directory "include" to "shared"Thomas Haller2015-12-241-2/+2
| | | | | | | | | | Up to now, the "include" directory contained (only) header files that were used project-wide by libs, core, clients, et al. Since the directory now also contains a non-header file, the "include" name is misleading. Instead of adding yet another directory that is project-wide, with non-header-only content, rename the "include" directory to "shared".
* docs: add missing documentation for settings and devicesJiří Klimeš2015-12-181-1/+9
|
* libnm: add internal header file "nm-core-types-internal.h"Thomas Haller2015-11-021-0/+1
| | | | | | | | | 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.
* build: extract version macros from "nm-version.h" to new header file ↵Thomas Haller2015-09-301-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | "nm-version-macros.h" For libnm library, "nm-dbus-interface.h" contains defines like the D-Bus paths of NetworkManager. It is desirable to have this header usable without having a dependency on "glib.h", for example for a QT application. For that, commit c0852964a890cf43cc2dcaeff41ac6edc5028f24 removed that dependancy. For libnm-glib library, the analog to "nm-dbus-interface.h" is "NetworkManager.h", and the same applies there. Commit 159e827a72f420048e12d318f8ba1edd3f641fc8 removed that include. However, that broke build on PackageKit [1] which expected to get the version macros by including "NetworkManager.h". So at least for libnm-glib, we need to preserve old behavior so that a user including "NetworkManager.h" gets the version macros, but not "glib.h". Extract the version macros to a new header file "nm-version-macros.h". This header doesn't include "glib.h" and can be included from "NetworkManager.h". This gives as previous behavior and a glib-free include. For libnm we still don't include "nm-version-macros.h" to "nm-dbus-interface.h". Very few users will actually need the version macros, but not using libnm. Users that use libnm, should just include (libnm's) "NetworkManager.h" to get all headers. As a special case, a user who doesn't want to use glib/libnm, but still needs both "nm-dbus-interface.h" and "nm-version-macros.h", can include them both separately. [1] https://github.com/hughsie/PackageKit/issues/85 Fixes: 4545a7fe9670ce4d7c259c11c2cc853bfae6729b
* build: make libnm-util/libnm-glib optionalDan Winship2015-08-101-1/+6
| | | | | | Add --without-libnm-glib, for people who don't want to build the legacy client libraries. When building with this option, dbus-glib and libdbus are not required.
* libnm/vpn: add new NMVpnServicePlugin classThomas Haller2015-07-291-0/+1
| | | | | | | | | | | | | | After copying "nm-vpn-plugin-old.*" to "nm-vpn-service-plugin.*", rename the class and add it to the Makefile. This will become the new VPN Service API for libnm 1.2. No changes done yet except renaming of the classes and functions. Rename the previous classes NMVpnPlugin(Old) to NMVpnServicePlugin to have a distinct name from NMVpnEditorPlugin. Buth are plugins, but with a different use. https://bugzilla.gnome.org/show_bug.cgi?id=749951
* libnm-core: add enum conversion utilitiesBeniamino Galvani2015-07-241-1/+2
| | | | | | | Add functions nm_utils_enum_to_str() and nm_utils_enum_from_str() which can be used to perform conversions between enum values and strings, passing the GType automatically generated for every enum by glib-mkenums.
* wimax: drop WiMAX support (bgo #747846)Dan Winship2015-04-173-7/+7
| | | | | | | | | | | | | | | | | | | | Even Fedora is no longer shipping the WiMAX SDK, so it's likely we'll eventually accidentally break some of the code in src/devices/wimax/ (if we haven't already). Discussion on the list showed a consensus for dropping support for WiMAX. So, remove the SDK checks from configure.ac, remove the WiMAX device plugin and associated manager support, and deprecate all the APIs. For compatibility reasons, it is still possible to create and save WiMAX connections, to toggle the software WiMAX rfkill state, and to change the "WIMAX" log level, although none of these have any effect, since no NMDeviceWimax will ever be created. nmcli was only compiling in support for most WiMAX operations when NM as a whole was built with WiMAX support, so that code has been removed now as well. (It is still possible to use nmcli to create and edit WiMAX connections, but those connections will never be activatable.)
* docs: fix out-of-tree buildYou-Sheng Yang2015-01-032-1/+4
| | | | | | | | | | | When compiling NetworkManager with --enable-gtk-doc outside the source tree, the generated documents are slightly different from those generated in tree. This patch fixes that missed COPYING file in $(top_builddir) and adds $(top_builddir)/libnm-util to DOC_SOURCE_DIR. https://bugzilla.gnome.org/show_bug.cgi?id=742139 Signed-off-by: You-Sheng Yang <vicamo@gmail.com>
* docs: misc small fixesDan Winship2014-12-183-1/+5
| | | | Cleans up all of the warnings that aren't overly annoying to clean up.
* libnm: rename NMSecretAgent to NMSecretAgentOldDan Winship2014-11-211-1/+1
| | | | | | As with NMVpnPluginOld, rename NMSecretAgent to NMSecretAgentOld, to leave the name "NMSecretAgent" open for a new-and-improved version in NM 1.2.
* man, docs: add the secret flags notes non-hackishlyDan Winship2014-11-191-1/+1
| | | | | | | | Since libnm-core secret-flags properties are now enum-typed rather than just being uints, we can now actually recognize them when generating docs, rather than just assuming that every property whose name ends in '-flags', but isn't in NMSettingDcb, is a secret-flags property.
* libnm, libnm-util: move settings doc generation to libnm-coreDan Winship2014-11-191-1/+1
| | | | | | | | | | | | | | | | | | | | | 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.)
* docs: make the settings docs work from tarball buildsDan Winship2014-11-141-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | 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
View Lorry Controller Status