Fix protos

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@262007 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2008-07-04 05:57:29 +00:00
parent cb93d93b48
commit 482ba8a653
4 changed files with 70 additions and 47 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<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>
@ -13,6 +13,7 @@
<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></methodparam>
</methodsynopsis>
<para>
Checks out a working copy from the repository at <parameter>repos</parameter>
@ -50,6 +51,15 @@
</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>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.svn-log" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>svn_log</refname>
@ -11,13 +11,16 @@
<methodsynopsis>
<type>array</type><methodname>svn_log</methodname>
<methodparam><type>string</type><parameter>repos_url</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>revision_no</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start_revision</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end_revision</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>limit</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
<function>svn_log</function> returns the complete history of the item at the repository URL
<parameter>repos_url</parameter>, or the history of a specific revision
if <parameter>revision_no</parameter> is set. This function is equivalent
to <userinput>svn log --verbose -r $revision_no $repos_url</userinput>.
if <parameter>start_revision</parameter> is set. This function is equivalent
to <userinput>svn log --verbose -r $start_revision $repos_url</userinput>.
</para>
<warning>
<para>
@ -25,7 +28,7 @@
be quite large (one array item for every revision of the item).
This function does not support the
<userinput>--limit NUM</userinput> flag, nor does it support revision
ranges (<userinput>revision_no</userinput> must be an integer).
ranges (<userinput>start_revision</userinput> must be an integer).
</para>
</warning>
</refsect1>
@ -43,15 +46,44 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>revision_no</parameter></term>
<term><parameter>start_revision</parameter></term>
<listitem>
<para>
Revision number of the log to retrieve. Use
<constant>SVN_REVISON_HEAD</constant> to retrieve the log for
Revision number of the first log to retrieve. Use
<constant>SVN_REVISON_HEAD</constant> to retrieve the log from
the most recent revision.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>end_revision</parameter></term>
<listitem>
<para>
Revision number of the last log to retrieve. Defaults to
<parameter>start_revision</parameter> if specified or to
<constant>SVN_REVISION_INITIAL</constant> otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>limit</parameter></term>
<listitem>
<para>
Number of logs to retrieve.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Any combination of <constant>SVN_OMIT_MESSAGES</constant>,
<constant>SVN_DISCOVER_CHANGED_PATHS</constant> and
<constant>SVN_STOP_ON_COPY</constant>, defaults to
<userinput>SVN_DISCOVER_CHANGED_PATHS | SVN_STOP_ON_COPY</userinput>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.svn-ls" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>svn_ls</refname>
@ -11,6 +11,7 @@
<type>array</type><methodname>svn_ls</methodname>
<methodparam><type>string</type><parameter>repos_url</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>revision_no</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>recurse</parameter></methodparam>
</methodsynopsis>
<para>
This function queries the repository URL and returns a list of
@ -48,6 +49,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>recurse</parameter></term>
<listitem>
<para>
Enables recursion.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.svn-status" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>svn_status</refname>
@ -11,10 +11,7 @@
<methodsynopsis>
<type>array</type><methodname>svn_status</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>recursive</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>get_all</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>update</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>no_ignore</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Returns the status of working copy files and directories, giving modifications,
@ -36,40 +33,15 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>recursive</parameter></term>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Whether or not to recursively descend into directories to
retrieve status. Default is &true;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>get_all</parameter></term>
<listitem>
<para>
Whether or not to return all items, regardless of modification
status. Default is &false;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>update</parameter></term>
<listitem>
<para>
Whether or not to return information from the server on
whether or not the working copy is up-to-date (specifically,
entries will be added for items that are out-of-date along with
the regular modification checks). Default is &false;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>no_ignore</parameter></term>
<listitem>
<para>
Whether or not to disregard svn:ignore properties when scanning
for new files. Default is &false;.
Any combination of <constant>SVN_NON_RECURSIVE</constant>,
<constant>SVN_ALL</constant> (regardless of modification status),
<constant>SVN_SHOW_UPDATES</constant> (entries will be added for items
that are out-of-date), <constant>SVN_NO_IGNORE</constant> (disregard
<literal>svn:ignore</literal> properties when scanning for new files)
and <constant>SVN_IGNORE_EXTERNALS</constant>.
</para>
</listitem>
</varlistentry>