summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-02-20 10:30:58 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-03-01 15:46:59 +0000
commit7abb5b72060007caffbbfb8ee3c5c13f3edfc576 (patch)
treea95cae3977378def1af9cb8eee160eb45f9fbc09 /bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
parentbcfb0da4fec6809de585410c7b3e1b23689457a4 (diff)
downloadpoky-7abb5b72060007caffbbfb8ee3c5c13f3edfc576.tar.gz
bitbake: bitbake-user-manual: Added "path_spec" parameter to SVN Fetcher
Fixes [YOCTO #10405] The section on the SVN Fetcher was missing information on the "path_spec" option. I added this option and also updated the examples at the bottom of the section to include that parameter. Also, made the other two examples consistent. I also removed the "date" parameter. Also, updated the "protocol" parameter as well as the "modify" parameter. For "modify" I removed the reference to "rsh". I applied a small wording change to the "protocol" parameter. Finally, I added a new "ssh" parameter. (Bitbake rev: 3ce6169afa646ef2b847e5fbabfe0191c93928b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml30
1 files changed, 18 insertions, 12 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
index 6e1642c677..3f1d8eb521 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
@@ -385,7 +385,8 @@
385 The supported parameters are as follows: 385 The supported parameters are as follows:
386 <itemizedlist> 386 <itemizedlist>
387 <listitem><para><emphasis>"method":</emphasis> 387 <listitem><para><emphasis>"method":</emphasis>
388 The protocol over which to communicate with the CVS server. 388 The protocol over which to communicate with the CVS
389 server.
389 By default, this protocol is "pserver". 390 By default, this protocol is "pserver".
390 If "method" is set to "ext", BitBake examines the 391 If "method" is set to "ext", BitBake examines the
391 "rsh" parameter and sets <filename>CVS_RSH</filename>. 392 "rsh" parameter and sets <filename>CVS_RSH</filename>.
@@ -469,25 +470,29 @@
469 You can think of this parameter as the top-level 470 You can think of this parameter as the top-level
470 directory of the repository data you want. 471 directory of the repository data you want.
471 </para></listitem> 472 </para></listitem>
473 <listitem><para><emphasis>"path_spec":</emphasis>
474 A specific directory in which to checkout the
475 specified svn module.
476 </para></listitem>
472 <listitem><para><emphasis>"protocol":</emphasis> 477 <listitem><para><emphasis>"protocol":</emphasis>
473 The protocol to use, which defaults to "svn". 478 The protocol to use, which defaults to "svn".
474 Other options are "svn+ssh" and "rsh". 479 If "protocol" is set to "svn+ssh", the "ssh"
475 For "rsh", the "rsh" parameter is also used. 480 parameter is also used.
476 </para></listitem> 481 </para></listitem>
477 <listitem><para><emphasis>"rev":</emphasis> 482 <listitem><para><emphasis>"rev":</emphasis>
478 The revision of the source code to checkout. 483 The revision of the source code to checkout.
479 </para></listitem> 484 </para></listitem>
480 <listitem><para><emphasis>"date":</emphasis>
481 The date of the source code to checkout.
482 Specific revisions are generally much safer to checkout
483 rather than by date as they do not involve timezones
484 (e.g. they are much more deterministic).
485 </para></listitem>
486 <listitem><para><emphasis>"scmdata":</emphasis> 485 <listitem><para><emphasis>"scmdata":</emphasis>
487 Causes the “.svn” directories to be available during 486 Causes the “.svn” directories to be available during
488 compile-time when set to "keep". 487 compile-time when set to "keep".
489 By default, these directories are removed. 488 By default, these directories are removed.
490 </para></listitem> 489 </para></listitem>
490 <listitem><para><emphasis>"ssh":</emphasis>
491 An optional parameter used when "protocol" is set
492 to "svn+ssh".
493 You can use this parameter to specify the ssh
494 program used by svn.
495 </para></listitem>
491 <listitem><para><emphasis>"transportuser":</emphasis> 496 <listitem><para><emphasis>"transportuser":</emphasis>
492 When required, sets the username for the transport. 497 When required, sets the username for the transport.
493 By default, this parameter is empty. 498 By default, this parameter is empty.
@@ -496,10 +501,11 @@
496 command. 501 command.
497 </para></listitem> 502 </para></listitem>
498 </itemizedlist> 503 </itemizedlist>
499 Following are two examples using svn: 504 Following are three examples using svn:
500 <literallayout class='monospaced'> 505 <literallayout class='monospaced'>
501 SRC_URI = "svn://svn.oe.handhelds.org/svn;module=vip;proto=http;rev=667" 506 SRC_URI = "svn://myrepos/proj1;module=vip;protocol=http;rev=667"
502 SRC_URI = "svn://svn.oe.handhelds.org/svn/;module=opie;proto=svn+ssh;date=20060126" 507 SRC_URI = "svn://myrepos/proj1;module=opie;protocol=svn+ssh"
508 SRC_URI = "svn://myrepos/proj1;module=trunk;protocol=http;path_spec=${MY_DIR}/proj1"
503 </literallayout> 509 </literallayout>
504 </para> 510 </para>
505 </section> 511 </section>