From b26a945734ce271aa7d443ff9e96fe2851b21138 Mon Sep 17 00:00:00 2001 From: Richard Purdie Date: Mon, 20 Mar 2006 17:45:11 +0000 Subject: Update to latest bitbake git-svn-id: https://svn.o-hand.com/repos/poky/trunk@309 311d38ba-8fff-0310-9ca6-ca027cbcb966 --- bitbake/doc/manual/usermanual.xml | 88 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 84 insertions(+), 4 deletions(-) (limited to 'bitbake/doc/manual/usermanual.xml') diff --git a/bitbake/doc/manual/usermanual.xml b/bitbake/doc/manual/usermanual.xml index 277e615100..33150b10f2 100644 --- a/bitbake/doc/manual/usermanual.xml +++ b/bitbake/doc/manual/usermanual.xml @@ -12,7 +12,7 @@ BitBake Team - 2004, 2005 + 2004, 2005, 2006 Chris Larson Phil Blundell @@ -111,9 +111,9 @@ share common metadata between many packages.
Appending (.=) and prepending (=.) without spaces B = "bval" -B += "additionaldata" +B .= "additionaldata" C = "cval" -C =+ "test" +C =. "test" In this example, B is now bvaladditionaldata and C is testcval. In contrast to the above Appending and Prepending operators no additional space will be introduced.
@@ -228,6 +228,86 @@ of the event and the content of the FILE variable. + + + File Download support +
+ Overview + BitBake provides support to download files this procedure is called fetching. The SRC_URI is normally used to indicate BitBake which files to fetch. The next sections will describe th available fetchers and the options they have. Each Fetcher honors a set of Variables and +a per URI parameters separated by a ; consisting of a key and a value. The semantic of the Variables and Parameters are defined by the Fetcher. BitBakes tries to have a consistent semantic between the different Fetchers. + +
+ +
+ Local File Fetcher + The URN for the Local File Fetcher is file. The filename can be either absolute or relative. If the filename is relative FILESPATH and FILESDIR will be used to find the appropriate relative file depending on the OVERRIDES. Single files and complete directories can be specified. +SRC_URI= "file://relativefile.patch" +SRC_URI= "file://relativefile.patch;this=ignored" +SRC_URI= "file:///Users/ich/very_important_software" + + +
+ +
+ CVS File Fetcher + The URN for the CVS Fetcher is cvs. This Fetcher honors the variables DL_DIR, SRCDATE, FETCHCOMMAND_cvs, UPDATECOMMAND_cvs. DL_DIRS specifies where a temporary checkout is saved, SRCDATE specifies which date to use when doing the fetching, FETCHCOMMAND and UPDATECOMMAND specify which executables should be used when doing the CVS checkout or update. + + The supported Parameters are module, tag, date, method, localdir, rsh. The module specifies which module to check out, the tag describes which CVS TAG should be used for the checkout by default the TAG is empty. A date can be specified to override the SRCDATE of the configuration to checkout a specific date. method is by default pserver, if ext is used the rsh parameter will be evaluated and CVS_RSH will be set. Finally localdir is used to checkout into a special directory relative to CVSDIR>. +SRC_URI = "cvs://CVSROOT;module=mymodule;tag=some-version;method=ext" +SRC_URI = "cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat" + + +
+ +
+ HTTP/FTP Fetcher + The URNs for the HTTP/FTP are http, https and ftp. This Fetcher honors the variables DL_DIR, FETCHCOMMAND_wget, PREMIRRORS, MIRRORS. The DL_DIR defines where to store the fetched file, FETCHCOMMAND contains the command used for fetching. ${URI} and ${FILES} will be replaced by the uri and basename of the to be fetched file. PREMIRRORS +will be tried first when fetching a file if that fails the actual file will be tried and finally all MIRRORS will be tried. + + The only supported Parameter is md5sum. After a fetch the md5sum of the file will be calculated and the two sums will be compared. + + SRC_URI = "http://oe.handhelds.org/not_there.aac;md5sum=12343" +SRC_URI = "ftp://oe.handhelds.org/not_there_as_well.aac;md5sum=1234" +SRC_URI = "ftp://you@oe.handheld.sorg/home/you/secret.plan;md5sum=1234" + +
+ +
+ SVK Fetcher + + Currently NOT suppoered + +
+ +
+ SVN Fetcher + The URN for the SVN Fetcher is svn. + + The Variables FETCHCOMMAND_svn, DL_DIR are used by the SVN Fetcher. FETCHCOMMAND contains the subversion command, DL_DIR is the directory where tarballs will be saved. + + The supported Parameters are proto, rev. proto is the subversion prototype, rev is the subversions revision. + + SRC_URI = "svn://svn.oe.handhelds.org/svn;module=vip;proto=http;rev=667" +SRC_URI = "svn://svn.oe.handhelds.org/svn/;module=opie;proto=svn+ssh;date=20060126" + +
+ +
+ GIT Fetcher + The URN for the GIT Fetcher is git. + + The Variables DL_DIR, GITDIR are used. DL_DIR will be used to store the checkedout version. GITDIR will be used as the base directory where the git tree is cloned to. + + The Parameters are tag, protocol. tag is a git tag, the default is master. protocol is the git protocol to use and defaults to rsync. + + SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1" +SRC_URI = "git://git.oe.handhelds.org/git/vip.git;protocol=http" + +
+ + + + Commands
@@ -320,7 +400,7 @@ options: Depending on another .bb a.bb: PN = "package-a" - DEPENDS += "package-b" +DEPENDS += "package-b" b.bb: PN = "package-b" -- cgit v1.2.3-54-g00ecf