all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Marius Bakke <mbakke@fastmail.com>
To: Maxim Cournoyer <maxim.cournoyer@gmail.com>
Cc: 33497@debbugs.gnu.org
Subject: bug#33497: [PATCH] Re: bug#33497: Our CMake package has no documentation
Date: Sun, 17 Mar 2019 17:36:00 +0100	[thread overview]
Message-ID: <874l81a26n.fsf@fastmail.com> (raw)
In-Reply-To: <87o96glvvm.fsf@gmail.com>

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

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

> Hello Marius!
>
> Sorry for the delay.
>
> Marius Bakke <mbakke@fastmail.com> writes:
>
>> Hello!
>>
>> Now would be the time to get this in 'core-updates'.
>>
>> Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:
>>
>>> 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).
>>>
>>> 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.
>>
>> I'm not very comfortable with pulling python-sphinx into the dependency
>> closure of CMake, because then we can't update it or its dependencies
>> outside of the 'core-updates' cycle.  It could also cause circular
>> dependency issues down the road.
>>
>> Would it make sense to build the documentation as a separate package?
>> In that case it can go on the master branch.
>
> I don't like the idea of having a separate package for the documentation
> of cmake because it goes against the expectations of Guix users (package
> comes with its manpage, and extra doc can be installed as extra output
> of the same package).
>
> Maybe we could have a "cmake-minimal" package we'd keep hidden and use
> by default as part of the cmake-build-system, which wouldn't include the
> doc, and the regular, user facing cmake would be the one in this patch?

This sounds reasonable to me.  Can you send a patch?  :-)

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

  reply	other threads:[~2019-03-17 16:38 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 ` bug#33497: [PATCH] " Maxim Cournoyer
2019-02-12 20:17   ` Marius Bakke
2019-03-12  1:33     ` Maxim Cournoyer
2019-03-17 16:36       ` Marius Bakke [this message]
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

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

  git send-email \
    --in-reply-to=874l81a26n.fsf@fastmail.com \
    --to=mbakke@fastmail.com \
    --cc=33497@debbugs.gnu.org \
    --cc=maxim.cournoyer@gmail.com \
    /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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.