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 726460 - Cannot build documentation when NetworkManager is disabled
Cannot build documentation when NetworkManager is disabled
Status: RESOLVED FIXED
Product: gnome-shell
Classification: Core
Component: building
3.11.x
Other FreeBSD
: Normal normal
: ---
Assigned To: gnome-shell-maint
gnome-shell-maint
Depends on:
Blocks:
 
 
Reported: 2014-03-16 16:06 UTC by Ting-Wei Lan
Modified: 2014-05-28 20:08 UTC
See Also:
GNOME target: ---
GNOME version: 3.11/3.12


Attachments
Fix documentation build problem when NetworkManager is disabled (2.14 KB, patch)
2014-03-16 16:06 UTC, Ting-Wei Lan
none Details | Review
[PATCH] build: Remove ShellNetworkAgent documentation (1.53 KB, patch)
2014-04-24 16:05 UTC, Ting-Wei Lan
needs-work Details | Review
[PATCH] build: Remove ShellNetworkAgent documentation (1.44 KB, patch)
2014-04-24 17:31 UTC, Ting-Wei Lan
committed Details | Review

Description Ting-Wei Lan 2014-03-16 16:06:10 UTC
Created attachment 272070 [details] [review]
Fix documentation build problem when NetworkManager is disabled

I got the following error when using --disable-networkmanager --enable-gtk-doc:

gmake[4]: Entering directory `/home/lantw44/gnome/source/gnome-shell/docs/reference/shell'
  DOC   Scanning header files
  DOC   Introspecting gobjects
.libs/shell-scan.o: In function `get_object_types':
/home/lantw44/gnome/source/gnome-shell/docs/reference/shell/shell-scan.c:84: undefined reference to `shell_network_agent_get_type'
Comment 1 Jasper St. Pierre (not reading bugmail) 2014-03-16 18:00:55 UTC
We should probably just remove shell-network-agent from the docs unconditionally.
Comment 2 Ting-Wei Lan 2014-03-17 17:39:54 UTC
(In reply to comment #1)
> We should probably just remove shell-network-agent from the docs
> unconditionally.
Is the reason of removing it unconditionally that NetworkManager is not always available?
Comment 3 Jasper St. Pierre (not reading bugmail) 2014-03-17 17:46:55 UTC
Just because ShellNetworkAgent is an internal implementation detail really, and it's not worth complicating our docs infrastructure for.
Comment 4 Ting-Wei Lan 2014-04-24 16:05:21 UTC
Created attachment 275065 [details] [review]
[PATCH] build: Remove ShellNetworkAgent documentation


It is only an internal implementation detail, and it also causes build problem
when NetworkManager is disabled.

https://bugzilla.gnome.org/show_bug.cgi?id=726460
---
 docs/reference/shell/Makefile.am        | 4 ++++
 docs/reference/shell/shell-docs.sgml.in | 1 -
 2 files changed, 4 insertions(+), 1 deletion(-)
Comment 5 Florian Müllner 2014-04-24 16:15:49 UTC
Review of attachment 275065 [details] [review]:

::: docs/reference/shell/Makefile.am
@@ +75,3 @@
+if !HAVE_NETWORKMANAGER
+IGNORE_HFILES += shell-network-agent.h
+endif

The documentation is unconditionally not built, so the header shouldn't be excluded conditionally.
Comment 6 Ting-Wei Lan 2014-04-24 17:31:47 UTC
Created attachment 275073 [details] [review]
[PATCH] build: Remove ShellNetworkAgent documentation


It is only an internal implementation detail, and it also causes build problem
when NetworkManager is disabled.

https://bugzilla.gnome.org/show_bug.cgi?id=726460
---
 docs/reference/shell/Makefile.am        | 1 +
 docs/reference/shell/shell-docs.sgml.in | 1 -
 2 files changed, 1 insertion(+), 1 deletion(-)
Comment 7 Florian Müllner 2014-04-24 17:35:29 UTC
Review of attachment 275073 [details] [review]:

LGTM