summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Petazzoni <thomas.petazzoni@free-electrons.com>2010-11-24 11:14:41 (GMT)
committer Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2010-11-24 15:34:27 (GMT)
commit3aac10520a4b175b99c38ce375bbab78275c135d (patch)
treee3817a5cb681d05f050048bf1d5d393adb7076fe
parenta88ba3eee0be79a45829b9d98b3c9bf3a93bcea4 (diff)
downloadbuildroot-3aac10520a4b175b99c38ce375bbab78275c135d.tar.gz
buildroot-3aac10520a4b175b99c38ce375bbab78275c135d.tar.bz2
documentation: Document the GIT/SVN download capabilities
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
-rw-r--r--docs/buildroot.html46
1 files changed, 37 insertions, 9 deletions
diff --git a/docs/buildroot.html b/docs/buildroot.html
index 0115f00..44aadf4 100644
--- a/docs/buildroot.html
+++ b/docs/buildroot.html
@@ -997,9 +997,12 @@ $(eval $(call GENTARGETS,package,libfoo,host))
<code>libfoo</code>) :</p>
<ul>
- <li><code>LIBFOO_VERSION</code>, mandatory, must contain the version
- of the package. Note that if <code>HOST_LIBFOO_VERSION</code> doesn't
- exist, it is assumed to be the same as <code>LIBFOO_VERSION</code>.<br/>
+ <li><code>LIBFOO_VERSION</code>, mandatory, must contain the
+ version of the package. Note that
+ if <code>HOST_LIBFOO_VERSION</code> doesn't exist, it is assumed
+ to be the same as <code>LIBFOO_VERSION</code>. It can also be a
+ Subversion or Git branch or tag, for packages that are fetched
+ directly from their revision control system.<br/>
Example: <code>LIBFOO_VERSION = 0.1.2</code></li>
<li><code>LIBFOO_SOURCE</code> may contain the name of the tarball of
@@ -1018,13 +1021,38 @@ $(eval $(call GENTARGETS,package,libfoo,host))
in the package directory inside Buildroot will be applied to the
package after extraction.</li>
- <li><code>LIBFOO_SITE</code> may contain the Internet location of the
- tarball of the package. If <code>HOST_LIBFOO_SITE</code> is not
- specified, it defaults to <code>LIBFOO_SITE</code>. If none are
- specified, then the location is assumed to be
+ <li><code>LIBFOO_SITE</code> may contain the Internet location
+ of the package. It can either be the HTTP or FTP location of a
+ tarball, or the URL of a Git or Subversion repository
+ (see <code>LIBFOO_SITE_METHOD</code>
+ below). If <code>HOST_LIBFOO_SITE</code> is not specified, it
+ defaults to <code>LIBFOO_SITE</code>. If none are specified,
+ then the location is assumed to be
<code>http://$$(BR2_SOURCEFORGE_MIRROR).dl.sourceforge.net/sourceforge/packagename</code>.
- <br/>Example:
- <code>LIBFOO_SITE=http://www.libfoosoftware.org/libfoo</code>.</li>
+ <br/>Examples:<br/>
+ <code>LIBFOO_SITE=http://www.libfoosoftware.org/libfoo</code><br/>
+ <code>LIBFOO_SITE=http://svn.xiph.org/trunk/Tremor/</code></li>
+
+ <li><code>LIBFOO_SITE_METHOD</code> may contain the method to
+ fetch the package source code. It can either
+ be <code>WGET</code> (for normal FTP/HTTP downloads of
+ tarballs), <code>SVN</code> or <code>GIT</code>. When not
+ specified, it is guessed from the URL given
+ in <code>LIBFOO_SITE</code>: <code>git://</code>
+ and <code>svn://</code> URLs will use the <code>GIT</code>
+ and <code>SVN</code> methods respectively. All other URL-types
+ will use the <code>WGET</code> method. So for example, in the
+ case of a package whose source code is available through
+ Subversion repository on HTTP, one <i>must</i>
+ specifiy <code>LIBFOO_SITE_METHOD=SVN</code>. For <code>SVN</code>
+ and <code>GIT</code> methods, what Buildroot does is a
+ checkout/clone of the repository which is then tarballed and
+ stored into the download cache. Next builds will not
+ checkout/clone again, but will use the tarball
+ directly. When <code>HOST_LIBFOO_SITE_METHOD</code> is not
+ specified, it defaults to the value
+ of <code>LIBFOO_SITE_METHOD</code>. See <code>package/multimedia/tremor/</code>
+ for an example.</li>
<li><code>LIBFOO_DEPENDENCIES</code> lists the dependencies (in terms
of package name) that are required for the current target package to