initial documentation

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269180 c90b9560-bf6c-de11-be94-00142212c4b1

reference/svn/functions/svn-export.xml

@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="function.svn-export" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>svn_export</refname>
+  <refpurpose>Export the contents of a SVN directory</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>svn_export</methodname>
+   <methodparam><type>string</type><parameter>frompath</parameter></methodparam>
+   <methodparam><type>string</type><parameter>topath</parameter></methodparam>
+   <methodparam choice="opt"><type>bool</type><parameter>working_copy</parameter><initializer>true</initializer></methodparam>
+  </methodsynopsis>
+  <para>
+   Export the contents of either a working copy or repository into a
+   'clean' directory. 
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>frompath</parameter></term>
+     <listitem>
+      <para>
+       The path to the current repository.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>topath</parameter></term>
+     <listitem>
+      <para>
+       The path to the new repository.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>working_copy</parameter></term>
+     <listitem>
+      <para>
+       If &true;, it will export uncommitted files from the working copy.
+       Default value is &true;
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>svn_export</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$working_dir     = '../';
+$new_working_dir = '/home/user/devel/foo/trunk';
+
+svn_export($working_dir, $new_working_dir);
+?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>svn_import</function></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:"../../../../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
+-->