summaryrefslogtreecommitdiff
path: root/libnm/generate-setting-docs.py
Commit message (Collapse)AuthorAgeFilesLines
* libnm/docs: don't document NM_SETTING_NAME propertyThomas Haller2018-08-031-1/+1
| | | | | | | | | | NM_SETTING_NAME is a special property that only has relevance to libnm. It is inherited by all NMSetting instances. It is read-only, and it has no corresponding value on D-Bus or nmcli. Skip it during generate-setting-docs.py. This also drops it from `man nm-settings`, where it doesn't belong.
* generate-setting-docs.py: remove unreachable code in get_default_value()Thomas Haller2018-07-111-2/+0
| | | | | | | | | | | | | | | get_prop_type() cannot ever return "gchar", because it only returns values from "dbus_type_name_map" or for enums it has the form "%s (%s)" % (pspec.value_type.name, prop_type) Another reason why get_prop_type() cannot ever return a "char" type, is because of what get_prop_type() does. get_prop_type() only returns types based on the D-Bus type of the property, and on D-Bus there is no fundamental type for a one-character string. There is either a (UTF-8 encoded) string, or integer values of varying sizes. But in terms of unicode, a 'char' type makes little sense on D-Bus. And neither does it for get_prop_type().
* generate-setting-docs.py: remove unused propxml argument from get_prop_type()Thomas Haller2018-07-111-3/+3
|
* build: library paths as parameters for generate-settings-docs.pyIñigo Martínez2017-12-141-0/+5
| | | | | | | | | | | | | | | | | | generate-settings-docs.py script uses the `LD_LIBRARY_PATH` to prepend directories to the library search path, which is useful to load a just built libnm shared library, when generating the `nm-settings-docs.xml` and `nm-property-docs.xml` files. However, this is a problem for meson, which is not able to set environment variables when executing the script. This patch adds a new optional parameter, `-l` or `--lib-path` that can be used to pass different paths to be prepended without using the `LD_LIBRARY_PATH` environment, which can still be used. [thaller@redhat.com: fix script to handle None lib_path argument] https://mail.gnome.org/archives/networkmanager-list/2017-December/msg00044.html
* generate-setting-docs: document aa{sv} typeLubomir Rintel2017-12-111-1/+2
| | | | Will be useful for tc qdiscs.
* libnm-core: add backend for GVariant de/serialization of link_watchers.Francesco Giudici2017-12-081-0/+1
|
* generate-setting-docs: error out on missing documentationLubomir Rintel2017-10-301-0/+3
|
* cli: embed gtk-doc directly in property-info structureThomas Haller2017-03-301-6/+14
| | | | Also mark them for translation.
* doc: fix generate-setting-docs.py for supporting Python 3 sorted() styleThomas Haller2017-03-201-7/+4
| | | | | | Python 3 has no "cmp" argument to sorted(). Fixes: b0da972f5fa51608cca5837af9fe7094818204f8
* libnm/generate-setting-docs.py: include description attributeLubomir Rintel2017-03-171-3/+6
|
* doc: sort "connection" settings first in nm-settings manualLubomir Rintel2017-03-171-1/+9
|
* build: fix build with older giLubomir Rintel2017-01-191-0/+5
| | | | | Fixes: 6c96aafaa9a61ca4fe713551a4cd4b15fb7e8a63 (cherry picked from commit 22722b77322fb3ddc1a99509340e8175acddb154)
* build: make the doc generator find the right libnm.soLubomir Rintel2017-01-191-2/+14
| | | | | | | | At some point gobject-introspection added an API to add a library path and stopped honoring the LD_LIBRARY_PATH (a bug, according to GI documentation?). (cherry picked from commit 6c96aafaa9a61ca4fe713551a4cd4b15fb7e8a63)
* build: fix compilation with Python3mirh2016-11-291-2/+2
| | | | | | | | | has_key() has long been dropped https://docs.python.org/3.1/whatsnew/3.0.html#builtins Should still work with anything from 2.3 onwards https://github.com/NetworkManager/NetworkManager/pull/11
* python: use gi.require_version() in generate-setting-docs.py and examplesThomas Haller2015-11-111-0/+2
| | | | | | | | | | | | | | gi now emits a warning when not loading a specific library version [1]: ./generate-setting-docs.py:21: PyGIWarning: NM was imported without specifying a version first. Use gi.require_version(NM, 1.0) before import to ensure that the right version gets loaded. from gi.repository import NM, GObject Seems require_version() is reasonably old to just always use it without breaking on older versions [2]. [1] Related: https://bugzilla.gnome.org/show_bug.cgi?id=727379 [2] https://git.gnome.org/browse/pygobject/commit/?id=76758efb6579752237a0dc4d56cf9518de6c6e55
* libnm: remove nm_utils_init() from the public APIDan Winship2014-12-041-2/+0
| | | | | Remove nm_utils_init() from the public API, and just do it as a constructor instead.
* cli, libnm: don't use D-Bus-specific documentation in nmcliDan Winship2014-11-191-2/+6
| | | | | | | Now that nm-setting-docs.xml is more D-Bus-specific, it's less appropriate for nmcli's internal documentation. So generate a second copy of the docs without using the overrides file, and use that one for nmcli's documentation.
* libnm: Override parts of nm-setting-docs.xmlDan Winship2014-11-191-12/+32
| | | | | | | | | | | Add "---dbus---" sections to the NMSetting property docs, in the same style as the plugin docs, parse them out into a file "nm-setting-docs-overrides.xml", and use them to override the GObject property docs in nm-setting-docs.xml. This lets us put more D-Bus-specific information in the setting docs, without cluttering up the property docs, and it also lets us document dbus-only properties.
* libnm: fix nm-setting-docs.xml property typesDan Winship2014-11-191-20/+23
| | | | | | | | | Add nm_setting_get_dbus_property_type(), and use this to get the correct type for properties in nm-seting-docs.xml, in situations where the D-Bus and GObject property types don't match. In the case of enum/flags-valued properties, give both the enum name and the underlying D-Bus type.
* libnm, libnm-util: move settings doc generation to libnm-coreDan Winship2014-11-191-0/+210
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.)
View Lorry Controller Status