ryan77627/guix
1
0
Fork 0
mirror of https://git.in.rschanz.org/ryan77627/guix.git synced 2024-12-24 21:38:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Discourage ambiguous package names.

Browse source 
* doc/contributing.texi (Package Naming): Explicitly mention
single-character and otherwise ambiguous names.
This commit is contained in:
Tobias Geerinckx-Rice via Bug reports for GNU Guix 2021-03-09 22:41:57 +01:00 committed by Tobias Geerinckx-Rice
parent 673031c762
commit 1b1a61f86a
No known key found for this signature in database
GPG key ID: 0DB0FF884F556D79
2 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/contributing.texi
View file

@ -445,6 +445,14 @@ the project name chosen upstream, with underscores replaced with
hyphens. For instance, GNUnet is available as @code{gnunet}, and hyphens. For instance, GNUnet is available as @code{gnunet}, and
SDL_net as @code{sdl-net}. 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 We do not add @code{lib} prefixes for library packages, unless these are
already part of the official project name. But @pxref{Python already part of the official project name. But @pxref{Python
Modules} and @ref{Perl Modules} for special rules concerning modules for Modules} and @ref{Perl Modules} for special rules concerning modules for

2
doc/guix.texi
View file

@ -49,7 +49,7 @@ Copyright @copyright{} 2017, 2021 Christopher Lemmer Webber@*
Copyright @copyright{} 2017, 2018, 2019, 2020 Marius Bakke@* Copyright @copyright{} 2017, 2018, 2019, 2020 Marius Bakke@*
Copyright @copyright{} 2017, 2019, 2020 Hartmut Goebel@* Copyright @copyright{} 2017, 2019, 2020 Hartmut Goebel@*
Copyright @copyright{} 2017, 2019, 2020, 2021 Maxim Cournoyer@* 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 George Clemmer@*
Copyright @copyright{} 2017 Andy Wingo@* Copyright @copyright{} 2017 Andy Wingo@*
Copyright @copyright{} 2017, 2018, 2019, 2020 Arun Isaac@* Copyright @copyright{} 2017, 2018, 2019, 2020 Arun Isaac@*