GNU bug report logs - #57549
[PATCH] gnu: Add comments to the bottom of a few package modules.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 57549 in the body.
You can then email your comments to 57549 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: Christopher Baines <mail <at> cbaines.net>
To: guix-patches <at> gnu.org
Subject: [PATCH] gnu: Add comments to the bottom of a few package modules.
Date: Fri,  2 Sep 2022 20:01:44 +0100

This will hopefully discourage patches which add new packages to the bottom of
files, as this increases the likelyhood of conflicts when applying patches.
---
 gnu/packages/python-science.scm | 5 +++++
 gnu/packages/python-xyz.scm     | 5 +++++
 gnu/packages/ruby.scm           | 5 +++++
 gnu/packages/tex.scm            | 5 +++++
 4 files changed, 20 insertions(+)

diff --git a/gnu/packages/python-science.scm b/gnu/packages/python-science.scm
index 95f60aae7b..1c165aa1de 100644
--- a/gnu/packages/python-science.scm
+++ b/gnu/packages/python-science.scm
@@ -1478,3 +1478,8 @@ (define-public python-opt-einsum
 well as potentially any library which conforms to a standard API. See the
 documentation for more information.")
     (license license:expat)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. Place them above by
+;;; existing packages with similar functionality or similar names.
+;;;
diff --git a/gnu/packages/python-xyz.scm b/gnu/packages/python-xyz.scm
index b058704172..e0e144de29 100644
--- a/gnu/packages/python-xyz.scm
+++ b/gnu/packages/python-xyz.scm
@@ -30738,3 +30738,8 @@ (define-public python-lief
      "@code{python-lief} is a cross platform library which can parse, modify
 and abstract ELF, PE and MachO formats.")
     (license license:asl2.0)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. Place them above by
+;;; existing packages with similar functionality or similar names.
+;;;
diff --git a/gnu/packages/ruby.scm b/gnu/packages/ruby.scm
index 94c3bfeb6f..a0c3990b98 100644
--- a/gnu/packages/ruby.scm
+++ b/gnu/packages/ruby.scm
@@ -13766,3 +13766,8 @@ (define (run-with-output-file file command . args)
 has not yet been packaged for Guix.")
     (license license:bsd-2)
     (properties `((upstream-name . "anystyle-cli")))))
+
+;;;
+;;; Avoid adding new packages to the end of this file. Place them above by
+;;; existing packages with similar functionality or similar names.
+;;;
diff --git a/gnu/packages/tex.scm b/gnu/packages/tex.scm
index 212c7eb4a9..c09bae4303 100644
--- a/gnu/packages/tex.scm
+++ b/gnu/packages/tex.scm
@@ -11572,3 +11572,8 @@ (define-public texlive-sourcecodepro
 Adobe in both Adobe Type 1 and OpenType formats, plus macros supporting the
 use of the fonts in LaTeX (Type 1) and XeLaTeX/LuaLaTeX (OTF).")
     (license (list license:lppl1.3+ license:silofl1.1))))
+
+;;;
+;;; Avoid adding new packages to the end of this file. Place them above by
+;;; existing packages with similar functionality or similar names.
+;;;
-- 
2.37.0

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

From: Maxime Devos <maximedevos <at> telenet.be>
To: Christopher Baines <mail <at> cbaines.net>, 57549 <at> debbugs.gnu.org
Subject: Re: [bug#57549] [PATCH] gnu: Add comments to the bottom of a few
 package modules.
Date: Fri, 2 Sep 2022 21:05:21 +0200

[Message part 1 (text/plain, inline)]

On 02-09-2022 21:01, Christopher Baines wrote:
> This will hopefully discourage patches which add new packages to the bottom of
> files, as this increases the likelyhood of conflicts when applying patches.
> ---
>   gnu/packages/python-science.scm | 5 +++++
>   gnu/packages/python-xyz.scm     | 5 +++++
>   gnu/packages/ruby.scm           | 5 +++++
>   gnu/packages/tex.scm            | 5 +++++
>   4 files changed, 20 insertions(+)

crates-io.scm could benefit from such lines as well.

Sounds useful, LGTM.

Greetings,
Maxime.

[OpenPGP_0x49E3EE22191725EE.asc (application/pgp-keys, attachment)]

[OpenPGP_signature (application/pgp-signature, attachment)]

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

From: Ludovic Courtès <ludo <at> gnu.org>
To: Christopher Baines <mail <at> cbaines.net>
Cc: 57549 <at> debbugs.gnu.org
Subject: Re: bug#57549: [PATCH] gnu: Add comments to the bottom of a few
 package modules.
Date: Thu, 08 Sep 2022 16:20:16 +0200

Hi,

Christopher Baines <mail <at> cbaines.net> skribis:

> This will hopefully discourage patches which add new packages to the bottom of
> files, as this increases the likelyhood of conflicts when applying patches.

Please mention the modified files here.

> +;;;
> +;;; Avoid adding new packages to the end of this file. Place them above by

Maybe start with “To reduce the chances of a merge conflict, avoid […]”?

Anyway, LGTM!

Ludo’.

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

From: Christopher Baines <mail <at> cbaines.net>
To: 57549-done <at> debbugs.gnu.org
Subject: Re: bug#57549: [PATCH] gnu: Add comments to the bottom of a few
 package modules.
Date: Sat, 10 Sep 2022 11:43:31 +0100

[Message part 1 (text/plain, inline)]

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

> Christopher Baines <mail <at> cbaines.net> skribis:
>
>> This will hopefully discourage patches which add new packages to the bottom of
>> files, as this increases the likelyhood of conflicts when applying patches.
>
> Please mention the modified files here.

Done.

>> +;;;
>> +;;; Avoid adding new packages to the end of this file. Place them above by
>
> Maybe start with “To reduce the chances of a merge conflict, avoid […]”?

I've added this in the second sentence, since I want to keep the
instruction first as this might make it harder to skip over and ignore.

> Anyway, LGTM!

Thanks Ludo and Maxime, pushed this as
fe42befd64df016d755f56107a407f5e4b5c3814.

Chris

[signature.asc (application/pgp-signature, inline)]

Previous Next

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