Document the fact that group names should be restricted to a certain

character class.

PR:		210251
Sponsored by:	Absolight
This commit is contained in:
Mathieu Arnold 2016-06-14 14:17:44 +00:00
parent 341a558a78
commit 103261bf6e
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=48925

View file

@ -2106,6 +2106,14 @@ USE_GITHUB= yes</programlisting>
<varname>CONFIGURE_ARGS</varname>, or whatever is needed
so that the software builds correctly.</para>
<note>
<para>As this is only syntastic sugar above
<varname>DISTFILES</varname> and
<varname>MASTER_SITES</varname>, the tag names must adhere
to the restrictions on group names outlined in <xref
linkend="porting-master-sites-n"/></para>
</note>
<example xml:id="makefile-master_sites-github-multi">
<title>Use of <varname>USE_GITHUB</varname> with Multiple
Distribution Files</title>
@ -2335,9 +2343,9 @@ EXTRACT_ONLY= source.tar.gz</programlisting>
inside <varname>DISTFILES</varname> and
<varname>PATCHFILES</varname> which allows files and
patches to be postfixed with <literal>:n</literal>
identifiers. Here, <literal>n</literal> can be both
<literal>[0-9]</literal> and denote a group designation. For
example:</para>
identifiers. Here, <literal>n</literal> can be any word
containing <literal>[0-9a-zA-Z_]</literal> and denote a group
designation. For example:</para>
<programlisting>DISTFILES= alpha:0 beta:1</programlisting>
@ -2370,6 +2378,14 @@ EXTRACT_ONLY= source.tar.gz</programlisting>
&os; implementation of this idea. We improved a bit on
OpenBSD's concept.</para>
<important>
<para>The group names cannot have dashes in them
(<literal>-</literal>), in fact, they cannot have any
characters out of the <literal>[a-zA-Z0-9_]</literal> range.
This is because, while &man.make.1; is ok with variable
names containing dashes, &man.sh.1; is not.</para>
</important>
<sect3 xml:id="porting-master-sites-n-simplified">
<title>Simplified Information</title>