mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-03-17 20:59:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

bitbake: user-manual-fetching: Change varname/emphasis tags to filename

Browse Source 
(Bitbake rev: 3b04c18212f3f0c22a1167dc6f62210e54ed2002)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Richard Purdie
2014-01-18 15:21:33 +00:00
parent 0de491b766
commit 123b978c82
1 changed files with 50 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
bitbake/doc/user-manual/user-manual-fetching.xml
View File

@@ -17,7 +17,7 @@
</para>
<para>
The SRC_URI is normally used to
The <filename>SRC_URI</filename> 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 @@
<para>
The overall fetch process is that first, fetches are attempted from
PREMIRRORS.
If those don't work, the original SRC_URI
<filename>PREMIRRORS</filename>.
If those don't work, the original <filename>SRC_URI</filename>
is attempted
and if that fails, BitBake will fall back to
MIRRORS.
<filename>MIRRORS</filename>.
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 =+ "\
<para>
Non-local downloaded output is placed
into the directory specified by the
<varname>DL_DIR</varname>.
<filename>DL_DIR</filename> 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
<varname>SRC_URI[md5sum]</varname>
<filename>SRC_URI[md5sum]</filename>
for the md5 checksum and
<varname>SRC_URI[sha256sum]</varname>
<filename>SRC_URI[sha256sum]</filename>
for the sha256 checksum or as parameters on the SRC_URI such as
SRC_URI="http://example.com/foobar.tar.bz2;md5sum=4a8e0f237e961fd7785d19d07fdb994d".
If <varname>BB_STRICT_CHECKSUM</varname> is set, any download
If <filename>BB_STRICT_CHECKSUM</filename> 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 =+ "\
<title>Local file fetcher</title>
<para>
The URN for the local file fetcher is <emphasis>file</emphasis>.
The URN for the local file fetcher is file.
The filename can be either absolute or relative.
If the filename is relative,
<varname>FILESPATH</varname> and failing that
<varname>FILESDIR</varname> will be used to find the
<filename>FILESPATH</filename> and failing that
<filename>FILESDIR</filename> will be used to find the
appropriate relative file.
The metadata usually extend these variables to include
variations of the values in <varname>OVERRIDES</varname>.
variations of the values in <filename>OVERRIDES</filename>.
Single files and complete directories can be specified.
<literallayout class='monospaced'>
SRC_URI = "file://relativefile.patch"
@@ -107,37 +107,37 @@ MIRRORS =+ "\
<title>CVS fetcher</title>
<para>
The URN for the CVS fetcher is <emphasis>cvs</emphasis>.
This fetcher honors the variables <varname>CVSDIR</varname>,
<varname>SRCDATE</varname>, <varname>FETCHCOMMAND_cvs</varname>,
<varname>UPDATECOMMAND_cvs</varname>.
<varname>DL_DIR</varname> specifies where a
The URN for the CVS fetcher is cvs.
This fetcher honors the variables <filename>CVSDIR</filename>,
<filename>SRCDATE</filename>, <filename>FETCHCOMMAND_cvs</filename>,
<filename>UPDATECOMMAND_cvs</filename>.
<filename>DL_DIR</filename> specifies where a
temporary checkout is saved.
<varname>SRCDATE</varname> specifies which date to
<filename>SRCDATE</filename> specifies which date to
use when doing the fetching (the special value of "now"
will cause the checkout to be updated on every build).
<varname>FETCHCOMMAND</varname> and
<varname>UPDATECOMMAND</varname> specify which executables
<filename>FETCHCOMMAND</filename> and
<filename>UPDATECOMMAND</filename> specify which executables
to use for the CVS checkout or update.
</para>
<para>
The supported parameters are <varname>module</varname>, <varname>tag</varname>, <varname>date</varname>,
<varname>method</varname>, <varname>localdir</varname>, <varname>rsh</varname> and <varname>scmdata</varname>.
The <varname>module</varname> specifies which module to check out,
the <varname>tag</varname> 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 <varname>date</varname> can be specified to override the
SRCDATE of the
By default, the TAG is empty.
A date can be specified to override the
<filename>SRCDATE</filename> of the
configuration to checkout a specific date.
The special value of "now" will cause the checkout to be
updated on every build.
<varname>method</varname> is by default <emphasis>pserver</emphasis>.
If <emphasis>ext</emphasis> is used the <varname>rsh</varname> parameter will be evaluated
and <varname>CVS_RSH</varname> will be set.
Finally, <varname>localdir</varname> is used to checkout into a special
directory relative to <varname>CVSDIR</varname>.
method is by default pserver.
If ext is used the rsh parameter will be evaluated
and <filename>CVS_RSH</filename> will be set.
Finally, localdir is used to checkout into a special
directory relative to <filename>CVSDIR</filename>.
<literallayout class='monospaced'>
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 =+ "\
<title>HTTP/FTP fetcher</title>
<para>
The URNs for the HTTP/FTP fetcher are <emphasis>http</emphasis>, <emphasis>https</emphasis> and <emphasis>ftp</emphasis>.
The URNs for the HTTP/FTP fetcher are http, https and ftp.
This fetcher honors the variables
<varname>FETCHCOMMAND_wget</varname>.
<varname>FETCHCOMMAND</varname> contains the command used
<filename>FETCHCOMMAND_wget</filename>.
<filename>FETCHCOMMAND</filename> contains the command used
for fetching.
<quote>${URI}</quote> and <quote>${FILES}</quote> will be replaced by the URI and
basename of the file to be fetched.
@@ -167,25 +167,25 @@ MIRRORS =+ "\
<section>
<title>SVN fetcher</title>
<para>
The URN for the SVN fetcher is <emphasis>svn</emphasis>.
The URN for the SVN fetcher is svn.
</para>
<para>
This fetcher honors the variables
<varname>FETCHCOMMAND_svn</varname>,
<varname>SVNDIR</varname>,
<varname>SRCREV</varname>.
<varname>FETCHCOMMAND</varname> contains the
<filename>FETCHCOMMAND_svn</filename>,
<filename>SVNDIR</filename>,
<filename>SRCREV</filename>.
<filename>FETCHCOMMAND</filename> contains the
subversion command.
<varname>SRCREV</varname> specifies which revision
<filename>SRCREV</filename> specifies which revision
to use when doing the fetching.
</para>
<para>
The supported parameters are <varname>proto</varname>, <varname>rev</varname> and <varname>scmdata</varname>.
<varname>proto</varname> is the Subversion protocol, <varname>rev</varname> is the
The supported parameters are proto, rev and scmdata.
proto is the Subversion protocol, rev is the
Subversion revision.
If <varname>scmdata</varname> is set to <quote>keep</quote>, the <quote>.svn</quote> directories will
If scmdata is set to <quote>keep</quote>, the <quote>.svn</quote> directories will
be available during compile-time.
<literallayout class='monospaced'>
SRC_URI = "svn://svn.oe.handhelds.org/svn;module=vip;proto=http;rev=667"
@@ -197,20 +197,20 @@ MIRRORS =+ "\
<section>
<title>GIT fetcher</title>
<para>
The URN for the GIT Fetcher is <emphasis>git</emphasis>.
The URN for the GIT Fetcher is git.
</para>
<para>
The variable <varname>GITDIR</varname> will be used as the
The variable <filename>GITDIR</filename> will be used as the
base directory where the git tree is cloned to.
</para>
<para>
The parameters are <emphasis>tag</emphasis>, <emphasis>protocol</emphasis> and <emphasis>scmdata</emphasis>.
<emphasis>tag</emphasis> is a Git tag, the default is <quote>master</quote>.
<emphasis>protocol</emphasis> is the Git protocol to use and defaults to <quote>git</quote>
The parameters are tag, protocol and scmdata.
tag is a Git tag, the default is <quote>master</quote>.
protocol is the Git protocol to use and defaults to <quote>git</quote>
if a hostname is set, otherwise its <quote>file</quote>.
If <emphasis>scmdata</emphasis> is set to <quote>keep</quote>, the <quote>.git</quote> directory will be available
If scmdata is set to <quote>keep</quote>, the <quote>.git</quote> directory will be available
during compile-time.
<literallayout class='monospaced'>
SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1"