From ad1d3f98b1d6f498d7f3e13d810f417ef3e7df5d Mon Sep 17 00:00:00 2001
From: Christopher Baines <mail@cbaines.net>
Date: Fri, 2 Sep 2022 19:59:04 +0100
Subject: [PATCH] gnu: Add comments to the bottom of a few package modules.

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

If there are more specific ways that packages should be arranged in specific
modules, this message can be updated accordingly.

* gnu/packages/bioconductor.scm: Add comment discouraging adding packages to
the bottom of the file.
* gnu/packages/bioinformatics.scm: ditto.
* gnu/packages/cran.scm: ditto.
* gnu/packages/crates-io.scm: ditto.
* gnu/packages/emacs-xyz.scm: ditto.
* gnu/packages/golang.scm: ditto.
* gnu/packages/guile-xyz.scm: ditto.
* gnu/packages/haskell-xyz.scm: ditto.
* gnu/packages/java.scm: ditto.
* gnu/packages/julia-xyz.scm: ditto.
* gnu/packages/lisp-xyz.scm: ditto.
* gnu/packages/ocaml.scm: ditto.
* gnu/packages/perl.scm: ditto.
* gnu/packages/python-science.scm: ditto.
* gnu/packages/python-xyz.scm: ditto.
* gnu/packages/ruby.scm: ditto.
* gnu/packages/tex.scm: ditto.
---
 gnu/packages/bioconductor.scm   | 6 ++++++
 gnu/packages/bioinformatics.scm | 6 ++++++
 gnu/packages/cran.scm           | 6 ++++++
 gnu/packages/crates-io.scm      | 6 ++++++
 gnu/packages/emacs-xyz.scm      | 6 ++++++
 gnu/packages/golang.scm         | 6 ++++++
 gnu/packages/guile-xyz.scm      | 6 ++++++
 gnu/packages/haskell-xyz.scm    | 5 +++++
 gnu/packages/java.scm           | 6 ++++++
 gnu/packages/julia-xyz.scm      | 6 ++++++
 gnu/packages/lisp-xyz.scm       | 6 ++++++
 gnu/packages/ocaml.scm          | 6 ++++++
 gnu/packages/perl.scm           | 6 ++++++
 gnu/packages/python-science.scm | 6 ++++++
 gnu/packages/python-xyz.scm     | 6 ++++++
 gnu/packages/ruby.scm           | 6 ++++++
 gnu/packages/tex.scm            | 6 ++++++
 17 files changed, 101 insertions(+)

diff --git a/gnu/packages/bioconductor.scm b/gnu/packages/bioconductor.scm
index 791c8b54761e7af8613caf17ef70c221fea28e35..5c377a7d595b55dae675cfe87b110d1ee57bead6 100644
--- a/gnu/packages/bioconductor.scm
+++ b/gnu/packages/bioconductor.scm
@@ -17036,3 +17036,9 @@ reproducibility.")
      "Phyloseq provides a set of classes and tools to facilitate the import,
 storage, analysis, and graphical display of microbiome census data.")
     (license license:agpl3)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/bioinformatics.scm b/gnu/packages/bioinformatics.scm
index efc8514a63dcc33594c583ac2cf02c70589f7485..8700f42c5d41c475d414cf7afea8cae71b9a5e2d 100644
--- a/gnu/packages/bioinformatics.scm
+++ b/gnu/packages/bioinformatics.scm
@@ -16721,3 +16721,9 @@ handling.")))
     (description
      "Bíogo is a bioinformatics library for the Go language.")
     (license license:bsd-3)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/cran.scm b/gnu/packages/cran.scm
index 81fa0f7b5bf90816061af3fd4bc9e247148d59d4..3d90dc2caa853905a5b8495397a900164656f3b9 100644
--- a/gnu/packages/cran.scm
+++ b/gnu/packages/cran.scm
@@ -34569,3 +34569,9 @@ calculate a dimension's unknown value from other dimensions' measurements.")
      "Tools for integrating spatially-misaligned GIS datasets.  Part of the
 Sub-National Geospatial Data Archive System.")
     (license license:gpl2)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/crates-io.scm b/gnu/packages/crates-io.scm
index 02f7bc7d4df515c30cf33030565c7fe1a2c2bfa1..e95055dad743e9a11d6511f9df00099abc6f4b70 100644
--- a/gnu/packages/crates-io.scm
+++ b/gnu/packages/crates-io.scm
@@ -75105,3 +75105,9 @@ way to convert simple shell commands to windows batch commands.")
     (description
      "This crate uses bindgen to generate the raw FFI definitions for PAM. For a rustified API consider using pam.")
     (license (list license:expat license:asl2.0))))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 508418ee9260693ceac9fe4ed7ec0e05b76a1e30..1a9c94622302d06af452bf3e65a2bdff35dda574 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -32570,3 +32570,9 @@ a way to pop up a frame at point.  Vertico-posframe is an Emacs package and
 a Vertico extension which provides a way to pop up a frame at point to show
 a vertical completion UI.")
     (license license:gpl3+)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/golang.scm b/gnu/packages/golang.scm
