summaryrefslogtreecommitdiff
path: root/docs/api
Commit message (Collapse)AuthorAgeFilesLines
* man: add OpenVSwitch overviewlr/ovsLubomir Rintel2017-10-302-0/+2
|
* 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.
* docs: update yearsLubomir Rintel2017-03-021-0/+1
|
* docs: add missing links to dummy and macsec device/settingBeniamino Galvani2017-02-232-0/+2
| | | | | 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
* 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.
* docs: add device statistics interfaceAlfonso Sanchez-Beato2016-08-172-0/+2
|
* 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
|
* 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-263-481/+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.
* wimax: drop WiMAX support (bgo #747846)Dan Winship2015-04-171-1/+1
| | | | | | | | | | | | | | | | | | | | 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-031-0/+1
| | | | | | | | | | | 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>
* 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
* build: fix nm-setting-docs build in various configurationsDan Winship2014-06-272-8/+24
| | | | | | | Certain build configurations (like --enable-gtk-doc --disable-introspection) were broken with respect to nm-setting-docs. Fix this. Also, we don't require just gobject-introspection, we need pygobject specifically as well.
* docs: generate settings-spec.xml from libnm-util/nm-setting-docs.xmlDan Winship2014-06-192-6/+58
| | | | | Generate docs/api/settings-spec.xml via an XSLT stylesheet applied to libnm-util/nm-setting-docs.xml.
* build: fix builddir != srcdir when building D-Bus API spec HTMLDan Williams2013-08-291-2/+2
|
* build: always generate docs at dist time (bgo #700093)Dan Williams2013-05-141-19/+12
| | | | | | | | | | dist tarballs shouldn't ever be released without the documentation, and this allows us to build the tarballs with pre-generated docs that get installed on the end system, but don't need to be built there. So the end system doesn't need gtk-doc installed, only the dist system does. https://bugzilla.gnome.org/show_bug.cgi?id=700093
* build: fix build with --enable-doc (docs/api/Makefile.am)Jiří Klimeš2013-02-121-0/+3
| | | | | | | | | | | | | "./autogen.sh --enable-doc && make" produced this error: warning: failed to load external entity "../settings-spec.xml" ../network-manager-docs.xml:57: element include: XInclude error : could not load ../settings-spec.xml, and no fallback was found Removing settings-spec.xml from $(content_files) made the file non-DISTed but it also removed the file as a dependency for html-build.stamp that also runs cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) and $(DOC_MAIN_SGML_FILE) includes settings-spec.xml. Fix that by making $(DOC_MAIN_SGML_FILE) dependent on setting-spec.xml.
* build: fix distcheck when building settings specification XMLDan Williams2013-02-051-4/+4
| | | | | | | | | | | | | | The generated settings-spec.xml should not be DIST-ed because it's regenerated every time libnm-util changes. That meants it gets rebuilt during 'make' even from a dist tarball. Thus, it shouldn't be part of the dist tarball itself. In addition, settings-spec.html shouldn't be included in $(content_files) becuase this is added to EXTRA_DIST by gtk-doc.make. Since generate-settings-spec.c the move from docs/api/ to tools/, this started breaking distcheck even though the original Makefile rules were wrong too.
* tools: move generate-settings-spec to toolsJiří Klimeš2013-02-052-460/+3
|
* docs: generate refentry xml in addition to Docbook book xml for settings-specJiří Klimeš2013-02-052-29/+223
| | | | | | | | The refentry xml is used to generate manual page with settings description. The invocation is: generate-settings-spec <type> <output file> [<type> <output file>] where <type> is "book" or "refentry"
* docs: add ADSL setting to API specsJiří Klimeš2013-01-151-1/+3
|
* libnm-util: add NMSettingBridgePortDan Williams2012-11-301-0/+2
|
* libnm-util: add NMSettingBridgeDan Williams2012-11-301-0/+2
|
* build: clean all files on 'make distclean'Pavel Šimerda2012-11-131-1/+3
|
* build: fix more srcdir != builddir issuesPavel Šimerda2012-11-131-1/+2
|
* build: fix srcdir != builddir issueDan Williams2012-11-131-0/+1
|
* build: improve documentation and test configure optionsPavel Šimerda2012-11-131-3/+1
| | | | | | | | Use --enable-doc and --enable-tests instead of --with-docs and --with-tests. This is consistent with other features and with --enable-gtk-doc option. Support current variants as fallback. Don't build tests unless --enable-tests is specified.
* docs: auto-version documentation and fix up copyright and authorshipDan Williams2012-08-061-20/+1
|
* docs: update FSF address in license headersJiří Klimeš2012-07-261-2/+2
|
* doc: fix build with build with gtk-doc < 1.15Robert Shade2012-07-021-0/+2
| | | | gtk-doc < 1.15 does not handle a missing DOC_SOURCE_DIR
View Lorry Controller Status