diff options
| author | Tobias Geerinckx-Rice via Bug reports for GNU Guix <bug-guix@gnu.org> | 2021-03-09 22:41:57 +0100 |
|---|---|---|
| committer | Tobias Geerinckx-Rice <me@tobias.gr> | 2021-04-01 14:35:59 +0200 |
| commit | 1b1a61f86a258c417a061da0dca18a969a19b28e (patch) | |
| tree | c367e9b5a500c45b0c0737a94dee2988724fef26 /doc/contributing.texi | |
| parent | 673031c7628ed7ad9accfb98aa45f3da7cbc75ce (diff) | |
| download | guix-1b1a61f86a258c417a061da0dca18a969a19b28e.tar guix-1b1a61f86a258c417a061da0dca18a969a19b28e.tar.gz | |
doc: Discourage ambiguous package names.
* doc/contributing.texi (Package Naming): Explicitly mention
single-character and otherwise ambiguous names.
Diffstat (limited to 'doc/contributing.texi')
| -rw-r--r-- | doc/contributing.texi | 8 |
1 files changed, 8 insertions, 0 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 |