From owner-svn-doc-all@FreeBSD.ORG  Mon Mar 23 18:18:27 2015
Return-Path: <owner-svn-doc-all@FreeBSD.ORG>
Delivered-To: svn-doc-all@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTPS id 70E371D7;
 Mon, 23 Mar 2015 18:18:27 +0000 (UTC)
Received: from svn.freebsd.org (svn.freebsd.org
 [IPv6:2001:1900:2254:2068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id 415B0699;
 Mon, 23 Mar 2015 18:18:27 +0000 (UTC)
Received: from svn.freebsd.org ([127.0.1.70])
 by svn.freebsd.org (8.14.9/8.14.9) with ESMTP id t2NIIRFH018735;
 Mon, 23 Mar 2015 18:18:27 GMT (envelope-from mat@FreeBSD.org)
Received: (from mat@localhost)
 by svn.freebsd.org (8.14.9/8.14.9/Submit) id t2NIIRjr018734;
 Mon, 23 Mar 2015 18:18:27 GMT (envelope-from mat@FreeBSD.org)
Message-Id: <201503231818.t2NIIRjr018734@svn.freebsd.org>
X-Authentication-Warning: svn.freebsd.org: mat set sender to mat@FreeBSD.org
 using -f
From: Mathieu Arnold <mat@FreeBSD.org>
Date: Mon, 23 Mar 2015 18:18:27 +0000 (UTC)
To: doc-committers@freebsd.org, svn-doc-all@freebsd.org,
 svn-doc-head@freebsd.org
Subject: svn commit: r46370 -
 head/en_US.ISO8859-1/books/porters-handbook/makefiles
X-SVN-Group: doc-head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-doc-all@freebsd.org
X-Mailman-Version: 2.1.18-1
Precedence: list
List-Id: "SVN commit messages for the entire doc trees \(except for &quot;
 user&quot; , &quot; projects&quot; , and &quot; translations&quot;
 \)" <svn-doc-all.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/svn-doc-all>,
 <mailto:svn-doc-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-doc-all/>
List-Post: <mailto:svn-doc-all@freebsd.org>
List-Help: <mailto:svn-doc-all-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-doc-all>,
 <mailto:svn-doc-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 23 Mar 2015 18:18:27 -0000

Author: mat (ports committer)
Date: Mon Mar 23 18:18:26 2015
New Revision: 46370
URL: https://svnweb.freebsd.org/changeset/doc/46370

Log:
  Correct GH_TAGNAME's default, and add another example.
  
  Differential Revision:	https://reviews.freebsd.org/D2118
  Reviewed by:	bcr bdrewery
  Sponsored by:	Absolight

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml

Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml	Mon Mar 23 16:26:59 2015	(r46369)
+++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml	Mon Mar 23 18:18:26 2015	(r46370)
@@ -1829,8 +1829,8 @@ MASTER_SITE_SUBDIR=	stardict/WyabdcRealP
 		<entry>Name of the tag to download (2.0.1, hash, ...)
 		  Using the name of a branch here is incorrect.  It is
 		  also possible to use the hash of a commit id to do a
-		  snapshot</entry>
-		<entry><literal>${DISTVERSION}</literal></entry>
+		  snapshot.</entry>
+		<entry><literal>${DISTVERSIONPREFIX}${DISTVERSION}${DISTVERSIONSUFFIX}</literal></entry>
 	      </row>
 	    </tbody>
 	  </tgroup>
@@ -1883,6 +1883,30 @@ GH_TAGNAME=	6dbb17b</programlisting>
 	    <literal>${WRKDIR}/pkg-6dbb17b</literal>.</para>
 	</example>
 
+	<example xml:id="makefile-master_sites-github-ex3">
+	  <title>Use of <varname>USE_GITHUB</varname> with
+	    <varname>DISTVERSIONPREFIX</varname></title>
+
+	  <para>From time to time, <varname>GH_TAGNAME</varname> is a
+	    slight variation from <varname>PORTREVISION</varname>.
+	    For example, if the version is <literal>1.0.2</literal>,
+	    the tag is <literal>v1.0.2</literal>.  In those cases, it
+	    is possible to use <varname>DISTVERSIONPREFIX</varname> or
+	    <varname>DISTVERSIONSUFFIX</varname>:</para>
+
+	  <programlisting>PORTNAME=	foo
+PORTVERSION=	1.0.2
+DISTVERSIONPREFIX=	v
+
+USE_GITHUB=	yes</programlisting>
+
+	  <para>It will automatically set
+	    <varname>GH_TAGNAME</varname> to
+	    <literal>v1.0.2</literal>, while <varname>WRKSRC</varname>
+	    will be kept to
+	    <varname>${WRKDIR}/foo-1.0.2</varname>.</para>
+	</example>
+
       </sect3>
     </sect2>