summaryrefslogtreecommitdiff
path: root/doc/guide
diff options
context:
space:
mode:
authortnn <tnn@pkgsrc.org>2015-03-07 21:31:15 +0000
committertnn <tnn@pkgsrc.org>2015-03-07 21:31:15 +0000
commitdac98684d85c33d74b13da1431ab2055d400a25e (patch)
tree0b0112d85e3ec1dd102bbbfb8ac3122499440751 /doc/guide
parent81fcba18057452d58defaf207bfe816a44067012 (diff)
downloadpkgsrc-dac98684d85c33d74b13da1431ab2055d400a25e.tar.gz
update github examples
Diffstat (limited to 'doc/guide')
-rw-r--r--doc/guide/files/fixes.xml30
1 files changed, 14 insertions, 16 deletions
diff --git a/doc/guide/files/fixes.xml b/doc/guide/files/fixes.xml
index a236daaf41b..b5672926e14 100644
--- a/doc/guide/files/fixes.xml
+++ b/doc/guide/files/fixes.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: fixes.xml,v 1.129 2015/03/07 15:14:27 tnn Exp $ -->
+<!-- $NetBSD: fixes.xml,v 1.130 2015/03/07 21:31:15 tnn Exp $ -->
<chapter id="fixes"> <?dbhtml filename="fixes.html"?>
<title>Making your package work</title>
@@ -780,7 +780,8 @@ FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
</sect2>
<sect2 id="build.fetch.github">
<title>Packages hosted on github.com</title>
- <para>Helper methods exist for packages hosted on github.com. You do not need to specify <varname>MASTER_SITE</varname> but should instead use one of the three supported methods from below.</para>
+ <para>Helper methods exist for packages hosted on github.com which will often have distfile names that clash with other packages, for example <filename>1.0.tar.gz</filename>. Use one of the three recipes from below:
+ </para>
<sect3 id="build.fetch.github.tag">
<title>Fetch based on a tagged release</title>
<para>
@@ -788,10 +789,9 @@ FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
</para>
<programlisting>
DISTNAME= exampleproject-1.0
-USE_GITHUB= yes
-GH_ACCOUNT= username
-#GH_PROJECT= # can be omitted if same as DISTNAME
-GH_TAGNAME= v1.0
+MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
+#GITHUB_PROJECT= # can be omitted if same as DISTNAME
+GITHUB_TAG= v${PKGVERSION_NOREV}
EXTRACT_SUFX= .zip
</programlisting>
</sect3>
@@ -802,12 +802,10 @@ EXTRACT_SUFX= .zip
</para>
<programlisting>
DISTNAME= example-1.0
-USE_GITHUB= yes
-#GH_ACCOUNT= # can be omitted if same as DISTNAME
-#GH_PROJECT= # can be omitted if same as DISTNAME
-GH_COMMIT= 988881adc9fc3655077dc2d4d757d480b5ea0e11
+MASTER_SITES= ${MASTER_SITE_GITHUB:example/}
+#GITHUB_PROJECT= # can be omitted if same as DISTNAME
+GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
</programlisting>
-
</sect3>
<sect3 id="build.fetch.github.release">
<title>Fetch based on release</title>
@@ -815,12 +813,12 @@ GH_COMMIT= 988881adc9fc3655077dc2d4d757d480b5ea0e11
If your distfile URL looks similar to <literal>http://github.com/username/exampleproject/releases/download/rel-1.6/offensive-1.6.zip</literal>, then you are packaging a release.
</para>
<programlisting>
-PKGNAME= ${DISTNAME:S/offensive/proper/}
DISTNAME= offensive-1.6
-USE_GITHUB= yes
-GH_ACCOUNT= username
-GH_PROJECT= exampleproject
-GH_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
+PKGNAME= ${DISTNAME:S/offensive/proper/}
+MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
+GITHUB_PROJECT= exampleproject
+GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
+EXTRACT_SUFX= .zip
</programlisting>
</sect3>
</sect2>