From ad23b170c7ded132154bf073c3cc12130e3db603 Mon Sep 17 00:00:00 2001 From: Richard Purdie Date: Sat, 18 Jan 2014 15:21:33 +0000 Subject: [PATCH] bitbake: user-manual-fetching: Change varname/emphasis tags to filename (Bitbake rev: 3b04c18212f3f0c22a1167dc6f62210e54ed2002) Signed-off-by: Richard Purdie --- bitbake/doc/user-manual/user-manual-fetching.xml | 100 +++++++++++------------ 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/bitbake/doc/user-manual/user-manual-fetching.xml b/bitbake/doc/user-manual/user-manual-fetching.xml index 18c0214..1ff8acb 100644 --- a/bitbake/doc/user-manual/user-manual-fetching.xml +++ b/bitbake/doc/user-manual/user-manual-fetching.xml @@ -17,7 +17,7 @@ - The SRC_URI is normally used to + The SRC_URI is normally used to tell BitBake which files to fetch. The next sections will describe the available fetchers and their options. @@ -32,11 +32,11 @@ The overall fetch process is that first, fetches are attempted from - PREMIRRORS. - If those don't work, the original SRC_URI + PREMIRRORS. + If those don't work, the original SRC_URI is attempted and if that fails, BitBake will fall back to - MIRRORS. + 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 @@ -62,17 +62,17 @@ MIRRORS =+ "\ Non-local downloaded output is placed into the directory specified by the - DL_DIR. + DL_DIR variable. 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] + SRC_URI[md5sum] for the md5 checksum and - SRC_URI[sha256sum] + 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". - If BB_STRICT_CHECKSUM is set, any download + 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 @@ -86,14 +86,14 @@ MIRRORS =+ "\ Local file fetcher - The URN for the local file fetcher is file. + The URN for the local file fetcher is file. The filename can be either absolute or relative. If the filename is relative, - FILESPATH and failing that - FILESDIR will be used to find the + FILESPATH and failing that + FILESDIR will be used to find the appropriate relative file. The metadata usually extend these variables to include - variations of the values in OVERRIDES. + variations of the values in OVERRIDES. Single files and complete directories can be specified. SRC_URI = "file://relativefile.patch" @@ -107,37 +107,37 @@ MIRRORS =+ "\ CVS fetcher - The URN for the CVS fetcher is cvs. - This fetcher honors the variables CVSDIR, - SRCDATE, FETCHCOMMAND_cvs, - UPDATECOMMAND_cvs. - DL_DIR specifies where a + The URN for the CVS fetcher is cvs. + This fetcher honors the variables CVSDIR, + SRCDATE, FETCHCOMMAND_cvs, + UPDATECOMMAND_cvs. + DL_DIR specifies where a temporary checkout is saved. - SRCDATE specifies which date to + SRCDATE specifies which date to use when doing the fetching (the special value of "now" will cause the checkout to be updated on every build). - FETCHCOMMAND and - UPDATECOMMAND specify which executables + FETCHCOMMAND and + UPDATECOMMAND specify which executables to use for the CVS checkout or update. - The supported parameters are module, tag, date, - method, localdir, rsh and scmdata. - The module specifies which module to check out, - the tag describes which CVS TAG should be used for + The supported parameters are module, tag, date, + method, localdir, rshand scmdata. + 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 + By default, the TAG is empty. + A date can be specified to override the + SRCDATE of the configuration to checkout a specific date. The special value of "now" will cause the checkout to be updated on every build. - 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. + 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" @@ -149,10 +149,10 @@ 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 + FETCHCOMMAND_wget. + FETCHCOMMAND contains the command used for fetching. ${URI} and ${FILES} will be replaced by the URI and basename of the file to be fetched. @@ -167,25 +167,25 @@ MIRRORS =+ "\
SVN fetcher - The URN for the SVN fetcher is svn. + The URN for the SVN fetcher is svn. This fetcher honors the variables - FETCHCOMMAND_svn, - SVNDIR, - SRCREV. - FETCHCOMMAND contains the + FETCHCOMMAND_svn, + SVNDIR, + SRCREV. + FETCHCOMMAND contains the subversion command. - SRCREV specifies which revision + SRCREV specifies which revision to use when doing the fetching. - The supported parameters are proto, rev and scmdata. - proto is the Subversion protocol, rev is the + 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 + 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" @@ -197,20 +197,20 @@ MIRRORS =+ "\
GIT fetcher - The URN for the GIT Fetcher is git. + The URN for the GIT Fetcher is git. - The variable GITDIR will be used as the + The variable GITDIR will be used as the 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 + 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 + 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" -- 2.7.4