Mon Jun 14 22:53:03 2021 UTC ()
guide: Recommend that PKGNAME be lowercase


(nia)
diff -r1.60 -r1.61 pkgsrc/doc/guide/files/components.xml
cvs diff -r1.60 -r1.61 pkgsrc/doc/guide/files/components.xml (expand / switch to unified diff)

--- pkgsrc/doc/guide/files/components.xml 2021/03/26 17:43:20 1.60
+++ pkgsrc/doc/guide/files/components.xml 2021/06/14 22:53:02 1.61
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1<!-- $NetBSD: components.xml,v 1.60 2021/03/26 17:43:20 gdt Exp $ --> 1<!-- $NetBSD: components.xml,v 1.61 2021/06/14 22:53:02 nia Exp $ -->
2 2
3<chapter id="components"> <?dbhtml filename="components.html"?> 3<chapter id="components"> <?dbhtml filename="components.html"?>
4<title>Package components - files, directories and contents</title> 4<title>Package components - files, directories and contents</title>
5 5
6<para>Whenever you're preparing a package, there are a number of 6<para>Whenever you're preparing a package, there are a number of
7files involved which are described in the following 7files involved which are described in the following
8sections.</para> 8sections.</para>
9 9
10<sect1 id="components.Makefile"> 10<sect1 id="components.Makefile">
11 <title><filename>Makefile</filename></title> 11 <title><filename>Makefile</filename></title>
12 12
13 <para>Building, installation and creation of a binary package are all 13 <para>Building, installation and creation of a binary package are all
14 controlled by the package's <filename>Makefile</filename>. 14 controlled by the package's <filename>Makefile</filename>.
@@ -28,27 +28,32 @@ sections. @@ -28,27 +28,32 @@ sections.
28 <listitem><para><varname>DISTNAME</varname> is the basename of the 28 <listitem><para><varname>DISTNAME</varname> is the basename of the
29 distribution file to be downloaded from the package's 29 distribution file to be downloaded from the package's
30 website.</para></listitem> 30 website.</para></listitem>
31 31
32 <listitem><para><varname>PKGNAME</varname> is the name of the 32 <listitem><para><varname>PKGNAME</varname> is the name of the
33 package, as used by pkgsrc. You need to provide it if 33 package, as used by pkgsrc. You need to provide it if
34 <varname>DISTNAME</varname> (which is the default) is not a good 34 <varname>DISTNAME</varname> (which is the default) is not a good
35 name for the package in pkgsrc or <varname>DISTNAME</varname> is not 35 name for the package in pkgsrc or <varname>DISTNAME</varname> is not
36 provided (no distribution file is required). Usually it is the pkgsrc 36 provided (no distribution file is required). Usually it is the pkgsrc
37 directory name together with the version number. It must match the 37 directory name together with the version number. It must match the
38 regular expression 38 regular expression
39 <varname>^[A-Za-z0-9][A-Za-z0-9-_.+]*$</varname>, that is, it 39 <varname>^[A-Za-z0-9][A-Za-z0-9-_.+]*$</varname>, that is, it
40 starts with a letter or digit, and contains only letters, digits, 40 starts with a letter or digit, and contains only letters, digits,
41 dashes, underscores, dots and plus signs.</para></listitem> 41 dashes, underscores, dots and plus signs.
 42 New packages should have entirely lower-case names, with the exception
 43 of some that must follow pre-existing conventions
 44 (e.g. R packages begin with <varname>R-</varname>).
 45 You can use the <code>:tl</code> variable modifier to lower-case
 46 the package name.</para></listitem>
42 47
43 <listitem><para><varname>CATEGORIES</varname> is a list of categories 48 <listitem><para><varname>CATEGORIES</varname> is a list of categories
44 which the package fits in. You can choose any of the top-level 49 which the package fits in. You can choose any of the top-level
45 directories of pkgsrc for it.</para> 50 directories of pkgsrc for it.</para>
46 51
47 <para>Currently the following values are available for 52 <para>Currently the following values are available for
48 <varname>CATEGORIES</varname>. If more than 53 <varname>CATEGORIES</varname>. If more than
49 one is used, they need to be separated by spaces:</para> 54 one is used, they need to be separated by spaces:</para>
50 55
51<programlisting> 56<programlisting>
52archivers cross geography meta-pkgs security 57archivers cross geography meta-pkgs security
53audio databases graphics misc shells 58audio databases graphics misc shells
54benchmarks devel ham multimedia sysutils 59benchmarks devel ham multimedia sysutils