path: root/docs
diff options
authorGravatar Mischa Jonker <Mischa.Jonker@synopsys.com>2013-12-05 18:20:45 +0100
committerGravatar Peter Korsgaard <peter@korsgaard.com>2013-12-06 22:37:34 +0100
commitc7c7d0697c00e45bcfad15b027f5c66005f4c005 (patch)
treec9fca7ad9f24d6bed30227e52e3198418987e41a /docs
parentbb083e95cfae94a3a50551a2004f5ccdb02189a6 (diff)
docs: document the new github helper function
[Thomas: splitted from Mischa original commit] Signed-off-by: Mischa Jonker <mjonker@synopsys.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Acked-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
Diffstat (limited to 'docs')
2 files changed, 6 insertions, 4 deletions
diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
index 58cc1b89e3..7ff0a6174c 100644
--- a/docs/manual/adding-packages-generic.txt
+++ b/docs/manual/adding-packages-generic.txt
@@ -230,7 +230,9 @@ information is (assuming the package name is +libfoo+) :
URL or a local filesystem path. HTTP, FTP and SCP are supported URL
types for retrieving package tarballs. Git, Subversion, Mercurial,
and Bazaar are supported URL types for retrieving packages directly
- from source code management systems. A filesystem path may be used
+ from source code management systems. There is a helper function to make
+ it easier to download source tarballs from github (refer to
+ xref:github-download-url[] for details). A filesystem path may be used
to specify either a tarball or a directory containing the package
source code. See +LIBFOO_SITE_METHOD+ below for more details on how
retrieval works. +
@@ -244,7 +246,6 @@ information is (assuming the package name is +libfoo+) :
Examples: +
+LIBFOO_SITE=http://www.libfoosoftware.org/libfoo+ +
+LIBFOO_SITE=http://svn.xiph.org/trunk/Tremor/+ +
- +LIBFOO_SITE=git://github.com/kergoth/tslib.git+ +
+LIBFOO_SITE=/opt/software/libfoo.tar.gz+ +
diff --git a/docs/manual/adding-packages-tips.txt b/docs/manual/adding-packages-tips.txt
index 00244fe7b2..73c25be015 100644
--- a/docs/manual/adding-packages-tips.txt
+++ b/docs/manual/adding-packages-tips.txt
@@ -41,11 +41,12 @@ How to add a package from github
Packages on github often don't have a download area with release tarballs.
However, it is possible to download tarballs directly from the repository
-on github.
+on github. As github is known to have changed download mechanisms in the
+past, the 'github' helper function should be used as shown below.
FOO_VERSION = v1.0 # tag or full commit ID
-FOO_SITE = http://github.com/<user>/<package>/tarball/$(FOO_VERSION)
+FOO_SITE = $(call github,<user>,<package>,$(FOO_VERSION))