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 742139 - incomplete libnm-util documentation built when compiled out of tree
incomplete libnm-util documentation built when compiled out of tree
Status: RESOLVED FIXED
Product: NetworkManager
Classification: Platform
Component: Documentation
git master
Other All
: Normal minor
: ---
Assigned To: NetworkManager maintainer(s)
NetworkManager maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2014-12-31 04:51 UTC by You-Sheng Yang [:vicamo]
Modified: 2015-01-12 15:51 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
proposed patch (1.98 KB, patch)
2014-12-31 04:57 UTC, You-Sheng Yang [:vicamo] 		none Details | Review

Description You-Sheng Yang [:vicamo] 2014-12-31 04:51:06 UTC 
When compiling NetworkManager outside the source tree with gtk-doc enabled, the generated documents differ from the ones generated when compiled in tree. The different pages are:

 * NetworkManager/license.html:

   GPLv2 terms replaced by "FIXME: MISSING XINCLUDE CONTENT".

 * libnm-util/*.html:

   All enumeration and flag types are missing.

After some investigation, there are two corresponding bugs in the Makefile.am files.

 * docs/api/Makefile.am:

   Missing an entry to "content_files" so $(top_srcdir)/COPYING is not available in $(top_builddir)

 * docs/libnm-util/Makefile.am:

   $(top_srcdir)/libnm-util generates nm-utils-enum-types.h and nm-utils-enum-types.c and place them in $(top_builddir). When compiled out of tree, these files are invisible to gtk-doc because DOC_SOURCE_DIR has only $(top_srcdir)/libnm-util.
Comment 1 You-Sheng Yang [:vicamo] 2014-12-31 04:57:32 UTC 
Created attachment 293509 [details] [review]
proposed patch
Comment 2 Lubomir Rintel 2015-01-02 19:36:59 UTC 
Looks good to me.
Comment 4 You-Sheng Yang [:vicamo] 2015-01-04 06:47:02 UTC 
Thank you ;)