From patchwork Sun Jun 17 21:54:00 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nathan Lynch X-Patchwork-Id: 165351 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from whitealder.osuosl.org (whitealder.osuosl.org [140.211.166.138]) by ozlabs.org (Postfix) with ESMTP id 3CC64B735E for ; Mon, 18 Jun 2012 07:54:38 +1000 (EST) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id B4FE68C95A; Sun, 17 Jun 2012 21:54:31 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id FvNX6nx5Uw+M; Sun, 17 Jun 2012 21:54:27 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by whitealder.osuosl.org (Postfix) with ESMTP id 0C5E98C972; Sun, 17 Jun 2012 21:54:23 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from whitealder.osuosl.org (whitealder.osuosl.org [140.211.166.138]) by ash.osuosl.org (Postfix) with ESMTP id 910BC8F753 for ; Sun, 17 Jun 2012 21:54:13 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 893378A92B for ; Sun, 17 Jun 2012 21:54:13 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 9SoxAQWZggfG for ; Sun, 17 Jun 2012 21:54:08 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from sasl.smtp.pobox.com (a-pb-sasl-sd.pobox.com [74.115.168.62]) by whitealder.osuosl.org (Postfix) with ESMTP id 234718C972 for ; Sun, 17 Jun 2012 21:54:07 +0000 (UTC) Received: from sasl.smtp.pobox.com (unknown [127.0.0.1]) by b-pb-sasl-sd.pobox.com (Postfix) with ESMTP id BC140B940 for ; Sun, 17 Jun 2012 17:54:06 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=pobox.com; h=from:to :subject:date:message-id:in-reply-to:references; s=sasl; bh=ByuL 5m9R5+z11febUJXdLq2gePg=; b=rvw9v/Mz6jY4n+Lwr9cQOhOvq+MawOdTr3QO 0oW7+5uwav7Hqtc8295SuFx/XYFdHGDJOOpSGlMWt6tsituyO18UvpqhpTlh3xhs BT0M+44pZNiFBDR2Kyl+epggjnoO/6nPiylJwNxoDYNvgAW21/6Pwzk3UXbnGMh4 qyEPUTg= DomainKey-Signature: a=rsa-sha1; c=nofws; d=pobox.com; h=from:to:subject :date:message-id:in-reply-to:references; q=dns; s=sasl; b=gsgBXF 0jk0z/ceIoOjOIvzlyZqqilKkfXkT7XlqW5Ijqyn5mYevqfUahDlEXQ6P1AgUmUF 24nWJAQbSQlWPuDtgN6hxeK66Uutr6jjepnUyy6fZthOlkLPKdeE0iXogtpvxVOc Dlmf2PFZj3VtoSFTA67ihei/Uj7yTXFPHL+W4= Received: from b-pb-sasl-sd. (unknown [127.0.0.1]) by b-pb-sasl-sd.pobox.com (Postfix) with ESMTP id B5CE5B93F for ; Sun, 17 Jun 2012 17:54:06 -0400 (EDT) Received: from orca.stoopid.dyndns.org (unknown [99.12.192.254]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by b-pb-sasl-sd.pobox.com (Postfix) with ESMTPSA id 286F2B935 for ; Sun, 17 Jun 2012 17:54:05 -0400 (EDT) From: Nathan Lynch To: buildroot@busybox.net Date: Sun, 17 Jun 2012 16:54:00 -0500 Message-Id: <1339970041-17398-3-git-send-email-ntl@pobox.com> X-Mailer: git-send-email 1.7.10.2 In-Reply-To: <1339970041-17398-1-git-send-email-ntl@pobox.com> References: <1339970041-17398-1-git-send-email-ntl@pobox.com> X-Pobox-Relay-ID: F5AAE990-B8C6-11E1-AD35-FA6787E41631-04752483!b-pb-sasl-sd.pobox.com Subject: [Buildroot] [PATCH 2/3] docs: rework LIBFOO_SITE_METHOD documentation X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.14 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: buildroot-bounces@busybox.net Sender: buildroot-bounces@busybox.net The current structure of the LIBFOO_SITE_METHOD paragraph would make it difficult to add documentation for the "file" and "local" methods. There are enough possible values for LIBFOO_SITE_METHOD that describing them in a sub-list seems to work well, which makes it easier to add documentation for new methods. Signed-off-by: Nathan Lynch --- docs/manual/adding-packages-gentargets.txt | 46 ++++++++++++++++++---------- 1 file changed, 29 insertions(+), 17 deletions(-) diff --git a/docs/manual/adding-packages-gentargets.txt b/docs/manual/adding-packages-gentargets.txt index 918580e..b296ac4 100644 --- a/docs/manual/adding-packages-gentargets.txt +++ b/docs/manual/adding-packages-gentargets.txt @@ -180,23 +180,35 @@ The list of variables that can be set in a +.mk+ file to give metadata +LIBFOO_SITE=/opt/software/libfoo.tar.gz+ +LIBFOO_SITE=$(TOPDIR)/../src/libfoo/+ -* +LIBFOO_SITE_METHOD+ may contain the method to fetch the package - source code. It can either be +wget+ (for normal FTP/HTTP downloads - of tarballs), +scp+ (for downloads over SSH with scp), +svn+, +git+, - +hg+ or +bzr+. When not specified, it is guessed from the URL given - in +LIBFOO_SITE+: +scp://+, +svn://+, +git://+ and - +bzr://+ URLs will use the +scp+, +svn+, +git+ and +bzr+ methods - respectively. All other URL-types will use the +wget+ method. So for - example, in the case of a package whose source code is available - through a Subversion repository on HTTP, one 'must' specifiy - +LIBFOO_SITE_METHOD=svn+. Similarly, for Mercurial repositories, one - 'must' specify +LIBFOO_SITE_METHOD=hg+. For +svn+, +git+, +hg+ and - +bzr+ 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 +HOST_LIBFOO_SITE_METHOD+ is not specified, it defaults to the value - of +LIBFOO_SITE_METHOD+. See +package/multimedia/tremor/+ for an - example. +* +LIBFOO_SITE_METHOD+ determines the method used to fetch or copy the + package source code. In many cases, Buildroot guesses the method + from the contents of +LIBFOO_SITE+ and setting +LIBFOO_SITE_METHOD+ + is unnecessary. When +HOST_LIBFOO_SITE_METHOD+ is not specified, it + defaults to the value of +LIBFOO_SITE_METHOD+. + + The possible values of +LIBFOO_SITE_METHOD+ are: + ** +wget+ for normal FTP/HTTP downloads of tarballs. Used by + default when +LIBFOO_SITE+ begins with +http://+, +https://+ or + +ftp://+. + ** +scp+ for downloads of tarballs over SSH with scp. Used by + default when +LIBFOO_SITE+ begins with +scp://+. + ** +svn+ for retrieving source code from a Subversion repository. + Used by default when +LIBFOO_SITE+ begins with +svn://+. When a + +http://+ Subversion repository URL is specified in + +LIBFOO_SITE+, one 'must' specify +LIBFOO_SITE_METHOD=svn+. + Buildroot performs a checkout which is preserved as a tarball in + the download cache; subsequent builds use the tarball instead of + performing another checkout. + ** +git+ for retrieving source code from a Git repository. Used by + default when +LIBFOO_SITE+ begins with +git://+. The downloaded + source code is cached as with the +svn+ + method. + ** +hg+ for retrieving source code from a Mercurial repository. One + 'must' specify +LIBFOO_SITE_METHOD=hg+ when +LIBFOO_SITE+ + contains a Mercurial repository URL. The downloaded source code + is cached as with the +svn+ method. + ** +bzr+ for retrieving source code from a Bazaar repository. Used + by default when +LIBFOO_SITE+ begins with +bzr://+. The + downloaded source code is cached as with the +svn+ method. * +LIBFOO_DEPENDENCIES+ lists the dependencies (in terms of package name) that are required for the current target package to