diff --git a/bitbake/doc/user-manual/user-manual-fetching.xml b/bitbake/doc/user-manual/user-manual-fetching.xml index 1ff8acb4e0..cdca64c801 100644 --- a/bitbake/doc/user-manual/user-manual-fetching.xml +++ b/bitbake/doc/user-manual/user-manual-fetching.xml @@ -4,25 +4,25 @@ File download support -
+
Overview - BitBake provides support to download files - this procedure is called fetching and it handled by the + BitBake provides support to download files. + This procedure is called fetching and is handled by the fetch and fetch2 modules. - At this point the original fetch code is considered to - be replaced by fetch2 and this manual only related + At this point, the original fetch code is considered to + be replaced by fetch2 and this manual is only related to the fetch2 codebase. The SRC_URI is normally used to tell BitBake which files to fetch. - The next sections will describe the available fetchers and + The next sections describe the available fetchers and their options. Each fetcher honors a set of variables and per - URI parameters separated by a ; consisting of a key and + URI parameters separated by a “;” consisting of a key and a value. The semantics of the variables and parameters are defined by the fetcher. @@ -31,16 +31,16 @@ - The overall fetch process is that first, fetches are attempted from + The overall fetch process first attempts to fetch from PREMIRRORS. - If those don't work, the original SRC_URI - is attempted - and if that fails, BitBake will fall back to + If these fail, the original SRC_URI + is attempted. + If that fails, BitBake falls back to MIRRORS. - Cross urls are supported, so its possible to mirror - a git repository on an http server as a tarball for example. - Some example commonly used mirror - definitions are: + Because cross-URLs are supported, it is possible to mirror + a Git repository on an HTTP server as a tarball. + Here are some examples that show commonly used mirror + definitions: PREMIRRORS ?= "\ bzr://.*/.* http://somemirror.org/sources/ \n \ @@ -63,26 +63,33 @@ MIRRORS =+ "\ Non-local downloaded output is placed into the directory specified by the DL_DIR variable. - For non local archive downloads the code can verify + For non local archive downloads, the code can verify sha256 and md5 checksums for the download to ensure the file has been downloaded correctly. - These may be specified either in the form - SRC_URI[md5sum] - for the md5 checksum and - SRC_URI[sha256sum] - for the sha256 checksum or as parameters on the SRC_URI such as - SRC_URI="http://example.com/foobar.tar.bz2;md5sum=4a8e0f237e961fd7785d19d07fdb994d". + These can be specified in the following forms + for md5 and sha256 checksums, respectively: + + SRC_URI[md5sum] + SRC_URI[sha256sum] + + You can also specify them as parameters on the + SRC_URI: + + SRC_URI="http://example.com/foobar.tar.bz2;md5sum=4a8e0f237e961fd7785d19d07fdb994d" + If BB_STRICT_CHECKSUM is set, any download without a checksum will trigger an error message. In cases where multiple files are listed in - SRC_URI, the name parameter is used - assign names to the urls and these are then specified - in the checksums in the form - SRC_URI[name.sha256sum]. + SRC_URI, the name parameter is used + assign names to the URLs and these are then specified + in the checksums using the following form: + + SRC_URI[name.sha256sum] +
-
+
Local file fetcher @@ -103,7 +110,7 @@ MIRRORS =+ "\
-
+
CVS fetcher @@ -145,16 +152,16 @@ MIRRORS =+ "\
-
+
HTTP/FTP fetcher - The URNs for the HTTP/FTP fetcher are http, https and ftp. + The URNs for the HTTP/FTP fetcher are http, https, and ftp. This fetcher honors the variables FETCHCOMMAND_wget. FETCHCOMMAND contains the command used for fetching. - ${URI} and ${FILES} will be replaced by the URI and + “${URI}” and “${FILES}” will be replaced by the URI and basename of the file to be fetched. SRC_URI = "http://oe.handhelds.org/not_there.aac" @@ -164,8 +171,9 @@ MIRRORS =+ "\
-
- SVN fetcher +
+ SVN Fetcher + The URN for the SVN fetcher is svn. @@ -174,7 +182,7 @@ MIRRORS =+ "\ This fetcher honors the variables FETCHCOMMAND_svn, SVNDIR, - SRCREV. + and SRCREV. FETCHCOMMAND contains the subversion command. SRCREV specifies which revision @@ -185,8 +193,8 @@ MIRRORS =+ "\ The supported parameters are proto, rev and scmdata. proto is the Subversion protocol, rev is the Subversion revision. - If scmdata is set to keep, the .svn directories will - be available during compile-time. + If scmdata is set to “keep”, the “.svn” directories will + be available during compile-time. 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" @@ -194,23 +202,24 @@ MIRRORS =+ "\
-
- GIT fetcher +
+ GIT Fetcher + The URN for the GIT Fetcher is git. The variable GITDIR will be used as the - base directory where the git tree is cloned to. + base directory where the Git tree is cloned to. - The parameters are tag, protocol and scmdata. - tag is a Git tag, the default is master. - protocol is the Git protocol to use and defaults to git - if a hostname is set, otherwise its file. - If scmdata is set to keep, the .git directory will be available + The parameters are tag, protocol, and scmdata. + The tag parameter is a Git tag, the default is “master”. + The protocol tag is the Git protocol to use and defaults to “git” + if a hostname is set, otherwise it is “file”. + If scmdata is set to “keep”, the “.git” directory will be available during compile-time. SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1"