diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-07-22 12:09:39 +0300 |
---|---|---|
committer | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-08-01 14:14:44 +0300 |
commit | dc669c4beda04ee88a50c9b48facfbd8cf17a331 (patch) | |
tree | e6f8e085cb3da604b5d3d10a9a09dfa4d50a32bf /doc | |
parent | 4aaf56bfbad4aa626be8a2f7a5f70834c3311dd3 (diff) | |
download | bitbake-contrib-dc669c4beda04ee88a50c9b48facfbd8cf17a331.tar.gz |
bitbake-user-manual-fetching.xml: Added new clearcase fetcher module.
Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/bitbake-user-manual/bitbake-user-manual-fetching.xml | 81 |
1 files changed, 81 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 6491c5f12..30f7c141d 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml +++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml @@ -608,6 +608,87 @@ </para> </section> + <section id='clearcase-fetcher'> + <title>Git Submodule Fetcher (<filename>gitsm://</filename>)</title> + + <para> + This fetcher submodule fetches code from a + <ulink url='http://en.wikipedia.org/wiki/Rational_ClearCase'>ClearCase</ulink> + repository. + </para> + + <para> + To use this fetcher, make sure your recipe has proper + <ulink url='var-SRC_URI'><filename>SRC_URI</filename></ulink>, + <ulink url='var-SRCREV'><filename>SRCREV</filename></ulink>, and + <ulink url='var-PV'><filename>PV</filename></ulink> settings. + Here is an example: + <literallayout class='monospaced'> + SRC_URI = "ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module" + SRCREV = "EXAMPLE_CLEARCASE_TAG" + PV = "${@d.getVar("SRCREV").replace("/", "+")}" + </literallayout> + The fetcher uses the <filename>rcleartool</filename> or + <filename>cleartool</filename> remote client, depending on + which one is available. + </para> + + <para> + Following are options for the <filename>SRC_URI</filename> + statement: + <itemizedlist> + <listitem><para><emphasis><filename>vob</filename></emphasis>: + The name, which must include the + prepending "/" character, of the ClearCase VOB. + This option is required. + </para></listitem> + <listitem><para><emphasis><filename>module</filename></emphasis>: + The module, which must include the + prepending "/" character, in the selected VOB + The <filename>module</filename> and <filename>vob</filename> + options are combined to create the following load rule in + the view config spec: + <literallayout class='monospaced'> + load <vob><module> + </literallayout> + </para></listitem> + <listitem><para><emphasis><filename>proto</filename></emphasis>: + The protocol, which can be either <filename>http</filename> or + <filename>https</filename>. + </para></listitem> + </itemizedlist> + </para> + + <para> + By default, the fetcher creates a configuration specification. + If you want this specification written to an area other than the default, + use the <filename>CCASE_CUSTOM_CONFIG_SPEC</filename> variable + in your recipe to define where the specification is written. + <note> + the <filename>SRCREV</filename> loses its functionality if you + specify this variable. + However, <filename>SRCREV</filename> is still used to label the + archive after a fetch even though it does not define what is + fetched. + </note> + </para> + + <para> + Here are a couple of other behaviors worth mentioning: + <itemizedlist> + <listitem><para> + When using <filename>cleartool</filename>, the login of + <filename>cleartool</filename> is handled by the system. + The login require no special steps. + </para></listitem> + <listitem><para> + In order to use <filename>rcleartool</filename> with authenticated + users, an "rcleartool login" is necessary before using the fetcher. + </para></listitem> + </itemizedlist> + </para> + </section> + <section id='other-fetchers'> <title>Other Fetchers</title> |