[OE-core] Why is "bitbake core-image-minimal" building gtk docs?

[Jack Mitchell]

On 21/08/13 08:55, Laszlo Papp wrote:
> Ping?
> 
> 
> On Fri, Aug 16, 2013 at 1:15 PM, Jack Mitchell <ml at communistcode.co.uk
> <mailto:ml at communistcode.co.uk>> wrote:
> 
>     On 16/08/13 12:40, Laszlo Papp wrote:
>     > Hi,
>     >
>     > alternatively: is there an option to turn gtk, especially the docs
>     off?
>     >
>     > Cheers,
>     > Laszlo
>     >
>     >
> 
>     I don't know how to properly stop it building, or turn it off but I can
>     tell you the cause.
> 
>     Running bitbake -g core-image-minimal outputs the dependency graphs, and
>     by examining that it seems as though the following packages pull in
>     gtk-doc related packages.
> 
>     "connman" -> "gtk-doc-stub-native"
>     "kmod-native" -> "gtk-doc-stub-native"
>     "kmod" -> "gtk-doc-stub-native"
>     "glib-2.0" -> "gtk-doc-stub-native"
>     "glib-2.0-native" -> "gtk-doc-stub-native"
> 
>     Now, all these packages are gtk-doc-stub[-native], which is
>     described as:
> 
>     DESCRIPTION = "Stub implementation of gtk-doc, as we don't want to build
>     the API documentation"
> 
>     So it sounds like gtk-docs aren't actually being built, but the stubs
>     provide enough to make the package think they're being built...
> 
>     That's all I know, someone with more gtk knowledge than me can probably
>     fill in the reason for why it's required to build those packages.
> 
>     Cheers,
> 

Having a quick look around it seems as though glib can be built with
docs disabled:

--disable-gtk-doc and --enable-gtk-doc.  By default the configure script
will try to auto-detect whether the gtk-doc package is installed. If it
is, then it will use it to extract and build the documentation for the
GLib library. These options can be used to explicitly control whether
gtk-doc should be used or not. If it is not used, the distributed,
pre-generated HTML files will be installed instead of building them on
your machine.

the glib-2.0 recipe inherits gtk-doc, but doesn't disable it anywhere. I
imagine that you could add --disable-gtk-doc and remove the gtk-doc
inherit to stop glib-2.0 requiring the stub.

It seems here: http://patches.openembedded.org/patch/32567/

gtk-doc was specifically added back into the connman build.

kmod also has a --disable-gtk-doc configure option.

Here is the patch which kicks it all off:

http://lists.linuxtogo.org/pipermail/openembedded-core/2012-July/026077.html

So, make of this what you will. I've cc'd Ross in to see if he has a
specific reason for re-enabling gkt-doc in some packages. Maybe we
should turn it into an image feature...?

Regardless of all this though, it seems the packages will ship with docs
anyway, just pre-built HTML ones, so is it worth it?

-- 
  Jack Mitchell (jack at embed.me.uk)
  Embedded Systems Engineer
  Cambrideshire, UK
  http://www.embed.me.uk
--