Bug 552170 – sys-auth/polkit add USE=doc

• Status: RESOLVED FIXED
• Product: Gentoo Linux

[Description Eric Koegel 2015-06-15 06:43:40 UTC]

While debugging an issue between a component I was working on and polkit I needed to reference the polkit API docs but they weren't installed. I copied the current polkit ebuild into my overlay and added the doc keyword to fix that issue. Just sharing it here for hopeful inclusion.

Reproducible: Always

Steps to Reproduce:
1. Install devhelp + polkit
2. Open devhelp
3. Notice there's no section for polkit

[Comment 1 Eric Koegel 2015-06-15 06:45:37 UTC]

Created attachment 405174 [details, diff]
polkit-0.112-r3.ebuild with doc keyword

This is the ebuild I created with the "doc" keyword added.

[Comment 2 Eric Koegel 2015-06-15 06:48:29 UTC]

Created attachment 405176 [details, diff]
ebuild.diff

This is the diff between both ebuilds.

[Comment 3 Gilles Dartiguelongue (RETIRED) 2015-06-17 07:12:29 UTC]

The use flag would control the rebuild of the API docs, not whether they are installed or not. At least not with intended gtk-doc behavior. Also, the ebuild is missing a dependency on gtk-doc-am for relinking to locally available docs.

[Comment 4 Eric Koegel 2015-06-17 14:08:02 UTC]

Created attachment 405284 [details, diff]
polkit-0.112-r3.ebuild with doc keyword

(In reply to Gilles Dartiguelongue from comment #3)
> The use flag would control the rebuild of the API docs, not whether they are
> installed or not. At least not with intended gtk-doc behavior. Also, the
> ebuild is missing a dependency on gtk-doc-am for relinking to locally
> available docs.

I tested installing with the doc and -doc keyword to ensure the docs were/were not installed as intended so I'm not entirely sure what I'm doing wrong.

I added the gtk-doc-am requirement to the doc keyword part of this new patch. The addition is:

-	virtual/pkgconfig"
+	virtual/pkgconfig
+	doc? ( >=dev-util/gtk-doc-1.4
+              >=dev-util/gtk-doc-am-1.21 )"

Is that the correct approach?

[Comment 5 Gilles Dartiguelongue (RETIRED) 2015-12-17 14:16:58 UTC]

Finally got around to checking what was up here. It appears that polkit upstream found it funny to tweak gtk-doc behavior. I'll push a fix tonight.

Adding:

    # Drop upstream hack around standard gtk-doc behavior
    sed -i -e 's/@ENABLE_GTK_DOC_TRUE@//' -i docs/polkit/Makefile.in || die

to src_prepare fixes the problem. I'll see if I can gather some other fixes before bumping and pushing it in tree.

[Comment 6 Gilles Dartiguelongue (RETIRED) 2016-01-02 10:31:56 UTC]

commit 9507e28056579dbb7ada3176e719f68da606487f
Date:   Sat Jan 2 11:30:00 2016 +0100

    sys-auth/polkit: fix gtk-doc installation, bug #552170, add gettext to DEPEND, bug #555004

Thanks for reporting.

[Comment 7 Timo Rothenpieler 2016-01-02 19:27:06 UTC]

This breaks compilation if gtk-doc is not installed, as it now tries to call gtkdoc-scan when making all in /var/tmp/portage/sys-auth/polkit-0.113-r1/work/polkit-0.113/docs/polkit