Source

SCons / src / engine / SCons / Tool / BitKeeper.xml

<!--
__COPYRIGHT__

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
<tool name="BitKeeper">
<summary>
Sets construction variables for the BitKeeper
source code control system.
</summary>
<sets>
BITKEEPER
BITKEEPERGET
BITKEEPERGETFLAGS
BITKEEPERCOM
</sets>
<uses>
BITKEEPERCOMSTR
</uses>
</tool>

<cvar name="BITKEEPER">
<summary>
The BitKeeper executable.
</summary>
</cvar>

<cvar name="BITKEEPERCOM">
<summary>
The command line for
fetching source files using BitKeeper.
</summary>
</cvar>

<cvar name="BITKEEPERCOMSTR">
<summary>
The string displayed when fetching
a source file using BitKeeper.
If this is not set, then &cv-link-BITKEEPERCOM;
(the command line) is displayed.
</summary>
</cvar>

<cvar name="BITKEEPERGET">
<summary>
The command (&cv-link-BITKEEPER;) and subcommand
for fetching source files using BitKeeper.
</summary>
</cvar>

<cvar name="BITKEEPERGETFLAGS">
<summary>
Options that are passed to the BitKeeper
<command>get</command>
subcommand.
</summary>
</cvar>

<scons_function name="BitKeeper">
<arguments signature="env">
()
</arguments>
<summary>
A factory function that
returns a Builder object
to be used to fetch source files
using BitKeeper.
The returned Builder
is intended to be passed to the
&f-SourceCode;
function.

This function is deprecated.  For details, see the entry for the
&f-SourceCode;
function.

Example:

<example>
env.SourceCode('.', env.BitKeeper())
</example>
</summary>
</scons_function>