summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
Diffstat (limited to 'bitbake/doc')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml81
1 files changed, 81 insertions, 0 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 6491c5f120..30f7c141d1 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
@@ -608,6 +608,87 @@
608 </para> 608 </para>
609 </section> 609 </section>
610 610
611 <section id='clearcase-fetcher'>
612 <title>Git Submodule Fetcher (<filename>gitsm://</filename>)</title>
613
614 <para>
615 This fetcher submodule fetches code from a
616 <ulink url='http://en.wikipedia.org/wiki/Rational_ClearCase'>ClearCase</ulink>
617 repository.
618 </para>
619
620 <para>
621 To use this fetcher, make sure your recipe has proper
622 <ulink url='var-SRC_URI'><filename>SRC_URI</filename></ulink>,
623 <ulink url='var-SRCREV'><filename>SRCREV</filename></ulink>, and
624 <ulink url='var-PV'><filename>PV</filename></ulink> settings.
625 Here is an example:
626 <literallayout class='monospaced'>
627 SRC_URI = "ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module"
628 SRCREV = "EXAMPLE_CLEARCASE_TAG"
629 PV = "${@d.getVar("SRCREV").replace("/", "+")}"
630 </literallayout>
631 The fetcher uses the <filename>rcleartool</filename> or
632 <filename>cleartool</filename> remote client, depending on
633 which one is available.
634 </para>
635
636 <para>
637 Following are options for the <filename>SRC_URI</filename>
638 statement:
639 <itemizedlist>
640 <listitem><para><emphasis><filename>vob</filename></emphasis>:
641 The name, which must include the
642 prepending "/" character, of the ClearCase VOB.
643 This option is required.
644 </para></listitem>
645 <listitem><para><emphasis><filename>module</filename></emphasis>:
646 The module, which must include the
647 prepending "/" character, in the selected VOB
648 The <filename>module</filename> and <filename>vob</filename>
649 options are combined to create the following load rule in
650 the view config spec:
651 <literallayout class='monospaced'>
652 load &lt;vob&gt;&lt;module&gt;
653 </literallayout>
654 </para></listitem>
655 <listitem><para><emphasis><filename>proto</filename></emphasis>:
656 The protocol, which can be either <filename>http</filename> or
657 <filename>https</filename>.
658 </para></listitem>
659 </itemizedlist>
660 </para>
661
662 <para>
663 By default, the fetcher creates a configuration specification.
664 If you want this specification written to an area other than the default,
665 use the <filename>CCASE_CUSTOM_CONFIG_SPEC</filename> variable
666 in your recipe to define where the specification is written.
667 <note>
668 the <filename>SRCREV</filename> loses its functionality if you
669 specify this variable.
670 However, <filename>SRCREV</filename> is still used to label the
671 archive after a fetch even though it does not define what is
672 fetched.
673 </note>
674 </para>
675
676 <para>
677 Here are a couple of other behaviors worth mentioning:
678 <itemizedlist>
679 <listitem><para>
680 When using <filename>cleartool</filename>, the login of
681 <filename>cleartool</filename> is handled by the system.
682 The login require no special steps.
683 </para></listitem>
684 <listitem><para>
685 In order to use <filename>rcleartool</filename> with authenticated
686 users, an "rcleartool login" is necessary before using the fetcher.
687 </para></listitem>
688 </itemizedlist>
689 </para>
690 </section>
691
611 <section id='other-fetchers'> 692 <section id='other-fetchers'>
612 <title>Other Fetchers</title> 693 <title>Other Fetchers</title>
613 694