After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 740224 - fix up NMSetting-property-related man pages and docs [danw/setting-docs-...]
fix up NMSetting-property-related man pages and docs [danw/setting-docs-...]
Status: RESOLVED FIXED
Product: NetworkManager
Classification: Platform
Component: Documentation
git master
Other Linux
: Normal normal
: ---
Assigned To: NetworkManager maintainer(s)
NetworkManager maintainer(s)
Depends on:
Blocks: nm-1.0
 
 
Reported: 2014-11-16 22:22 UTC by Dan Winship
Modified: 2014-11-19 14:25 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Dan Winship 2014-11-16 22:22:23 UTC 
The danw/settings-docs-bgoXXXXXX branch fixes a few docs-related issues:

  - we were still building docs from libnm-util rather than libnm-core,
    so they weren't keeping up to date with new properties

  - the libnm-core NMSetting properties don't always map as closely to the
    D-Bus properties as the libnm-util ones do, so a trivial switch from
    libnm-util to libnm-core would break the docs

  - we had no way of documenting D-Bus properties that did not correspond
    to GObject properties (eg, address-data).

(Note that the docs generation actually gets moved from libnm-util to libnm/, not libnm-core/, because generate-setting-docs.py needs the gir file.)
Comment 1 Dan Williams 2014-11-17 16:11:44 UTC 
Looks good to me.
Comment 2 Jiri Klimes 2014-11-19 09:48:55 UTC 
I have pushed a few fixes/additions to danw/setting-docs-bgo740224.
Apart from them the branch looks good to me.

(I had a problem building on an old Fedora 17 installation, because it somehow didn't want to respect GI_TYPELIB_PATH and LD_LIBRARY_PATH when building the docs, and used system-wide libnm. However, all went fine on Fedora 20.)
Comment 3 Dan Winship 2014-11-19 14:25:55 UTC 
pushed with your additional fixes