GNU bug report logs - #42189
[PATCH] gnu: Add kicad-doc.

Previous Next

Package: guix-patches;

Reported by: Brice Waegeneire <brice <at> waegenei.re>

Date: Sat, 4 Jul 2020 16:02:01 UTC

Severity: normal

Tags: patch

Done: Ludovic Courtès <ludo <at> gnu.org>

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 42189 in the body.
You can then email your comments to 42189 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#42189; Package guix-patches. (Sat, 04 Jul 2020 16:02:01 GMT) Full text and rfc822 format available.

Acknowledgement sent to Brice Waegeneire <brice <at> waegenei.re>:
New bug report received and forwarded. Copy sent to guix-patches <at> gnu.org. (Sat, 04 Jul 2020 16:02:01 GMT) Full text and rfc822 format available.

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

From: Brice Waegeneire <brice <at> waegenei.re>
To: guix-patches <at> gnu.org
Cc: me <at> tobias.gr
Subject: [PATCH] gnu: Add kicad-doc.
Date: Sat,  4 Jul 2020 18:01:24 +0200
* 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





Information forwarded to guix-patches <at> gnu.org:
bug#42189; Package guix-patches. (Fri, 17 Jul 2020 18:52:02 GMT) Full text and rfc822 format available.

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

From: Danny Milosavljevic <dannym <at> scratchpost.org>
To: Brice Waegeneire <brice <at> waegenei.re>
Cc: me <at> tobias.gr, 42189 <at> debbugs.gnu.org
Subject: Re: [bug#42189] [PATCH] gnu: Add kicad-doc.
Date: Fri, 17 Jul 2020 20:51:38 +0200
[Message part 1 (text/plain, inline)]
LGTM!
[Message part 2 (application/pgp-signature, inline)]

Reply sent to Ludovic Courtès <ludo <at> gnu.org>:
You have taken responsibility. (Fri, 18 Dec 2020 15:06:01 GMT) Full text and rfc822 format available.

Notification sent to Brice Waegeneire <brice <at> waegenei.re>:
bug acknowledged by developer. (Fri, 18 Dec 2020 15:06:01 GMT) Full text and rfc822 format available.

Message #13 received at 42189-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Brice Waegeneire <brice <at> waegenei.re>
Cc: me <at> tobias.gr, 42189-done <at> debbugs.gnu.org
Subject: Re: [bug#42189] [PATCH] gnu: Add kicad-doc.
Date: Fri, 18 Dec 2020 16:04:43 +0100
Hi Brice,

Brice Waegeneire <brice <at> waegenei.re> skribis:

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

Finally applied on your behalf, thanks!

Ludo’.




bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sat, 16 Jan 2021 12:24:08 GMT) Full text and rfc822 format available.

This bug report was last modified 3 years and 72 days ago.

Previous Next


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