summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/SCCS.xml
blob: f621d7aab68e5978ecb8159ace8cef63a088e670 (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
85
86
87
88
89
90
91
92
93
94
<!--
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 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="SCCS">
<summary>
Sets construction variables for interacting with the
Source Code Control System.
</summary>
<sets>
SCCS
SCCSFLAGS
SCCSGETFLAGS
SCCSCOM
</sets>
<uses>
SCCSCOMSTR
</uses>
</tool>

<cvar name="SCCS">
<summary>
The SCCS executable.
</summary>
</cvar>

<cvar name="SCCSCOM">
<summary>
The command line used to
fetch source files from SCCS.
</summary>
</cvar>

<cvar name="SCCSCOMSTR">
<summary>
The string displayed when fetching
a source file from a CVS repository.
If this is not set, then &cv-link-SCCSCOM;
(the command line) is displayed.
</summary>
</cvar>

<cvar name="SCCSFLAGS">
<summary>
General options that are passed to SCCS.
</summary>
</cvar>

<cvar name="SCCSGETFLAGS">
<summary>
Options that are passed specifically to the SCCS "get" subcommand.
This can be set, for example, to
<option>-e</option>
to check out editable files from SCCS.
</summary>
</cvar>

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

Example:

<example>
env.SourceCode('.', env.SCCS())
</example>

Note that
&scons;
will fetch source files
from SCCS subdirectories automatically,
so configuring SCCS
as demonstrated in the above example
should only be necessary if
you are fetching from
<filename>s.SCCS</filename>
files in the same
directory as the source files,
or if you need to explicitly specify SCCS
for a specific subdirectory.
</summary>
</scons_function>