[bug#28509] [PATCH 0/1] gnu: Add GnuCash documentation.

[bug#28509] [PATCH 0/1] gnu: Add GnuCash documentation.

[Chris Marusich]

Hi,

This patch adds some missing documentation for GnuCash.  This is
related to the following email thread:

https://lists.gnu.org/archive/html/guix-devel/2017-09/msg00079.html

I decided to put the approximately 100 megabytes of documentation into
the "doc" output, rather than putting it into the regular "out"
output.  I also decided not to use a separate package, partly because
I wanted to play around with multiple outputs, and partly because I
think it will make it easier for people to find the documentation.

Chris Marusich (1):
  gnu: Add GnuCash documentation.

 gnu/packages/gnucash.scm | 54 ++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 52 insertions(+), 2 deletions(-)

-- 
2.14.1

[bug#28509] [PATCH 1/1] gnu: Add GnuCash documentation.

[Chris Marusich]

* gnu/packages/gnucash.scm (gnucash-docs): Add it.
  (gnucash): Use the glib-or-gtk-build-system, create a "doc" output, and
  install the output of "gnucash-docs" into there.
---
 gnu/packages/gnucash.scm | 54 ++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 52 insertions(+), 2 deletions(-)

diff --git a/gnu/packages/gnucash.scm b/gnu/packages/gnucash.scm
index ac2dce576..45f804fa3 100644
--- a/gnu/packages/gnucash.scm
+++ b/gnu/packages/gnucash.scm
@@ -2,6 +2,7 @@
 ;;; Copyright © 2015, 2016 Ricardo Wurmus <rekado@elephly.net>
 ;;; Copyright © 2015 Eric Bavier <bavier@member.fsf.org>
 ;;; Copyright © 2016 Efraim Flashner <efraim@flashner.co.il>
+;;; Copyright © 2017 Chris Marusich <cmmarusich@gmail.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -23,8 +24,11 @@
   #:use-module (guix packages)
   #:use-module (guix download)
   #:use-module (guix build-system gnu)
+  #:use-module (guix build-system glib-or-gtk)
   #:use-module (gnu packages)
   #:use-module (gnu packages autotools)
+  #:use-module (gnu packages docbook)
+  #:use-module (gnu packages documentation)
   #:use-module (gnu packages gnome)
   #:use-module (gnu packages gnupg)
   #:use-module (gnu packages glib)
@@ -52,7 +56,7 @@
        (base32
         "0g2risryfgplxh6cxpsl7fn255vipgsx38b4l081h665nqwmz5nv"))
       (patches (search-patches "gnucash-price-quotes-perl.patch"))))
-    (build-system gnu-build-system)
+    (build-system glib-or-gtk-build-system)
     (inputs
      `(("guile" ,guile-2.0)
        ("icu4c" ,icu4c)
@@ -69,15 +73,25 @@
     (native-inputs
      `(("glib" ,glib "bin") ; glib-compile-schemas, etc.
        ("intltool" ,intltool)
+       ("gnucash-docs" ,gnucash-docs)
        ("pkg-config" ,pkg-config)))
