docs: add notes on setting $(PKG)_GH_CONF

This commit is contained in:
Tony Theodore 2017-03-19 00:34:13 +11:00
parent 66a638e420
commit 3127d8e134
1 changed files with 11 additions and 2 deletions

View File

@ -1249,11 +1249,20 @@ local-pkg-list: $(LOCAL_PKG_LIST)</pre>
<p>
GitHub hosted projects can automatically configure updates,
urls, file names etc., see:
urls, file names etc. by setting <code>$(PKG)_GH_CONF</code>
instead of <code>$(PKG)_FILE, $(PKG)_SUBDIR, $(PKG)_URL, and
$(PKG)_UPDATE</code> sections.
</p>
<p>
To track normal release tags set:
<pre>$(PKG)_GH_CONF := owner/repo[, tag prefix, tag suffix, tag filter, version separator]</pre>
To track branches, set:
<pre>$(PKG)_GH_CONF := owner/repo/branch</pre>
See the following packages for examples:
<ul>
<li>
<a href="https://github.com/mxe/mxe/blob/master/src/vmime.mk">vmime.mk</a>
for an example of branch tracking
for branch tracking
</li>
<li>
<a href="https://github.com/mxe/mxe/blob/master/src/libevent.mk">libevent.mk</a>