[PATCH] gnu: Add comments to the bottom of a few package modules.

  • Done
  • quality assurance status badge
Details
3 participants
  • Ludovic Courtès
  • Christopher Baines
  • Maxime Devos
Owner
unassigned
Submitted by
Christopher Baines
Severity
normal

Debbugs page

Christopher Baines wrote 3 years ago
(address . guix-patches@gnu.org)
20220902190144.16221-1-mail@cbaines.net
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(+)

Toggle diff (54 lines)
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
Maxime Devos wrote 3 years ago
921fdeab-37cf-0104-4621-cb2947e6547b@telenet.be
On 02-09-2022 21:01, Christopher Baines wrote:
Toggle quote (8 lines)
> 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.
Attachment: OpenPGP_signature
Ludovic Courtès wrote 3 years ago
Re: bug#57549: [PATCH] gnu: Add comments to the bottom of a few package modules.
(name . Christopher Baines)(address . mail@cbaines.net)(address . 57549@debbugs.gnu.org)
87k06eeyn3.fsf@gnu.org
Hi,

Christopher Baines <mail@cbaines.net> skribis:

Toggle quote (3 lines)
> 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.

Toggle quote (3 lines)
> +;;;
> +;;; 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’.
Christopher Baines wrote 3 years ago
(address . 57549-done@debbugs.gnu.org)
87o7vn1p9v.fsf@cbaines.net
Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (7 lines)
> Christopher Baines <mail@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.

Toggle quote (5 lines)
>> +;;;
>> +;;; 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.

Toggle quote (2 lines)
> Anyway, LGTM!

Thanks Ludo and Maxime, pushed this as
fe42befd64df016d755f56107a407f5e4b5c3814.

Chris
-----BEGIN PGP SIGNATURE-----

iQKlBAEBCgCPFiEEPonu50WOcg2XVOCyXiijOwuE9XcFAmMcasxfFIAAAAAALgAo
aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldDNF
ODlFRUU3NDU4RTcyMEQ5NzU0RTBCMjVFMjhBMzNCMEI4NEY1NzcRHG1haWxAY2Jh
aW5lcy5uZXQACgkQXiijOwuE9XeyzxAAlkMiGwA4yIvSB6RReWrnPz6FQMnoCDTM
iVBVDGQ3Poi7ap/Dw4rLKe7liYUntQ/T4l5ONibqprmCbAEup4AYTXmmE1Idoezh
bUBDF2EFY6329J+MztHp8cPt9olfxEhIr4Sw5g9vHY9ymlptHbX9N2kbuV1Y1Z9Q
eW/4aUSszcWKc5mZnhIiSNA5fuKrAf+o6bD4DAQusKjov1l7sofkT+if1ksMwoNZ
6hdT02WyNwxT6T6ZiRoDHxlgyKx/OpQdgOXFUF3VTQofk6MdNsi2dLyAhf96Eiun
Sgwg5cTlpoFjArTPIFM7iutT/+FtjZ44lMhtCsBG9UpQGte+5tbZy4Z+26gf+ljR
z6x7sm3jRUTuPWYwnQMAWKRm/gbH2WIXSZ9dsX7Yccu6FiIbO8P4jOEBqU1hseEZ
i0hmOSh7d3f4y9WHZ9mXpg5I2rixN1KJZFCPGpB6vG3wJHXaXRbWQLhqq+juUAzc
dVhVmTyl+oIqh3mwi5X5w6CxtEd6vA7hlz/R8Z0buOZo2vihGNMKzW2FPGan8zMA
itlGqER/eFr3LUVb6KSEF/t1GqgHDy3iRMZ4zFWBIgHpzVByE6hLJNKA2ItpYt5Q
c6Gdt89SPrhI4Um2KhpP74W5kpPNeMjy5cJO9N8zB4bRNSfO7zmPu/k5RFj79OoR
75NjYluGbQA=
=pES4
-----END PGP SIGNATURE-----

Closed
?
Your comment

This issue is archived.

To comment on this conversation send an email to 57549@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 57549
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch
You may also tag this issue. See list of standard tags. For example, to set the confirmed and easy tags
mumi command -t +confirmed -t +easy
Or, remove the moreinfo tag and set the help tag
mumi command -t -moreinfo -t +help