+    (outputs '("out" "doc"))
     (arguments
      `(#:tests? #f ;FIXME: failing at /qof/gnc-date/qof print date dmy buff
        #:configure-flags '("--disable-dbi"
                            "--enable-aqbanking")
        #:phases
        (modify-phases %standard-phases
+         ;; There are about 100 megabytes of documentation.
+         (add-after
+          'install 'install-docs
+          (lambda* (#:key inputs outputs #:allow-other-keys)
+            (let ((docs (assoc-ref inputs "gnucash-docs"))
+                  (doc-output (assoc-ref outputs "doc")))
+              (symlink (string-append docs "/share/gnome")
+                       (string-append doc-output "/share/gnome")))))
          (add-after
-          'install 'wrap-programs
+          'install-docs 'wrap-programs
           (lambda* (#:key inputs outputs #:allow-other-keys)
             (for-each (lambda (prog)
                         (wrap-program (string-append (assoc-ref outputs "out")
@@ -114,6 +128,42 @@ import and transaction matching.  It also automates several tasks, such as
 financial calculations or scheduled transactions.")
     (license license:gpl3+)))
 
+;; This package is not public, since we use it to build the "doc" output of
+;; the gnucash package (see above).  It would be confusing if it were public.
+(define gnucash-docs
+  (package
+    (name "gnucash-docs")
+    (version (package-version gnucash))
+    (source
+     (origin
+       (method url-fetch)
+       (uri (string-append "mirror://sourceforge/gnucash/gnucash-docs/"
+                           version "/gnucash-docs-" version ".tar.gz"))
+       (sha256
+        (base32
+         "0dfb4m4084apav9kjsc4mfbj99xsyxm59qhpm1nxvhybn5h6qr3r"))))
+    (build-system gnu-build-system)
+    ;; These are native-inputs because they are only required for building the
+    ;; documentation.
+    (native-inputs
+     `(("libxml2" ,libxml2)
+       ;; The "check" target needs the docbook xml packages for validating the
+       ;; DocBook XML during the tests.
+       ("docbook-xml-4.4" ,docbook-xml-4.4)
+       ("docbook-xml-4.2" ,docbook-xml-4.2)
+       ("docbook-xml-4.1.2" ,docbook-xml-4.1.2)
+       ("libxslt" ,libxslt)
+       ("docbook-xsl" ,docbook-xsl)
+       ("scrollkeeper" ,scrollkeeper)))
+    (home-page "http://www.gnucash.org/")
+    (synopsis "Documentation for GnuCash")
+    (description
+     "User guide and other documentation for GnuCash in various languages.
+This package exists because the GnuCash project maintains its documentation in
+an entirely separate package from the actual GnuCash program.  It is intended
+to be read using the GNOME Yelp program.")
+    (license (list license:fdl1.1+ license:gpl3+))))
+
 (define-public gwenhywfar
   (package
     (name "gwenhywfar")
-- 
2.14.1

[bug#28509] [PATCH 1/1] gnu: Add GnuCash documentation.

[Ludovic Courtès]

Chris Marusich <cmmarusich@gmail.com> skribis:

> * gnu/packages/gnucash.scm (gnucash-docs): Add it.
>   (gnucash): Use the glib-or-gtk-build-system, create a "doc" output, and
>   install the output of "gnucash-docs" into there.

LGTM, thanks for working on it!

Ludo'.

[bug#28509] [PATCH 1/1] gnu: Add GnuCash documentation.

[Ludovic Courtès]

ludo@gnu.org (Ludovic Courtès) skribis:

> Chris Marusich <cmmarusich@gmail.com> skribis:
>
>> * gnu/packages/gnucash.scm (gnucash-docs): Add it.
>>   (gnucash): Use the glib-or-gtk-build-system, create a "doc" output, and
>>   install the output of "gnucash-docs" into there.
>
> LGTM, thanks for working on it!

Ping!  :-)

Ludo'.

[bug#28509] [PATCH 1/1] gnu: Add GnuCash documentation.

[Chris Marusich]

[-- Attachment #1: Type: text/plain, Size: 716 bytes --]

ludo@gnu.org (Ludovic Courtès) writes:

> ludo@gnu.org (Ludovic Courtès) skribis:
>
>> Chris Marusich <cmmarusich@gmail.com> skribis:
>>
>>> * gnu/packages/gnucash.scm (gnucash-docs): Add it.
>>>   (gnucash): Use the glib-or-gtk-build-system, create a "doc" output, and
>>>   install the output of "gnucash-docs" into there.
>>
>> LGTM, thanks for working on it!
>
> Ping!  :-)
>
> Ludo'.

I'm waiting for someone with commit access to commit this.  I don't have
commit access.  Would it be faster now and in the future if I just got
commit access?  I don't intend to commit anything without first
reviewing it with the list - but I don't mind either way, so please let
me know.

-- 
Chris

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

[bug#28509] [PATCH 1/1] gnu: Add GnuCash documentation.

[Ludovic Courtès]

Hi Chris,

Chris Marusich <cmmarusich@gmail.com> skribis:

> ludo@gnu.org (Ludovic Courtès) writes:
>
>> ludo@gnu.org (Ludovic Courtès) skribis:
>>
>>> Chris Marusich <cmmarusich@gmail.com> skribis:
>>>
>>>> * gnu/packages/gnucash.scm (gnucash-docs): Add it.
>>>>   (gnucash): Use the glib-or-gtk-build-system, create a "doc" output, and
>>>>   install the output of "gnucash-docs" into there.
>>>
>>> LGTM, thanks for working on it!
>>
>> Ping!  :-)
>>
>> Ludo'.
>
> I'm waiting for someone with commit access to commit this.  I don't have
> commit access.  Would it be faster now and in the future if I just got
> commit access?  I don't intend to commit anything without first
> reviewing it with the list - but I don't mind either way, so please let
> me know.

Oops, I was pretty sure you already had commit access, apologies!

So, let’s fix that.  Can you create an account on savannah.gnu.org, and
email it here?  Please add the OpenPGP key that you’ll use to sign
commits to your account info, and reply with a message signed with that
key.

TIA!

Ludo’.

[bug#28509] [PATCH 1/1] gnu: Add GnuCash documentation.

[Chris Marusich]

[-- Attachment #1: Type: text/plain, Size: 547 bytes --]

ludo@gnu.org (Ludovic Courtès) writes:

> Can you create an account on savannah.gnu.org, and email it here?
> Please add the OpenPGP key that you’ll use to sign commits to your
> account info, and reply with a message signed with that key.

I've created an account and uploaded the key.  The info is here:

  Profile: https://savannah.gnu.org/users/marusich
  Key fingerprint: CBF5 9755 CBE7 E7EF EF18  3FB1 DD40 9A15 D822 469D

I'll try committing the change once you let me know I've been given
access.  Thank you!

-- 
Chris

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

[bug#28509] [PATCH 1/1] gnu: Add GnuCash documentation.

[Ludovic Courtès]

[-- Attachment #1: Type: text/plain, Size: 784 bytes --]

Hi Chris,

Chris Marusich <cmmarusich@gmail.com> skribis:

> ludo@gnu.org (Ludovic Courtès) writes:
>
>> Can you create an account on savannah.gnu.org, and email it here?
>> Please add the OpenPGP key that you’ll use to sign commits to your
>> account info, and reply with a message signed with that key.
>
> I've created an account and uploaded the key.  The info is here:
>
>   Profile: https://savannah.gnu.org/users/marusich
>   Key fingerprint: CBF5 9755 CBE7 E7EF EF18  3FB1 DD40 9A15 D822 469D
>
> I'll try committing the change once you let me know I've been given
> access.  Thank you!

I’ve added you so you should be able to commit now.

Please (re)read ‘HACKING’ for rules and tips regarding commit access.

Welcome again!  :-)

Ludo’.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

bug#28509: [PATCH 1/1] gnu: Add GnuCash documentation.

[Christopher Baines]

[-- Attachment #1: Type: text/plain, Size: 765 bytes --]

On Wed, 11 Oct 2017 20:07:07 -0700
Chris Marusich <cmmarusich@gmail.com> wrote:

> ludo@gnu.org (Ludovic Courtès) writes:
> 
> > Can you create an account on savannah.gnu.org, and email it here?
> > Please add the OpenPGP key that you’ll use to sign commits to your
> > account info, and reply with a message signed with that key.  
> 
> I've created an account and uploaded the key.  The info is here:
> 
>   Profile: https://savannah.gnu.org/users/marusich
>   Key fingerprint: CBF5 9755 CBE7 E7EF EF18  3FB1 DD40 9A15 D822 469D
> 
> I'll try committing the change once you let me know I've been given
> access.  Thank you!

Looks to me like you've been successful :D So I'm going to close this
bug (by emailing 28509-done@debbugs.gnu.org).

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 963 bytes --]