os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Always use "group" for the multiple location distribution file scheme.

Browse source 
It conflict with the tagname from the GitHub section.

Sponsored by:	Absolight
This commit is contained in:
Mathieu Arnold 2016-11-27 12:40:13 +00:00
parent 83cd11a4ac
commit 46057fadf7
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=49702
1 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

30
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
View file

@ -2099,8 +2099,8 @@ USE_GITHUB= yes</programlisting>
<varname>GH_ACCOUNT</varname>, <varname>GH_ACCOUNT</varname>,
<varname>GH_PROJECT</varname>, and <varname>GH_PROJECT</varname>, and
<varname>GH_TAGNAME</varname>. Each different value is <varname>GH_TAGNAME</varname>. Each different value is
assigned a tag. The main value can either have no tag, or assigned a group. The main value can either have no group, or
the <literal>:DEFAULT</literal> tag. A value can be the <literal>:DEFAULT</literal> group. A value can be
omitted if it is the same as the default as listed in omitted if it is the same as the default as listed in
<xref <xref
linkend="makefile-master_sites-github-description"/>.</para> linkend="makefile-master_sites-github-description"/>.</para>
@ -2110,11 +2110,11 @@ USE_GITHUB= yes</programlisting>
project, tagname, and group information at the same project, tagname, and group information at the same
place.</para> place.</para>
<para>For each tag, a <para>For each group, a
<varname>${WRKSRC_<replaceable>tag</replaceable>}</varname> <varname>${WRKSRC_<replaceable>group</replaceable>}</varname>
helper variable is created, containing the directory into helper variable is created, containing the directory into
which the file has been extracted. The which the file has been extracted. The
<varname>${WRKSRC_<replaceable>tag</replaceable>}</varname> <varname>${WRKSRC_<replaceable>group</replaceable>}</varname>
variables can be used to move directories around during variables can be used to move directories around during
<buildtarget>post-extract</buildtarget>, or add to <buildtarget>post-extract</buildtarget>, or add to
<varname>CONFIGURE_ARGS</varname>, or whatever is needed <varname>CONFIGURE_ARGS</varname>, or whatever is needed
@ -2123,7 +2123,7 @@ USE_GITHUB= yes</programlisting>
<note> <note>
<para>As this is only syntastic sugar above <para>As this is only syntastic sugar above
<varname>DISTFILES</varname> and <varname>DISTFILES</varname> and
<varname>MASTER_SITES</varname>, the tag names must adhere <varname>MASTER_SITES</varname>, the group names must adhere
to the restrictions on group names outlined in <xref to the restrictions on group names outlined in <xref
linkend="porting-master-sites-n"/></para> linkend="porting-master-sites-n"/></para>
</note> </note>
@ -2135,7 +2135,7 @@ USE_GITHUB= yes</programlisting>
<para>From time to time, there is a need to fetch more <para>From time to time, there is a need to fetch more
than one distribution file. For example, when the than one distribution file. For example, when the
upstream git repository uses submodules. This can be upstream git repository uses submodules. This can be
done easily using tags in the done easily using groups in the
<varname>GH_<replaceable>*</replaceable></varname> <varname>GH_<replaceable>*</replaceable></varname>
variables:</para> variables:</para>
@ -2153,8 +2153,8 @@ CONFIGURE_ARGS= --with-contrib=${WRKSRC_contrib}</programlisting>
<para>This will fetch three distribution files from <para>This will fetch three distribution files from
github. The default one comes from github. The default one comes from
<filename>foo/foo</filename> and is version <filename>foo/foo</filename> and is version
<literal>1.0.2</literal>. The second one, tagged <literal>1.0.2</literal>. The second one, with the
<literal>icons</literal>, comes from <literal>icons</literal> group, comes from
<filename>bar/foo-icons</filename> and is in version <filename>bar/foo-icons</filename> and is in version
<literal>1.0</literal>. The third one comes from <literal>1.0</literal>. The third one comes from
<filename>bar/foo-contrib</filename> and uses the <filename>bar/foo-contrib</filename> and uses the
@ -2170,11 +2170,11 @@ CONFIGURE_ARGS= --with-contrib=${WRKSRC_contrib}</programlisting>
<varname>${WRKSRC}</varname>, in this case, <varname>${WRKSRC}</varname>, in this case,
<filename>${WRKDIR}/foo-1.0.2</filename>. Each <filename>${WRKDIR}/foo-1.0.2</filename>. Each
additional distribution file is extracted in additional distribution file is extracted in
<varname>${WRKSRC_<replaceable>tag</replaceable>}</varname>. <varname>${WRKSRC_<replaceable>group</replaceable>}</varname>.
Here, for the <literal>icons</literal> tag, it is called Here, for the <literal>icons</literal> group, it is called
<varname>${WRKSRC_icons}</varname> and it contains <varname>${WRKSRC_icons}</varname> and it contains
<filename>${WRKDIR}/foo-icons-1.0</filename>. The file <filename>${WRKDIR}/foo-icons-1.0</filename>. The file
with the <literal>contrib</literal> tag is called with the <literal>contrib</literal> group is called
<varname>${WRKSRC_contrib}</varname> and contains <varname>${WRKSRC_contrib}</varname> and contains
<literal>${WRKDIR}/foo-contrib-fa579bc</literal>.</para> <literal>${WRKDIR}/foo-contrib-fa579bc</literal>.</para>
@ -2530,9 +2530,9 @@ EXTRACT_ONLY= source.tar.gz</programlisting>
<para>To support this, each entry in <para>To support this, each entry in
<varname>DISTFILES</varname> may be followed by a colon and <varname>DISTFILES</varname> may be followed by a colon and
a <quote>tag name</quote>. Each site listed in a <quote>group name</quote>. Each site listed in
<varname>MASTER_SITES</varname> is then followed by a colon, <varname>MASTER_SITES</varname> is then followed by a colon,
and the tag that indicates which distribution files are and the group that indicates which distribution files are
downloaded from this site.</para> downloaded from this site.</para>
<para>For example, consider an application with the source <para>For example, consider an application with the source
@ -2554,7 +2554,7 @@ DISTFILES= source1.tar.gz:source1 \
source2.tar.gz:source2</programlisting> source2.tar.gz:source2</programlisting>
</example> </example>
<para>Multiple distribution files can have the same tag. <para>Multiple distribution files can have the same group.
Continuing the previous example, suppose that there was a Continuing the previous example, suppose that there was a
third distfile, <filename>source3.tar.gz</filename>, that third distfile, <filename>source3.tar.gz</filename>, that
is downloaded from is downloaded from