diff options
author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-01-18 15:21:33 +0000 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-01-27 21:03:23 +0000 |
commit | 123b978c8278ca917cff9a6f85fdd65a1d58c414 (patch) | |
tree | ec364242000155e5f55ab4e4788bb2076da5b9e1 | |
parent | 0de491b766ffb49543392a43f004fbe5dff2540b (diff) | |
download | poky-123b978c8278ca917cff9a6f85fdd65a1d58c414.tar.gz |
bitbake: user-manual-fetching: Change varname/emphasis tags to filename
(Bitbake rev: 3b04c18212f3f0c22a1167dc6f62210e54ed2002)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | bitbake/doc/user-manual/user-manual-fetching.xml | 100 |
1 files 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 18c0214c02..1ff8acb4e0 100644 --- a/bitbake/doc/user-manual/user-manual-fetching.xml +++ b/bitbake/doc/user-manual/user-manual-fetching.xml | |||
@@ -17,7 +17,7 @@ | |||
17 | </para> | 17 | </para> |
18 | 18 | ||
19 | <para> | 19 | <para> |
20 | The SRC_URI is normally used to | 20 | The <filename>SRC_URI</filename> is normally used to |
21 | tell BitBake which files to fetch. | 21 | tell BitBake which files to fetch. |
22 | The next sections will describe the available fetchers and | 22 | The next sections will describe the available fetchers and |
23 | their options. | 23 | their options. |
@@ -32,11 +32,11 @@ | |||
32 | 32 | ||
33 | <para> | 33 | <para> |
34 | The overall fetch process is that first, fetches are attempted from | 34 | The overall fetch process is that first, fetches are attempted from |
35 | PREMIRRORS. | 35 | <filename>PREMIRRORS</filename>. |
36 | If those don't work, the original SRC_URI | 36 | If those don't work, the original <filename>SRC_URI</filename> |
37 | is attempted | 37 | is attempted |
38 | and if that fails, BitBake will fall back to | 38 | and if that fails, BitBake will fall back to |
39 | MIRRORS. | 39 | <filename>MIRRORS</filename>. |
40 | Cross urls are supported, so its possible to mirror | 40 | Cross urls are supported, so its possible to mirror |
41 | a git repository on an http server as a tarball for example. | 41 | a git repository on an http server as a tarball for example. |
42 | Some example commonly used mirror | 42 | Some example commonly used mirror |
@@ -62,17 +62,17 @@ MIRRORS =+ "\ | |||
62 | <para> | 62 | <para> |
63 | Non-local downloaded output is placed | 63 | Non-local downloaded output is placed |
64 | into the directory specified by the | 64 | into the directory specified by the |
65 | <varname>DL_DIR</varname>. | 65 | <filename>DL_DIR</filename> variable. |
66 | For non local archive downloads the code can verify | 66 | For non local archive downloads the code can verify |
67 | sha256 and md5 checksums for the download to ensure | 67 | sha256 and md5 checksums for the download to ensure |
68 | the file has been downloaded correctly. | 68 | the file has been downloaded correctly. |
69 | These may be specified either in the form | 69 | These may be specified either in the form |
70 | <varname>SRC_URI[md5sum]</varname> | 70 | <filename>SRC_URI[md5sum]</filename> |
71 | for the md5 checksum and | 71 | for the md5 checksum and |
72 | <varname>SRC_URI[sha256sum]</varname> | 72 | <filename>SRC_URI[sha256sum]</filename> |
73 | for the sha256 checksum or as parameters on the SRC_URI such as | 73 | for the sha256 checksum or as parameters on the SRC_URI such as |
74 | SRC_URI="http://example.com/foobar.tar.bz2;md5sum=4a8e0f237e961fd7785d19d07fdb994d". | 74 | SRC_URI="http://example.com/foobar.tar.bz2;md5sum=4a8e0f237e961fd7785d19d07fdb994d". |
75 | If <varname>BB_STRICT_CHECKSUM</varname> is set, any download | 75 | If <filename>BB_STRICT_CHECKSUM</filename> is set, any download |
76 | without a checksum will trigger an error message. | 76 | without a checksum will trigger an error message. |
77 | In cases where multiple files are listed in | 77 | In cases where multiple files are listed in |
78 | SRC_URI, the name parameter is used | 78 | SRC_URI, the name parameter is used |
@@ -86,14 +86,14 @@ MIRRORS =+ "\ | |||
86 | <title>Local file fetcher</title> | 86 | <title>Local file fetcher</title> |
87 | 87 | ||
88 | <para> | 88 | <para> |
89 | The URN for the local file fetcher is <emphasis>file</emphasis>. | 89 | The URN for the local file fetcher is file. |
90 | The filename can be either absolute or relative. | 90 | The filename can be either absolute or relative. |
91 | If the filename is relative, | 91 | If the filename is relative, |
92 | <varname>FILESPATH</varname> and failing that | 92 | <filename>FILESPATH</filename> and failing that |
93 | <varname>FILESDIR</varname> will be used to find the | 93 | <filename>FILESDIR</filename> will be used to find the |
94 | appropriate relative file. | 94 | appropriate relative file. |
95 | The metadata usually extend these variables to include | 95 | The metadata usually extend these variables to include |
96 | variations of the values in <varname>OVERRIDES</varname>. | 96 | variations of the values in <filename>OVERRIDES</filename>. |
97 | Single files and complete directories can be specified. | 97 | Single files and complete directories can be specified. |
98 | <literallayout class='monospaced'> | 98 | <literallayout class='monospaced'> |
99 | SRC_URI = "file://relativefile.patch" | 99 | SRC_URI = "file://relativefile.patch" |
@@ -107,37 +107,37 @@ MIRRORS =+ "\ | |||
107 | <title>CVS fetcher</title> | 107 | <title>CVS fetcher</title> |
108 | 108 | ||
109 | <para> | 109 | <para> |
110 | The URN for the CVS fetcher is <emphasis>cvs</emphasis>. | 110 | The URN for the CVS fetcher is cvs. |
111 | This fetcher honors the variables <varname>CVSDIR</varname>, | 111 | This fetcher honors the variables <filename>CVSDIR</filename>, |
112 | <varname>SRCDATE</varname>, <varname>FETCHCOMMAND_cvs</varname>, | 112 | <filename>SRCDATE</filename>, <filename>FETCHCOMMAND_cvs</filename>, |
113 | <varname>UPDATECOMMAND_cvs</varname>. | 113 | <filename>UPDATECOMMAND_cvs</filename>. |
114 | <varname>DL_DIR</varname> specifies where a | 114 | <filename>DL_DIR</filename> specifies where a |
115 | temporary checkout is saved. | 115 | temporary checkout is saved. |
116 | <varname>SRCDATE</varname> specifies which date to | 116 | <filename>SRCDATE</filename> specifies which date to |
117 | use when doing the fetching (the special value of "now" | 117 | use when doing the fetching (the special value of "now" |
118 | will cause the checkout to be updated on every build). | 118 | will cause the checkout to be updated on every build). |
119 | <varname>FETCHCOMMAND</varname> and | 119 | <filename>FETCHCOMMAND</filename> and |
120 | <varname>UPDATECOMMAND</varname> specify which executables | 120 | <filename>UPDATECOMMAND</filename> specify which executables |
121 | to use for the CVS checkout or update. | 121 | to use for the CVS checkout or update. |
122 | </para> | 122 | </para> |
123 | 123 | ||
124 | <para> | 124 | <para> |
125 | The supported parameters are <varname>module</varname>, <varname>tag</varname>, <varname>date</varname>, | 125 | The supported parameters are module, tag, date, |
126 | <varname>method</varname>, <varname>localdir</varname>, <varname>rsh</varname> and <varname>scmdata</varname>. | 126 | method, localdir, rshand scmdata. |
127 | The <varname>module</varname> specifies which module to check out, | 127 | The module specifies which module to check out, |
128 | the <varname>tag</varname> describes which CVS TAG should be used for | 128 | the tag describes which CVS TAG should be used for |
129 | the checkout. | 129 | the checkout. |
130 | By default the TAG is empty. | 130 | By default, the TAG is empty. |
131 | A <varname>date</varname> can be specified to override the | 131 | A date can be specified to override the |
132 | SRCDATE of the | 132 | <filename>SRCDATE</filename> of the |
133 | configuration to checkout a specific date. | 133 | configuration to checkout a specific date. |
134 | The special value of "now" will cause the checkout to be | 134 | The special value of "now" will cause the checkout to be |
135 | updated on every build. | 135 | updated on every build. |
136 | <varname>method</varname> is by default <emphasis>pserver</emphasis>. | 136 | method is by default pserver. |
137 | If <emphasis>ext</emphasis> is used the <varname>rsh</varname> parameter will be evaluated | 137 | If ext is used the rsh parameter will be evaluated |
138 | and <varname>CVS_RSH</varname> will be set. | 138 | and <filename>CVS_RSH</filename> will be set. |
139 | Finally, <varname>localdir</varname> is used to checkout into a special | 139 | Finally, localdir is used to checkout into a special |
140 | directory relative to <varname>CVSDIR</varname>. | 140 | directory relative to <filename>CVSDIR</filename>. |
141 | <literallayout class='monospaced'> | 141 | <literallayout class='monospaced'> |
142 | SRC_URI = "cvs://CVSROOT;module=mymodule;tag=some-version;method=ext" | 142 | SRC_URI = "cvs://CVSROOT;module=mymodule;tag=some-version;method=ext" |
143 | SRC_URI = "cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat" | 143 | SRC_URI = "cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat" |
@@ -149,10 +149,10 @@ MIRRORS =+ "\ | |||
149 | <title>HTTP/FTP fetcher</title> | 149 | <title>HTTP/FTP fetcher</title> |
150 | 150 | ||
151 | <para> | 151 | <para> |
152 | The URNs for the HTTP/FTP fetcher are <emphasis>http</emphasis>, <emphasis>https</emphasis> and <emphasis>ftp</emphasis>. | 152 | The URNs for the HTTP/FTP fetcher are http, https and ftp. |
153 | This fetcher honors the variables | 153 | This fetcher honors the variables |
154 | <varname>FETCHCOMMAND_wget</varname>. | 154 | <filename>FETCHCOMMAND_wget</filename>. |
155 | <varname>FETCHCOMMAND</varname> contains the command used | 155 | <filename>FETCHCOMMAND</filename> contains the command used |
156 | for fetching. | 156 | for fetching. |
157 | <quote>${URI}</quote> and <quote>${FILES}</quote> will be replaced by the URI and | 157 | <quote>${URI}</quote> and <quote>${FILES}</quote> will be replaced by the URI and |
158 | basename of the file to be fetched. | 158 | basename of the file to be fetched. |
@@ -167,25 +167,25 @@ MIRRORS =+ "\ | |||
167 | <section> | 167 | <section> |
168 | <title>SVN fetcher</title> | 168 | <title>SVN fetcher</title> |
169 | <para> | 169 | <para> |
170 | The URN for the SVN fetcher is <emphasis>svn</emphasis>. | 170 | The URN for the SVN fetcher is svn. |
171 | </para> | 171 | </para> |
172 | 172 | ||
173 | <para> | 173 | <para> |
174 | This fetcher honors the variables | 174 | This fetcher honors the variables |
175 | <varname>FETCHCOMMAND_svn</varname>, | 175 | <filename>FETCHCOMMAND_svn</filename>, |
176 | <varname>SVNDIR</varname>, | 176 | <filename>SVNDIR</filename>, |
177 | <varname>SRCREV</varname>. | 177 | <filename>SRCREV</filename>. |
178 | <varname>FETCHCOMMAND</varname> contains the | 178 | <filename>FETCHCOMMAND</filename> contains the |
179 | subversion command. | 179 | subversion command. |
180 | <varname>SRCREV</varname> specifies which revision | 180 | <filename>SRCREV</filename> specifies which revision |
181 | to use when doing the fetching. | 181 | to use when doing the fetching. |
182 | </para> | 182 | </para> |
183 | 183 | ||
184 | <para> | 184 | <para> |
185 | The supported parameters are <varname>proto</varname>, <varname>rev</varname> and <varname>scmdata</varname>. | 185 | The supported parameters are proto, rev and scmdata. |
186 | <varname>proto</varname> is the Subversion protocol, <varname>rev</varname> is the | 186 | proto is the Subversion protocol, rev is the |
187 | Subversion revision. | 187 | Subversion revision. |
188 | If <varname>scmdata</varname> is set to <quote>keep</quote>, the <quote>.svn</quote> directories will | 188 | If scmdata is set to <quote>keep</quote>, the <quote>.svn</quote> directories will |
189 | be available during compile-time. | 189 | be available during compile-time. |
190 | <literallayout class='monospaced'> | 190 | <literallayout class='monospaced'> |
191 | SRC_URI = "svn://svn.oe.handhelds.org/svn;module=vip;proto=http;rev=667" | 191 | SRC_URI = "svn://svn.oe.handhelds.org/svn;module=vip;proto=http;rev=667" |
@@ -197,20 +197,20 @@ MIRRORS =+ "\ | |||
197 | <section> | 197 | <section> |
198 | <title>GIT fetcher</title> | 198 | <title>GIT fetcher</title> |
199 | <para> | 199 | <para> |
200 | The URN for the GIT Fetcher is <emphasis>git</emphasis>. | 200 | The URN for the GIT Fetcher is git. |
201 | </para> | 201 | </para> |
202 | 202 | ||
203 | <para> | 203 | <para> |
204 | The variable <varname>GITDIR</varname> will be used as the | 204 | The variable <filename>GITDIR</filename> will be used as the |
205 | base directory where the git tree is cloned to. | 205 | base directory where the git tree is cloned to. |
206 | </para> | 206 | </para> |
207 | 207 | ||
208 | <para> | 208 | <para> |
209 | The parameters are <emphasis>tag</emphasis>, <emphasis>protocol</emphasis> and <emphasis>scmdata</emphasis>. | 209 | The parameters are tag, protocol and scmdata. |
210 | <emphasis>tag</emphasis> is a Git tag, the default is <quote>master</quote>. | 210 | tag is a Git tag, the default is <quote>master</quote>. |
211 | <emphasis>protocol</emphasis> is the Git protocol to use and defaults to <quote>git</quote> | 211 | protocol is the Git protocol to use and defaults to <quote>git</quote> |
212 | if a hostname is set, otherwise its <quote>file</quote>. | 212 | if a hostname is set, otherwise its <quote>file</quote>. |
213 | If <emphasis>scmdata</emphasis> is set to <quote>keep</quote>, the <quote>.git</quote> directory will be available | 213 | If scmdata is set to <quote>keep</quote>, the <quote>.git</quote> directory will be available |
214 | during compile-time. | 214 | during compile-time. |
215 | <literallayout class='monospaced'> | 215 | <literallayout class='monospaced'> |
216 | SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1" | 216 | SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1" |