Subject: bug#42189: closed (Re: [bug#42189] [PATCH] gnu: Add kicad-doc.)

From: [email-masked] (GNU bug Tracking System)
Date: Fri, 18 Dec 2020 15:06:01 +0000

Your bug report

#42189: [PATCH] gnu: Add kicad-doc.

which was filed against the guix-patches package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
42189: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=42189
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: [bug#42189] [PATCH] gnu: Add kicad-doc.
From: Ludovic Courtès <[email-masked]>
To: Brice Waegeneire <[email-masked]>
Cc: [email-masked], [email-masked]
Date: Fri, 18 Dec 2020 16:04:43 +0100
List-Id: <debbugs-submit.debbugs.gnu.org>

Hi Brice,

Brice Waegeneire <[email-masked]> skribis:

> * gnu/packages/engineering.scm (kicad-doc): New variable.
> (kicad)[native-search-paths]: Add 'KICAD'.

Finally applied on your behalf, thanks!

Ludo’.

Subject: [PATCH] gnu: Add kicad-doc.
From: Brice Waegeneire <[email-masked]>
To: [email-masked]
Cc: [email-masked]
Date: Sat, 4 Jul 2020 18:01:24 +0200
List-Id: <debbugs-submit.debbugs.gnu.org>

* gnu/packages/engineering.scm (kicad-doc): New variable.
(kicad)[native-search-paths]: Add 'KICAD'.
---

The environment variable 'KICAD' is set to the the root of the profile because
there isn't a specific variable to set the documentation path.  This
environment variable isn't documented tho it is explicitly used in the code.

[1]: https://gitlab.com/kicad/code/kicad/-/blob/f3f17401dc393e558000616d1b0da229299ec278/common/searchhelpfilefullpath.cpp#L122-124

 gnu/packages/engineering.scm | 46 +++++++++++++++++++++++++++++++++++-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/engineering.scm b/gnu/packages/engineering.scm
index f2d32e663f..fb8ffc8263 100644
--- a/gnu/packages/engineering.scm
+++ b/gnu/packages/engineering.scm
@@ -65,6 +65,7 @@
   #:use-module (gnu packages curl)
   #:use-module (gnu packages dejagnu)
   #:use-module (gnu packages digest)
+  #:use-module (gnu packages docbook)
   #:use-module (gnu packages documentation)
   #:use-module (gnu packages flex)
   #:use-module (gnu packages fontutils)
@@ -95,6 +96,7 @@
   #:use-module (gnu packages multiprecision)
   #:use-module (gnu packages mpi)
   #:use-module (gnu packages ncurses)
+  #:use-module (gnu packages pretty-print)
   #:use-module (gnu packages perl)
   #:use-module (gnu packages pkg-config)
   #:use-module (gnu packages python)
@@ -805,7 +807,6 @@ language.")
       (license (list license:mpl2.0               ;library
                      license:gpl2+)))))           ;Guile bindings and GUI
 
-;; TODO Add doc https://gitlab.com/kicad/services/kicad-doc/-/tree/master
 (define-public kicad
   (package
     (name "kicad")
@@ -855,6 +856,9 @@ language.")
              #t)))))
     (native-search-paths
      (list (search-path-specification
+            (variable "KICAD")          ; to find kicad-doc
+            (files '("")))
+           (search-path-specification
             (variable "KICAD_TEMPLATE_DIR")
             (files '("share/kicad/template")))
            (search-path-specification
@@ -926,6 +930,46 @@ translations for KiCad.")
 (define-public kicad-i18l
   (deprecated-package "kicad-i18l" kicad-i18n))
 
+(define-public kicad-doc
+  (package
+    (name "kicad-doc")
+    (version "5.1.6")
+    (source (origin
+              (method git-fetch)
+              (uri (git-reference
+                    (url "https://gitlab.com/kicad/services/kicad-doc.git")
+                    (commit version)))
+              (file-name (git-file-name name version))
+              (sha256
+               (base32
+                "03kvss8a0xrjnfvkwymm0vfd7rn9ix7i926xdzz9jg9iycrjfj3g"))))
+    (build-system cmake-build-system)
+    (arguments
+     `(#:configure-flags (list "-DBUILD_FORMATS=html")
+       #:phases
+       (modify-phases %standard-phases
+         (delete 'build)
+         (add-before 'install 'set-perl-env
+           (lambda* (#:key inputs #:allow-other-keys)
+             (setenv "PERL5LIB"
+                     (string-append (assoc-ref inputs "perl-unicode-linebreak")
+                                    "/lib/perl5/site_perl" ":"
+                                    (getenv "PERL5LIB")))
+             #t))
+         (delete 'check))))
+    (native-inputs
+     `(("asciidoc" ,asciidoc)
+       ("gettext" ,gettext-minimal)
+       ("git" ,git-minimal)
+       ("perl" ,perl)
+       ("perl-unicode-linebreak" ,perl-unicode-linebreak)
+       ("po4a" ,po4a)
+       ("source-highlight" ,source-highlight)))
+    (home-page "https://kicad-pcb.org/")
+    (synopsis "KiCad official documentation")
+    (description "This repository contains the official KiCad documentation.")
+    (license license:gpl3+)))
+
 (define-public kicad-symbols
   (package
     (name "kicad-symbols")
-- 
2.26.2