GNU bug report logs - #33327
[PATCH 1/2] gnu: gtk-doc: Use local docbook-xsl.

Previous Next

Package: guix-patches;

Reported by: Pierre Neidhardt <mail <at> ambrevar.xyz>

Date: Fri, 9 Nov 2018 18:21:01 UTC

Severity: normal

Tags: fixed, patch

Done: Pierre Neidhardt <mail <at> ambrevar.xyz>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 33327 in the body.
You can then email your comments to 33327 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to guix-patches <at> gnu.org:
bug#33327; Package guix-patches. (Fri, 09 Nov 2018 18:21:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Pierre Neidhardt <mail <at> ambrevar.xyz>:
New bug report received and forwarded. Copy sent to guix-patches <at> gnu.org. (Fri, 09 Nov 2018 18:21:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Pierre Neidhardt <mail <at> ambrevar.xyz>
To: guix-patches <at> gnu.org
Subject: [PATCH 1/2] gnu: gtk-doc: Use local docbook-xsl.
Date: Fri,  9 Nov 2018 19:20:13 +0100
* gnu/packages/gtk.scm (gtk-doc): Use local docbook-xsl.
---
 gnu/packages/gtk.scm | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/gtk.scm b/gnu/packages/gtk.scm
index 640bd75da..0d62b8083 100644
--- a/gnu/packages/gtk.scm
+++ b/gnu/packages/gtk.scm
@@ -19,6 +19,7 @@
 ;;; Copyright © 2017 Marius Bakke <mbakke <at> fastmail.com>
 ;;; Copyright © 2018 Alex Vong <alexvong1995 <at> gmail.com>
 ;;; Copyright © 2018 Arun Isaac <arunisaac <at> systemreboot.net>
+;;; Copyright © 2018 Pierre Neidhardt <mail <at> ambrevar.xyz>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -1411,7 +1412,12 @@ information.")
                (string-append (assoc-ref inputs "docbook-xsl")
                               "/xml/xsl/docbook-xsl-"
                               ,(package-version docbook-xsl)
-                              "/html/chunk.xsl")))
+                              "/html/chunk.xsl"))
+              (("http://docbook.sourceforge.net/release/xsl/current/common/en.xml")
+               (string-append (assoc-ref inputs "docbook-xsl")
+                              "/xml/xsl/docbook-xsl-"
+                              ,(package-version docbook-xsl)
+                              "/common/en.xml")))
              #t))
          (add-after 'patch-gtk-doc-scan 'patch-test-out
            (lambda _
-- 
2.19.1





Information forwarded to guix-patches <at> gnu.org:
bug#33327; Package guix-patches. (Fri, 09 Nov 2018 18:25:01 GMT) Full text and rfc822 format available.

Message #8 received at 33327 <at> debbugs.gnu.org (full text, mbox):

From: Pierre Neidhardt <mail <at> ambrevar.xyz>
To: 33327 <at> debbugs.gnu.org
Subject: [PATCH 2/2] gnu: webkitgtk: Include documentation.
Date: Fri,  9 Nov 2018 19:24:43 +0100
* gnu/packages/webkit.scm (webkitgtk): Include documentation.
---
 gnu/packages/webkit.scm | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/webkit.scm b/gnu/packages/webkit.scm
index d1890c8b3..b4560c0e4 100644
--- a/gnu/packages/webkit.scm
+++ b/gnu/packages/webkit.scm
@@ -4,6 +4,7 @@
 ;;; Copyright © 2015 Ricardo Wurmus <rekado <at> elephly.net>
 ;;; Copyright © 2015, 2016, 2017, 2018 Mark H Weaver <mhw <at> netris.org>
 ;;; Copyright © 2018 Tobias Geerinckx-Rice <me <at> tobias.gr>
+;;; Copyright © 2018 Pierre Neidhardt <mail <at> ambrevar.xyz>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -31,6 +32,7 @@
   #:use-module (gnu packages base)
   #:use-module (gnu packages bison)
   #:use-module (gnu packages databases)
+  #:use-module (gnu packages docbook)
   #:use-module (gnu packages enchant)
   #:use-module (gnu packages flex)
   #:use-module (gnu packages gcc)
@@ -71,6 +73,7 @@
        #:build-type "Release" ; turn off debugging symbols to save space
        #:configure-flags (list
                           "-DPORT=GTK"
+                          "-DENABLE_GTKDOC=ON" ; No doc by default
                           (string-append ; uses lib64 by default
                            "-DLIB_INSTALL_DIR="
                            (assoc-ref %outputs "out") "/lib")
@@ -87,7 +90,20 @@
                           ;; XXX Disable WOFF2 ‘web fonts’.  These were never
                           ;; supported in our previous builds.  Enabling them
                           ;; requires building libwoff2 and possibly woff2dec.
-                          "-DUSE_WOFF2=OFF")))
+                          "-DUSE_WOFF2=OFF")
+       #:phases
+       (modify-phases %standard-phases
+         (add-after 'unpack 'patch-gtk-doc-scan
+           (lambda* (#:key inputs #:allow-other-keys)
+             (substitute* "Source/WebKit/WebProcess/InjectedBundle/API/gtk/DOM/docs/webkitdomgtk-docs.sgml"
+              (("http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd")
+               (string-append (assoc-ref inputs "docbook-xml")
+                              "/xml/dtd/docbook/docbookx.dtd")))
+             (substitute* "Source/WebKit/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml"
+              (("http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd")
+               (string-append (assoc-ref inputs "docbook-xml")
+                              "/xml/dtd/docbook/docbookx.dtd")))
+             #t)))))
     (native-inputs
      `(("bison" ,bison)
        ("gettext" ,gettext-minimal)
@@ -97,6 +113,8 @@
        ("perl" ,perl)
        ("pkg-config" ,pkg-config)
        ("python" ,python-2) ; incompatible with Python 3 (print syntax)
+       ("gtk-doc" ,gtk-doc) ; For documentation generation
+       ("docbook-xml" ,docbook-xml) ; For documentation generation
        ("ruby" ,ruby)))
     (propagated-inputs
      `(("gtk+" ,gtk+)
-- 
2.19.1





Information forwarded to guix-patches <at> gnu.org:
bug#33327; Package guix-patches. (Sat, 10 Nov 2018 22:28:01 GMT) Full text and rfc822 format available.

Message #11 received at 33327 <at> debbugs.gnu.org (full text, mbox):

From: ludo <at> gnu.org (Ludovic Courtès)
To: Pierre Neidhardt <mail <at> ambrevar.xyz>
Cc: 33327 <at> debbugs.gnu.org
Subject: Re: [bug#33327] [PATCH 1/2] gnu: gtk-doc: Use local docbook-xsl.
Date: Sat, 10 Nov 2018 23:27:00 +0100
Hi,

Pierre Neidhardt <mail <at> ambrevar.xyz> skribis:

> * gnu/packages/gtk.scm (gtk-doc): Use local docbook-xsl.

This is so that users of gtk-doc don’t need to specify where docbook-xsl
is to be searched for, right?

Ludo’.




Information forwarded to guix-patches <at> gnu.org:
bug#33327; Package guix-patches. (Sat, 10 Nov 2018 22:28:02 GMT) Full text and rfc822 format available.

Message #14 received at 33327 <at> debbugs.gnu.org (full text, mbox):

From: ludo <at> gnu.org (Ludovic Courtès)
To: Pierre Neidhardt <mail <at> ambrevar.xyz>
Cc: 33327 <at> debbugs.gnu.org
Subject: Re: [bug#33327] [PATCH 2/2] gnu: webkitgtk: Include documentation.
Date: Sat, 10 Nov 2018 23:27:44 +0100
Pierre Neidhardt <mail <at> ambrevar.xyz> skribis:

> * gnu/packages/webkit.scm (webkitgtk): Include documentation.

Since generated HTML documentation tends to take a lot of space, what
about moving it to a “doc” output?

Otherwise LGTM.

Thanks,
Ludo’.




Information forwarded to guix-patches <at> gnu.org:
bug#33327; Package guix-patches. (Sun, 11 Nov 2018 10:55:02 GMT) Full text and rfc822 format available.

Message #17 received at 33327 <at> debbugs.gnu.org (full text, mbox):

From: Pierre Neidhardt <mail <at> ambrevar.xyz>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: 33327 <at> debbugs.gnu.org
Subject: Re: [bug#33327] [PATCH 2/2] gnu: webkitgtk: Include documentation.
Date: Sun, 11 Nov 2018 11:54:13 +0100
[Message part 1 (text/plain, inline)]
> This is so that users of gtk-doc don’t need to specify where docbook-xsl
> is to be searched for, right?

On the user-side, I don't know, but without this thee doc of WebKitGTK would
fail to build, so this is necessary on the builder side.

> Since generated HTML documentation tends to take a lot of space, what
> about moving it to a “doc” output?

Documentation is <7MB, <5% of the total package size, so I didn't bother
creating a separate output.
What do you think?

-- 
Pierre Neidhardt
https://ambrevar.xyz/
[signature.asc (application/pgp-signature, inline)]

Information forwarded to guix-patches <at> gnu.org:
bug#33327; Package guix-patches. (Sun, 11 Nov 2018 11:36:02 GMT) Full text and rfc822 format available.

Message #20 received at 33327 <at> debbugs.gnu.org (full text, mbox):

From: ludo <at> gnu.org (Ludovic Courtès)
To: Pierre Neidhardt <mail <at> ambrevar.xyz>
Cc: 33327 <at> debbugs.gnu.org
Subject: Re: [bug#33327] [PATCH 2/2] gnu: webkitgtk: Include documentation.
Date: Sun, 11 Nov 2018 12:35:05 +0100
Pierre Neidhardt <mail <at> ambrevar.xyz> skribis:

>> This is so that users of gtk-doc don’t need to specify where docbook-xsl
>> is to be searched for, right?
>
> On the user-side, I don't know, but without this thee doc of WebKitGTK would
> fail to build, so this is necessary on the builder side.

But other packages that use gtk-doc don’t have this problem, right?  Any
idea what’s different?

>> Since generated HTML documentation tends to take a lot of space, what
>> about moving it to a “doc” output?
>
> Documentation is <7MB, <5% of the total package size, so I didn't bother
> creating a separate output.
> What do you think?

I have a preference for a separate “doc” output nonetheless, if it’s not
too difficult to achieve.

Thanks for your feedback,
Ludo’.




Information forwarded to guix-patches <at> gnu.org:
bug#33327; Package guix-patches. (Sun, 11 Nov 2018 15:08:02 GMT) Full text and rfc822 format available.

Message #23 received at 33327 <at> debbugs.gnu.org (full text, mbox):

From: Pierre Neidhardt <mail <at> ambrevar.xyz>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: 33327 <at> debbugs.gnu.org
Subject: Re: [bug#33327] [PATCH 2/2] gnu: webkitgtk: Include documentation.
Date: Sun, 11 Nov 2018 16:06:57 +0100
[Message part 1 (text/plain, inline)]
> But other packages that use gtk-doc don’t have this problem, right?  Any
> idea what’s different?

I assume it's because WebKitGTK documentation uses some option of gtkdoc that
other packages don't use.

> I have a preference for a separate “doc” output nonetheless, if it’s not
> too difficult to achieve.

OK, I'll them and merge then.

-- 
Pierre Neidhardt
https://ambrevar.xyz/
[signature.asc (application/pgp-signature, inline)]

Added tag(s) fixed. Request was from Pierre Neidhardt <mail <at> ambrevar.xyz> to control <at> debbugs.gnu.org. (Mon, 12 Nov 2018 09:22:01 GMT) Full text and rfc822 format available.

bug closed, send any further explanations to 33327 <at> debbugs.gnu.org and Pierre Neidhardt <mail <at> ambrevar.xyz> Request was from Pierre Neidhardt <mail <at> ambrevar.xyz> to control <at> debbugs.gnu.org. (Mon, 12 Nov 2018 09:22:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Mon, 10 Dec 2018 12:24:05 GMT) Full text and rfc822 format available.

This bug report was last modified 5 years and 110 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.