aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJuro Bystricky <juro.bystricky@intel.com>2015-07-29 11:09:41 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-08-01 11:30:53 +0100
commitd8953c16c52c6e5de879f4a32ec8aeee396bb410 (patch)
tree1358fbe627c2375cbc33a0fde333b66fa40ef251 /doc
parent3ac0ba73790b8f68567daa2de313c78053411fbb (diff)
downloadbitbake-contrib-d8953c16c52c6e5de879f4a32ec8aeee396bb410.tar.gz
bitbake-user-manual-fetching.xml: note about URLs with semi-colons
Some URLs contain semi-colons. Unfortunatelly, bitbake uses semi-colons in SRC_URI as delimiters for various parameters. It may still be possible to use such URLs, providing the user replaces semi-colons ';' with '&' characters. For example: http://abc123.com/git/?p=gcc/gcc.git;a=snapshot;h=a5dd47 and http://abc123.com/git/?p=gcc/gcc.git&a=snapshot&h=a5dd47 should be equivalent, as W3C recommends treating ';' in queries identically to '&'. See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.2.2 Kudos to Olof Johansson Signed-off-by: Juro Bystricky <juro.bystricky@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-fetching.xml19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml b/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
index b37b2ae42..f168cfa68 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
@@ -325,6 +325,25 @@
SRC_URI = "ftp://you@oe.handhelds.org/home/you/secret.plan"
</literallayout>
</para>
+ <note>
+ Because URL parameters are delimited by semi-colons, this can
+ introduce ambiguity when parsing URLs that also contain semi-colons,
+ for example:
+ <literallayout class='monospaced'>
+ SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git;a=snapshot;h=a5dd47"
+ </literallayout>
+ Such URLs should should be modified by replacing semi-colons with '&amp;' characters:
+ <literallayout class='monospaced'>
+ SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git&amp;a=snapshot&amp;h=a5dd47"
+ </literallayout>
+ In most cases this should work. Treating semi-colons and '&amp;' in queries
+ identically is recommended by the World Wide Web Consortium (W3C).
+ Note that due to the nature of the URL, you may have to specify the name
+ of the downloaded file as well:
+ <literallayout class='monospaced'>
+ SRC_URI = "http://abc123.org/git/?p=gcc/gcc.git&amp;a=snapshot&amp;h=a5dd47;downloadfilename=myfile.bz2"
+ </literallayout>
+ </note>
</section>
<section id='cvs-fetcher'>