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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.svn-checkout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>svn_checkout</refname>
<refpurpose>Checks out a working copy from the repository</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>svn_checkout</methodname>
<methodparam><type>string</type><parameter>repos</parameter></methodparam>
<methodparam><type>string</type><parameter>targetpath</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>revision</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Checks out a working copy from the repository at <parameter>repos</parameter>
to <parameter>targetpath</parameter> at revision <parameter>revision</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>repos</parameter></term>
<listitem>
<para>
String URL path to directory in repository to check out.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>targetpath</parameter></term>
<listitem>
<para>
String local path to directory to check out in to
</para>
&svn.relativepath;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>revision</parameter></term>
<listitem>
<para>
Integer revision number of repository to check out. Default is
HEAD, the most recent revision.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Any combination of <constant>SVN_NON_RECURSIVE</constant> and
<constant>SVN_IGNORE_EXTERNALS</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Basic example</title>
<para>
This example demonstrates how to check out a directory from
a repository to a directory named calc:
</para>
<programlisting role="php">
<![CDATA[
<?php
svn_checkout('http://www.example.com/svnroot/calc/trunk', dirname(__FILE__) . '/calc');
?>
]]>
</programlisting>
<para>
The <literal>dirname(__FILE__)</literal> call is necessary in order
to convert the calc relative path into an absolute one. If calc
exists, you can also use <function>realpath</function> to retrieve
an absolute path.
</para>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>svn_add</function></member>
<member><function>svn_commit</function></member>
<member><function>svn_status</function></member>
<member><function>svn_update</function></member>
<member><link xlink:href="&url.svn.manual.checkout;">SVN documentation on svn checkout</link></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
