Document the changes in USE_GITHUB.

Differential Revision:	https://reviews.freebsd.org/D2100
Approved by:	brd
Sponsored by:	Absolight
This commit is contained in:
Mathieu Arnold 2015-03-19 20:01:45 +00:00
parent 57f924371e
commit f507ad7318
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=46360

View file

@ -1721,7 +1721,7 @@ MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
<row>
<entry><varname>GH</varname></entry>
<entry><literal>/${GH_ACCOUNT}/${GH_PROJECT}/legacy.tar.gz/${GH_TAGNAME}?dummy=/</literal></entry>
<entry><literal>/${GH_ACCOUNT}/${GH_PROJECT}/tar.gz/${GH_TAGNAME}</literal></entry>
</row>
<row>
@ -1806,7 +1806,6 @@ MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
<entry>Variable</entry>
<entry>Description</entry>
<entry>Default</entry>
<entry>Mandatory</entry>
</row>
</thead>
@ -1815,8 +1814,7 @@ MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
<entry><varname>GH_ACCOUNT</varname></entry>
<entry>Account name of the GitHub user hosting the
project</entry>
<entry>none</entry>
<entry>Mandatory</entry>
<entry><literal>${PORTNAME}</literal></entry>
</row>
<row>
@ -1830,21 +1828,10 @@ MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
<entry><varname>GH_TAGNAME</varname></entry>
<entry>Name of the tag to download (2.0.1, hash, ...)
Using the name of a branch here is incorrect. It is
possible to do
<literal>GH_TAGNAME=${GH_COMMIT}</literal> to do a
also possible to use the hash of a commit id to do a
snapshot</entry>
<entry><literal>${DISTVERSION}</literal></entry>
</row>
<row>
<entry><varname>GH_COMMIT</varname></entry>
<entry>first 7 digits of the commit that generated
<varname>GH_TAGNAME</varname> (see
<link
xlink:href="http://www.freebsd.org/cgi/man.cgi?query=git-describe&amp;sektion=1&amp;manpath=FreeBSD+Ports">git-describe(1)</link>)</entry>
<entry>none</entry>
<entry>Mandatory</entry>
</row>
</tbody>
</tgroup>
</table>
@ -1863,13 +1850,12 @@ MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}</programlisting>
PORTVERSION= 1.2.7
USE_GITHUB= yes
GH_ACCOUNT= freebsd
GH_COMMIT= f53e577</programlisting>
GH_ACCOUNT= freebsd</programlisting>
<para>It will automatically have
<varname>MASTER_SITES</varname> set to <literal>GH
GHC</literal> and <varname>WRKSRC</varname> to
<literal>${WRKDIR}/freebsd-pkg-f53e577</literal>.</para>
<literal>${WRKDIR}/pkg-1.2.7</literal>.</para>
</example>
<example xml:id="makefile-master_sites-github-ex2">
@ -1889,13 +1875,12 @@ PORTVERSION= 1.3.0.a.20140411
USE_GITHUB= yes
GH_ACCOUNT= freebsd
GH_PROJECT= pkg
GH_TAGNAME= ${GH_COMMIT}
GH_COMMIT= 6dbb17b</programlisting>
GH_TAGNAME= 6dbb17b</programlisting>
<para>It will automatically have
<varname>MASTER_SITES</varname> set to <literal>GH
GHC</literal> and <varname>WRKSRC</varname> to
<literal>${WRKDIR}/freebsd-pkg-6dbb17b</literal>.</para>
<literal>${WRKDIR}/pkg-6dbb17b</literal>.</para>
</example>
</sect3>