summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/Subversion.xml
blob: f0ec115b3aa7e905548d76f406dabed04b96ca95 (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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2001 - 2015 The SCons Foundation

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->

<!DOCTYPE sconsdoc [
<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'>
%scons;
<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'>
%builders-mod;
<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'>
%functions-mod;
<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'>
%tools-mod;
<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'>
%variables-mod;
]>

<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">

<!--
<tool name="Subversion">
<summary>
<para>
Sets construction variables for interacting with Subversion.
</para>
</summary>
<sets>
<item>SVN</item>
<item>SVNFLAGS</item>
<item>SVNCOM</item>
</sets>
<uses>
<item>SVNCOMSTR</item>
</uses>
</tool>
-->

<!--
<cvar name="SVN">
<summary>
<para>
The Subversion executable (usually named
<command>svn</command>).
</para>
</summary>
</cvar>
-->

<!--
<cvar name="SVNCOM">
<summary>
<para>
The command line used to
fetch source files from a Subversion repository.
</para>
</summary>
</cvar>
-->

<!--
<cvar name="SVNFLAGS">
<summary>
<para>
General options that are passed to Subversion.
</para>
</summary>
</cvar>
-->

<!--
<scons_function name="Subversion">
<arguments signature="global">
(repository, module)
</arguments>
<summary>
<para>
A factory function that
returns a Builder object
to be used to fetch source files
from the specified Subversion
<varname>repository</varname>.
The returned Builder
is intended to be passed to the
&f-link-SourceCode;
function.
</para>

<para>
The optional specified
<varname>module</varname>
will be added to the beginning
of all repository path names;
this can be used, in essence,
to strip initial directory names
from the repository path names,
so that you only have to
replicate part of the repository
directory hierarchy in your
local build directory.
</para>

<para>
This function is deprecated, see the entry for the
&f-SourceCode;
function.
</para>

<para>
Example:
</para>

<example_commands>
# Will fetch foo/bar/src.c
# from /usr/local/Subversion/foo/bar/src.c.
env.SourceCode('.', env.Subversion('file:///usr/local/Subversion'))

# Will fetch bar/src.c
# from /usr/local/Subversion/foo/bar/src.c.
env.SourceCode('.', env.Subversion('file:///usr/local/Subversion', 'foo'))

# Will fetch src.c
# from /usr/local/Subversion/foo/bar/src.c.
env.SourceCode('.', env.Subversion('file:///usr/local/Subversion', 'foo/bar'))
</example_commands>
</summary>
</scons_function>
-->

</sconsdoc>