Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[pkgsrc/trunk]: pkgsrc/doc doc/pkgsrc.*: regen

details:   https://anonhg.NetBSD.org/pkgsrc/rev/686c7e3d1465
branches:  trunk
changeset: 436916:686c7e3d1465
user:      bacon <bacon%pkgsrc.org@localhost>
date:      Tue Aug 11 20:34:45 2020 +0000

description:
doc/pkgsrc.*: regen

diffstat:

 doc/pkgsrc.html |  732 ++++++++++++++++++++++++++++++-------------------------
 doc/pkgsrc.txt  |  401 ++++++++++++++++--------------
 2 files changed, 607 insertions(+), 526 deletions(-)

diffs (truncated from 1594 to 300 lines):

diff -r c1d53ef79b47 -r 686c7e3d1465 doc/pkgsrc.html
--- a/doc/pkgsrc.html   Tue Aug 11 20:32:58 2020 +0000
+++ b/doc/pkgsrc.html   Tue Aug 11 20:34:45 2020 +0000
@@ -8089,41 +8089,67 @@
 <div class="titlepage"><div><div><h4 class="title">
 <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
 <p>If your distfile URL looks similar to
-      <code class="literal">https://github.com/username/exampleproject/archive/v1.0.zip</code>,
+      <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
       then you are packaging a tagged release.</p>
 <pre class="programlisting">
-DISTNAME=       exampleproject-1.0
+DISTNAME=       example-1.0
 MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
-#GITHUB_PROJECT=        # can be omitted if same as DISTNAME
+#GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
 GITHUB_TAG=     v${PKGVERSION_NOREV}
 EXTRACT_SUFX=   .zip
 </pre>
 </div>
 <div class="sect3">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
-<p>If your distfile URL looks similar to
-      <code class="literal">https://github.com&#8203;/example&#8203;/example&#8203;/archive&#8203;/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>,
-      then you are packaging a specific commit not tied to a
-      release.</p>
-<pre class="programlisting">
-DISTNAME=       example-1.0
-MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
-#GITHUB_PROJECT=        # can be omitted if same as DISTNAME
+<a name="build.fetch.github.commit.prerelease"></a>21.2.3.2. Fetch based on a specific commit before the first release</h4></div></div></div>
+<p>If your distfile looks similar to
+      <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
+      release, then set the package version to 0.0.0.N, where N is the number
+      of commits to the repository, and set GITHUB_TAG to the commit hash.
+      This will (almost) ensure that the first tagged release will have a
+      version greater than this one so that package upgrades will function
+      properly.</p>
+<pre class="programlisting">
+DISTNAME=       example-0.0.0.347
+MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
+#GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
 GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
 </pre>
 </div>
 <div class="sect3">
 <div class="titlepage"><div><div><h4 class="title">
-<a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
+<a name="build.fetch.github.commit.postrelease"></a>21.2.3.3. Fetch based on a specific commit after a release</h4></div></div></div>
+<p>If your distfile looks similar to
+      <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
+      then include the last release version and the commit count since that
+      release in the package version and set GITHUB_TAG to the commit hash.
+      The latest release and commit count are shown in the output of
+      "git describe --tags":
+      </p>
+<pre class="screen">
+# git clone https://github.com/username/example
+# cd example
+# git describe --tags
+1.2.3-5-g988881a
+</pre>
+<pre class="programlisting">
+DISTNAME=       example-1.2.3.5
+MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
+#GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
+GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
+</pre>
+</div>
+<div class="sect3">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
 <p>If your distfile URL looks similar to
-      <code class="literal">https://github.com&#8203;/username/exampleproject&#8203;/releases&#8203;/download&#8203;/rel-1.6&#8203;/offensive-1.6.zip</code>,
+      <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
       then you are packaging a release.</p>
 <pre class="programlisting">
 DISTNAME=       offensive-1.6
 PKGNAME=        ${DISTNAME:S/offensive/proper/}
 MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
-GITHUB_PROJECT= exampleproject
+GITHUB_PROJECT= example
 GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
 EXTRACT_SUFX=   .zip
 </pre>
@@ -11165,391 +11191,395 @@
 </tr>
 <tr>
 <td>BIND_USER</td>
+<td>BINOWN</td>
+</tr>
+<tr>
 <td>BINPKG_SITES</td>
-</tr>
-<tr>
 <td>BIN_INSTALL_FLAGS</td>
+</tr>
+<tr>
 <td>BISON_PKGDATADIR</td>
-</tr>
-<tr>
 <td>BLAS_ACCEPTED</td>
+</tr>
+<tr>
 <td>BLAS_LIBS</td>
-</tr>
-<tr>
 <td>BLAS_TYPE</td>
+</tr>
+<tr>
 <td>BOOTSTRAP_DEPENDS</td>
-</tr>
-<tr>
 <td>BOOTSTRAP_SETUPTOOLS</td>
+</tr>
+<tr>
 <td>BROKEN</td>