index 8e76534d34153103e5cfea708caafeb38d6dbee8..610e18310d89e9334f264699c3ff1b81ca738955 100644
--- a/gnu/packages/golang.scm
+++ b/gnu/packages/golang.scm
@@ -9992,3 +9992,9 @@ implementation.")
     (description "This package provides basic image processing functions
 (resize, rotate, crop, brightness/contrast adjustments, etc.).")
     (license license:expat)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/guile-xyz.scm b/gnu/packages/guile-xyz.scm
index ca251641d5337924ee34519f3af18e61ab6cf84f..1affb90027a1c037fc11a3259407905262a05958 100644
--- a/gnu/packages/guile-xyz.scm
+++ b/gnu/packages/guile-xyz.scm
@@ -5200,3 +5200,9 @@ capability security designs.  Goblins is a general toolkit, and also
 the core layer of Spritely's work to support healthy distributed
 networked communities.")
     (license license:asl2.0)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/haskell-xyz.scm b/gnu/packages/haskell-xyz.scm
index a01248f3550a5aa16444a5de2515a7c2d037faf4..43eb448c7ef74d895d39d174372d618349a03674 100644
--- a/gnu/packages/haskell-xyz.scm
+++ b/gnu/packages/haskell-xyz.scm
@@ -16123,3 +16123,8 @@ data Dec a
      "This package provides Type-level booleans.")
     (license license:bsd-3)))
 
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/java.scm b/gnu/packages/java.scm
index 73898d120c82f971a26a18421e99c7574a66262c..bb172f3beea70d56f1cde3ffda170f934f7a712f 100644
--- a/gnu/packages/java.scm
+++ b/gnu/packages/java.scm
@@ -14323,3 +14323,9 @@ The following TLA+ tools are available in this distribution:
 @item The PlusCal translator.
 @end itemize")
       (license license:expat))))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/julia-xyz.scm b/gnu/packages/julia-xyz.scm
index 6aa185486ba674cf8857387afc7333dd7083909e..28c759a5c0c6ab38762f2d81da303e5a6bd3c159 100644
--- a/gnu/packages/julia-xyz.scm
+++ b/gnu/packages/julia-xyz.scm
@@ -5878,3 +5878,9 @@ Zygote, without depending on Zygote itself.")
 differentiation (AD) in Julia, and is the next-generation AD system for the
 Flux differentiable programming framework.")
     (license license:expat)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/lisp-xyz.scm b/gnu/packages/lisp-xyz.scm
index 4fd3da31a42ad7ed67c52ba4bfe1fc87644db129..2ce5438b7137f16b1a03d93e976c8fbba42246e6 100644
--- a/gnu/packages/lisp-xyz.scm
+++ b/gnu/packages/lisp-xyz.scm
@@ -23897,3 +23897,9 @@ descent parsers without funky syntax or impenetrable macrology.")
 
 (define-public ecl-smug
   (sbcl-package->ecl-package sbcl-smug))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/ocaml.scm b/gnu/packages/ocaml.scm
index 2fd519ca4160398f8b4798c15e3aa47e0fe27a2b..89dcb1d60a20b591bcc4573a9d0792177b67e713 100644
--- a/gnu/packages/ocaml.scm
+++ b/gnu/packages/ocaml.scm
@@ -8774,3 +8774,9 @@ bibliography files in BibTeX format, a bibliography in HTML format.")
      "The OCaml guile library provides high-level OCaml bindings to GNU Guile
 3.0, supporting easy interop between OCaml and GNU Guile Scheme.")
     (license license:gpl3+)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/perl.scm b/gnu/packages/perl.scm
index 42c7d18c9dad4ab725df6d8b421f29ae6e6738f1..64868607dc95ecc6756a1b62135518418456c62e 100644
--- a/gnu/packages/perl.scm
+++ b/gnu/packages/perl.scm
@@ -11901,3 +11901,9 @@ It also allows manipulating ancillary data or so-called control
 information (cmsghdr).  This ancillary data may be used for file descriptor
 passing, IPv6 operations, and a host of implemenation-specific extensions.")
     (license license:perl-license)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;
diff --git a/gnu/packages/python-science.scm b/gnu/packages/python-science.scm
index 331b16df8f244d430300c22f0cda03ec9e1c0297..d571dd840684de6b9891220277f0d0a5974e66e7 100644
--- a/gnu/packages/python-science.scm
+++ b/gnu/packages/python-science.scm
@@ -1478,3 +1478,9 @@ Dask, PyTorch, Tensorflow, CuPy, Sparse, Theano, JAX, and Autograd arrays as
 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. To reduce the chances
+;;; of a merge conflict, 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 86fed87f26a2d7f2c31c4d6d9402f43010cabe2e..180464e157fcf1775e18e912ab66f380bc1b9fa9 100644
--- a/gnu/packages/python-xyz.scm
+++ b/gnu/packages/python-xyz.scm
@@ -30791,3 +30791,9 @@ functions
 @item Type annotations to help ensure correct usage
 @end itemize")
     (license license:bsd-3)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, 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 94c3bfeb6f1e7162a4a04eed99d077e036226404..c7d820e9e9b4f196cc54459d2635e2f5909099f4 100644
--- a/gnu/packages/ruby.scm
+++ b/gnu/packages/ruby.scm
@@ -13766,3 +13766,9 @@ can also be used as a Ruby library or as a web application, though the later
 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. To reduce the chances
+;;; of a merge conflict, 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 ae8bf43161f8bdb7955605aec76127262d6bbbf2..5e0228f2ab367ac2f6a630731ca6c406c0426a89 100644
--- a/gnu/packages/tex.scm
+++ b/gnu/packages/tex.scm
@@ -11685,3 +11685,9 @@ syllable.  The package itself does not support UTF-8 input in ordinary
 interest.  Since most such counters are simply incremented when they are
 changed, the recorded value will usually be the maximum value.")
     (license license:lppl1.3c+)))
+
+;;;
+;;; Avoid adding new packages to the end of this file. To reduce the chances
+;;; of a merge conflict, place them above by existing packages with similar
+;;; functionality or similar names.
+;;;