summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/BitKeeper.xml
blob: 3ca8e2235d68d0bc07377e397498dc972a561b54 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
<!--
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 The SCons Foundation

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>