-</tr>
-<tr>
 <td>BROKEN_EXCEPT_ON_PLATFORM</td>
+</tr>
+<tr>
 <td>BROKEN_ON_PLATFORM</td>
-</tr>
-<tr>
 <td>BSDSRCDIR</td>
+</tr>
+<tr>
 <td>BSDXSRCDIR</td>
-</tr>
-<tr>
 <td>BSD_MAKE_ENV</td>
+</tr>
+<tr>
 <td>BUILDLINK_AUTO_DIRS</td>
-</tr>
-<tr>
 <td>BUILDLINK_AUTO_VARS</td>
+</tr>
+<tr>
 <td>BUILDLINK_CFLAGS</td>
-</tr>
-<tr>
 <td>BUILDLINK_CONTENTS_FILTER</td>
+</tr>
+<tr>
 <td>BUILDLINK_CPPFLAGS</td>
-</tr>
-<tr>
 <td>BUILDLINK_DEPMETHOD</td>
+</tr>
+<tr>
 <td>BUILDLINK_FILES</td>
-</tr>
-<tr>
 <td>BUILDLINK_FILES_CMD</td>
+</tr>
+<tr>
 <td>BUILDLINK_FNAME_TRANSFORM</td>
-</tr>
-<tr>
 <td>BUILDLINK_LDFLAGS</td>
+</tr>
+<tr>
 <td>BUILDLINK_LIBS</td>
-</tr>
-<tr>
 <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
+</tr>
+<tr>
 <td>BUILDLINK_PKGNAME</td>
-</tr>
-<tr>
 <td>BUILDLINK_PREFIX</td>
+</tr>
+<tr>
 <td>BUILDLINK_RPATHDIRS</td>
-</tr>
-<tr>
 <td>BUILDLINK_TREE</td>
+</tr>
+<tr>
 <td>BUILD_DEFS</td>
-</tr>
-<tr>
 <td>BUILD_DEFS_EFFECTS</td>
+</tr>
+<tr>
 <td>BUILD_DEPENDS</td>
-</tr>
-<tr>
 <td>BUILD_DIRS</td>
+</tr>
+<tr>
 <td>BUILD_ENV_SHELL</td>
-</tr>
-<tr>
 <td>BUILD_MAKE_CMD</td>
+</tr>
+<tr>
 <td>BUILD_MAKE_FLAGS</td>
-</tr>
-<tr>
 <td>BUILD_TARGET</td>
+</tr>
+<tr>
 <td>BUILTIN_FIND_FILES</td>
-</tr>
-<tr>
 <td>BUILTIN_FIND_FILES_VAR</td>
+</tr>
+<tr>
 <td>BUILTIN_FIND_GREP</td>
-</tr>
-<tr>
 <td>BUILTIN_FIND_HEADERS</td>
+</tr>
+<tr>
 <td>BUILTIN_FIND_HEADERS_VAR</td>
-</tr>
-<tr>
 <td>BUILTIN_PKG</td>
+</tr>
+<tr>
 <td>BUILTIN_TEST_CURSES_DEFINES</td>
-</tr>
-<tr>
 <td>BUILTIN_TEST_CURSES_FUNCS</td>
+</tr>
+<tr>
 <td>BUILTIN_VERSION_SCRIPT</td>
-</tr>
-<tr>
 <td>BUILTIN_X11_TYPE</td>
+</tr>
+<tr>
 <td>BUILTIN_X11_VERSION</td>
-</tr>
-<tr>
 <td>CACTI_GROUP</td>
+</tr>
+<tr>
 <td>CACTI_USER</td>
-</tr>
-<tr>
 <td>CANNA_GROUP</td>
+</tr>
+<tr>
 <td>CANNA_USER</td>
-</tr>
-<tr>
 <td>CAT</td>
+</tr>
+<tr>
 <td>CCACHE_BASE</td>
-</tr>
-<tr>
 <td>CCACHE_DIR</td>
+</tr>
+<tr>
 <td>CCACHE_LOGFILE</td>
-</tr>
-<tr>
 <td>CC_VERSION</td>
+</tr>
+<tr>
 <td>CC_VERSION_STRING</td>
-</tr>
-<tr>
 <td>CDRECORD_CONF</td>
+</tr>
+<tr>
 <td>CDROM_PKG_URL_DIR</td>
-</tr>
-<tr>
 <td>CDROM_PKG_URL_HOST</td>
+</tr>
+<tr>
 <td>CHECKOUT_DATE</td>
-</tr>
-<tr>
 <td>CHECK_COMPILER</td>
+</tr>
+<tr>
 <td>CHECK_FAKEHOME</td>
-</tr>
-<tr>
 <td>CHECK_FILES</td>
+</tr>
+<tr>
 <td>CHECK_FILES_SKIP</td>
-</tr>
-<tr>
 <td>CHECK_FILES_STRICT</td>
+</tr>
+<tr>
 <td>CHECK_HEADERS</td>
-</tr>
-<tr>
Home | Main Index | Thread Index | Old Index