all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Maxime Devos <maximedevos@telenet.be>
To: Liliana Marie Prikler <liliana.prikler@gmail.com>,
	Guix-devel <guix-devel@gnu.org>
Cc: blake@reproduciblemedia.com,
	"Julien Lepiller" <julien@lepiller.eu>,
	Ludovic_Courtès <ludo@gnu.org>,
	"Philip McGrath" <philip@philipmcgrath.com>
Subject: Re: [PATCH] doc: Update contribution guidelines on patches, etc.
Date: Tue, 9 Aug 2022 18:45:56 +0200	[thread overview]
Message-ID: <9e87d335-ed11-1bd9-fe72-9ba23ae4af63@telenet.be> (raw)
In-Reply-To: <2fe4881ad87876ae70ef4f3340b34d589a65bb71.camel@gmail.com>


[-- Attachment #1.1.1: Type: text/plain, Size: 2585 bytes --]

On 06-08-2022 08:55, Liliana Marie Prikler wrote:

> +If your package has a bug that takes multiple lines to fix,
I don't think this is true for replacing all instances of "foo" by 
"/gnu/store/.../bin/foo" in a file.
>   or a fix
> +has already been accepted upstream, patches are the preferred way of
> +eliminating said bug
> +Refer to the @code{origin} record documentation
> +(particularly the fields @code{snippet} and @code{modules}), for more
> +information (@pxref{origin Reference}).
> +

The "Refer to the ... documentation for more information" occurred in 
the old version of (guix)Snippets versus Phases. However, back then, I 
did not find more information on how to decide between snippets, patches 
and phases, and neither do I now.

Maybe:

+Refer to the @code{origin} record documentation
+(@pxref{origin Reference}) (particularly the fields @code{snippet} and @code{modules})
+for more information on how to use snippets

, to avoid a reader's assumption that that section contains information 
on deciding between snippets, phases and patches.

> + Furthermore, as with patches, modifying the snippets causes two derivations to be built.

This is true, but I don't think reviewers and package authors have to 
worry about that.

> Such changes include, but are not limited to fixes of the
> +build script(s) or embeddings of store paths (e.g. replacement of
> +@file{/bin/sh} with @code{(search-input-file inputs "bin/sh")}).
Include what? I think you need to close the subsentence here:

> +Such changes include, but are not limited to, fixes of the build
> +script(s) or embeddings of store paths (e.g. [...])
>

[...]

> +Build phases are limited in that they do not modify the source
> +derivation.  Thus, they are inadequate for changes that are to be
> +reflected in the source code.  On the other hand, they only cause a
> +single rebuild and are thus slightly easier to debug than phases and
> +snippets.
Derivations are a rather low-level concept, could they be avoided in the 
origin and phases documentation?

> +Build phases are limited in that they do not modify the source
> +derivation.  Thus, they are inadequate for changes that are to be
> +reflected in the source code.  On the other hand, they only cause a
> +single rebuild and are thus slightly easier to debug than phases and
> +snippets.
See Andreas' comment on phase->snippet.

Also, do I understand correctly that the argument here is that 'single 
rebuild -> less compilation time -> easier to debug'?

Greetings,
Maxime.


[-- Attachment #1.1.2: OpenPGP public key --]
[-- Type: application/pgp-keys, Size: 929 bytes --]

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

  parent reply	other threads:[~2022-08-09 16:46 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-25  3:17 A proposal of a consistent set of clear rules and guidelines involving snippets, phases and patches Maxime Devos
2022-07-25  5:21 ` Julien Lepiller
2022-07-25 11:18   ` Maxime Devos
2022-07-25 11:37     ` Julien Lepiller
2022-08-04  8:51 ` Ludovic Courtès
2022-08-05  3:23 ` Philip McGrath
2022-08-05  8:13   ` Maxime Devos
2022-08-05  3:38 ` Philip McGrath
2022-08-05  8:09   ` Maxime Devos
2022-08-05 10:18 ` Maxime Devos
2022-08-05 13:59 ` v2: " Maxime Devos
2022-08-06  6:55   ` [PATCH] doc: Update contribution guidelines on patches, etc Liliana Marie Prikler
2022-08-06  6:55     ` [PATCH v2] " Liliana Marie Prikler
2022-09-02 13:12       ` Ludovic Courtès
2022-09-02 18:05         ` Maxime Devos
2022-09-05  9:47           ` Ludovic Courtès
2022-09-05 13:12             ` Maxime Devos
2022-09-05 16:05               ` Maxime Devos
2022-08-09 16:45     ` Maxime Devos [this message]
2022-08-09 17:05       ` [PATCH] " Liliana Marie Prikler
2022-08-09 18:19         ` Maxime Devos
2022-08-09 19:08           ` Liliana Marie Prikler
2022-08-09 20:30             ` Maxime Devos
2022-08-10  4:25               ` Liliana Marie Prikler
2022-08-09 20:40             ` Maxime Devos
2022-08-08 21:51   ` v2: A proposal of a consistent set of clear rules and guidelines involving snippets, phases and patches Andreas Enge
2022-08-09 15:06     ` Maxime Devos
2022-08-09 17:10       ` Andreas Enge
2022-09-05 13:03     ` Maxime Devos
2022-09-07 12:17       ` Andreas Enge
2022-09-07 18:08         ` Maxime Devos
2022-08-09 18:58   ` david larsson
2022-08-09 20:53     ` Maxime Devos
2022-08-10 11:23       ` david larsson
2022-08-05 16:59 ` blake
2022-08-09 16:30   ` Maxime Devos
2022-09-05 14:06     ` Maxime Devos
2022-08-10  6:10   ` blake
2022-08-10  9:06     ` Maxime Devos
2022-08-10 10:33     ` blake
2022-08-10 10:44       ` Maxime Devos

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=9e87d335-ed11-1bd9-fe72-9ba23ae4af63@telenet.be \
    --to=maximedevos@telenet.be \
    --cc=blake@reproduciblemedia.com \
    --cc=guix-devel@gnu.org \
    --cc=julien@lepiller.eu \
    --cc=liliana.prikler@gmail.com \
    --cc=ludo@gnu.org \
    --cc=philip@philipmcgrath.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.