unofficial mirror of bug-guix@gnu.org 
 help / color / mirror / code / Atom feed
From: Maxim Cournoyer <maxim.cournoyer@gmail.com>
To: 33497@debbugs.gnu.org
Subject: bug#33497: [PATCH] Re: bug#33497: Our CMake package has no documentation
Date: Sun, 25 Nov 2018 01:54:55 -0500	[thread overview]
Message-ID: <87y39h4pfk.fsf@gmail.com> (raw)
In-Reply-To: <8736rp649l.fsf@apteryx.i-did-not-set--mail-host-address--so-tickle-me> (Maxim Cournoyer's message of "Sun, 25 Nov 2018 01:49:10 -0500")

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

Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:

> Hello,
>
> Our CMake package lacks any documentation (manpage or other). Patch to
> follow.
>
> Maxim

Here's the patch to be merged in core-updates (or core-updates-next).


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-cmake-Generate-the-documentation.patch --]
[-- Type: text/x-patch, Size: 2544 bytes --]

From 07625983cd901c94e4ac25b157035c95e33a115e Mon Sep 17 00:00:00 2001
From: Maxim Cournoyer <maxim.cournoyer@gmail.com>
Date: Sun, 25 Nov 2018 01:39:54 -0500
Subject: [PATCH] gnu: cmake: Generate the documentation.

This fixes https://bugs.gnu.org/33497.

* gnu/packages/cmake.scm (gnu): Use the (gnu package python) and
(gnu packages texinfo) modules.
(cmake)[configure]: Add arguments to configure so that manual pages, info and
HTML documentation is generated.
[move-html-doc]: New phase.
[native-inputs]: Add the native inputs required for building the
documentation.
[outputs]: Add a "doc" output.
---
 gnu/packages/cmake.scm | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/cmake.scm b/gnu/packages/cmake.scm
index 5abf08755..36e887c51 100644
--- a/gnu/packages/cmake.scm
+++ b/gnu/packages/cmake.scm
@@ -38,7 +38,9 @@
   #:use-module (gnu packages curl)
   #:use-module (gnu packages file)
   #:use-module (gnu packages libevent)
+  #:use-module (gnu packages python)
   #:use-module (gnu packages ncurses)
+  #:use-module (gnu packages texinfo)
   #:use-module (gnu packages xml))
 
 (define-public cmake
@@ -136,7 +138,21 @@
                 "--mandir=share/man"
                 ,(string-append
                   "--docdir=share/doc/cmake-"
-                  (version-major+minor version)))))))))
+                  (version-major+minor version))
+                "--sphinx-man"
+                "--sphinx-html"
+                "--sphinx-info"))))
+         (add-after 'install 'move-html-doc
+           (lambda* (#:key outputs #:allow-other-keys)
+             (let ((out (assoc-ref outputs "out"))
+                   (doc (assoc-ref outputs "doc"))
+                   (html (string-append "/share/doc/cmake-"
+                                        ,(version-major+minor version)
+                                        "/html")))
+               (copy-recursively (string-append out html)
+                                 (string-append doc html))
+               (delete-file-recursively (string-append out html))
+               #t))))))
     (inputs
      `(("bzip2" ,bzip2)
        ("curl" ,curl)
@@ -147,6 +163,10 @@
        ("ncurses" ,ncurses) ; required for ccmake
        ("rhash" ,rhash)
        ("zlib" ,zlib)))
+    (native-inputs
+     `(("python-sphinx" ,python-sphinx)
+       ("texinfo" ,texinfo)))
+    (outputs '("out" "doc"))
     (native-search-paths
      (list (search-path-specification
             (variable "CMAKE_PREFIX_PATH")
-- 
2.19.0


  reply	other threads:[~2018-11-25  6:56 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-25  6:49 bug#33497: Our CMake package has no documentation Maxim Cournoyer
2018-11-25  6:54 ` Maxim Cournoyer [this message]
2019-02-12 20:17   ` bug#33497: [PATCH] " Marius Bakke
2019-03-12  1:33     ` Maxim Cournoyer
2019-03-17 16:36       ` Marius Bakke
2019-03-20 16:06         ` Maxim Cournoyer
2019-03-21  2:08           ` bug#33497: [PATCHv2] " Maxim Cournoyer
2019-03-21 18:40             ` Marius Bakke
2019-03-22  2:19               ` Maxim Cournoyer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87y39h4pfk.fsf@gmail.com \
    --to=maxim.cournoyer@gmail.com \
    --cc=33497@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).