summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTobias Geerinckx-Rice via Bug reports for GNU Guix <bug-guix@gnu.org>2021-03-09 22:41:57 +0100
committerTobias Geerinckx-Rice <me@tobias.gr>2021-04-01 14:35:59 +0200
commit1b1a61f86a258c417a061da0dca18a969a19b28e (patch)
treec367e9b5a500c45b0c0737a94dee2988724fef26
parent673031c7628ed7ad9accfb98aa45f3da7cbc75ce (diff)
doc: Discourage ambiguous package names.
* doc/contributing.texi (Package Naming): Explicitly mention single-character and otherwise ambiguous names.
-rw-r--r--doc/contributing.texi8
-rw-r--r--doc/guix.texi2
2 files changed, 9 insertions, 1 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi
index 58c4dafb9b..1cf345a3de 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -445,6 +445,14 @@ the project name chosen upstream, with underscores replaced with
hyphens. For instance, GNUnet is available as @code{gnunet}, and
SDL_net as @code{sdl-net}.
+A noteworthy exception to this rule is when the project name is only a
+single character, or if an older maintained project with the same name
+already exists---regardless of whether it has already been packaged for
+Guix. Use common sense to make such names unambiguous and meaningful.
+For example, Guix's package for the shell called ``s'' upstream is
+@code{s-shell} and @emph{not} @code{s}. Feel free to ask your fellow
+hackers for inspiration.
+
We do not add @code{lib} prefixes for library packages, unless these are
already part of the official project name. But @pxref{Python
Modules} and @ref{Perl Modules} for special rules concerning modules for
diff --git a/doc/guix.texi b/doc/guix.texi
index 115a7d9bd7..5814dd97d5 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -49,7 +49,7 @@ Copyright @copyright{} 2017, 2021 Christopher Lemmer Webber@*
Copyright @copyright{} 2017, 2018, 2019, 2020 Marius Bakke@*
Copyright @copyright{} 2017, 2019, 2020 Hartmut Goebel@*
Copyright @copyright{} 2017, 2019, 2020, 2021 Maxim Cournoyer@*
-Copyright @copyright{} 2017, 2018, 2019, 2020 Tobias Geerinckx-Rice@*
+Copyright @copyright{} 2017, 2018, 2019, 2020, 2021 Tobias Geerinckx-Rice@*
Copyright @copyright{} 2017 George Clemmer@*
Copyright @copyright{} 2017 Andy Wingo@*
Copyright @copyright{} 2017, 2018, 2019, 2020 Arun Isaac@*