Thanks for the CVS account!

Attached docs for svn_log(). Took a bit longer than I expected, and I
ended up filing a feature request report for switch support. But besides
that...

There was a little bit of guesswork involved with "action": I'm not sure
if those four values are the only ones that can be possibly be returned,
although it certainly seems so. Anyone more familiar with the SVN clear
this up?
-- 
 Edward Z. Yang      Personal: [EMAIL PROTECTED]
 SN:Ambush Commander Website: http://www.thewritingpot.com/
 GPGKey:0x869C48DA   http://www.thewritingpot.com/gpgpubkey.asc
 3FA8 E9A9 7385 B691 A6FC B3CB A933 BE7D 869C 48DA
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.svn-log">
 <refnamediv>
  <refname>svn_log</refname>
  <refpurpose>Returns the commit log messages of a repository URL</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <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>
  </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>.
  </para>
  <warning>
   <para>
    For repositories with large histories, the output may
    be quite large (one array item for every revision of the item).
    As of 0.2, this function does not currently does not support the
    <userinput>--limit NUM</userinput> flag, nor does it support revision
    ranges (<userinput>revision_no</userinput> must be an integer).
   </para>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>repos_url</parameter></term>
     <listitem>
      <para>
       Repository URL of the item to retrieve log history from.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>revision_no</parameter></term>
     <listitem>
      <para>
       Revision number of the log to retrieve. Use
       <constant>SVN_REVISON_HEAD</constant> to retrieve the log for
       the most recent revision.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   On success, this function returns an array file listing in the format
   of:
   <screen>
<![CDATA[
[0] => Array
(
    [rev] => integer revision number
    [author] => string author name
    [msg] => string log message
    [date] => string date formatted per ISO 8601, i.e. date('c')
    [paths] => Array, describing changed files
        (
            [0] => Array
                (
                    [action] => string letter signifying change
                    [path] =>  absolute repository path of changed file
                )
            [1] => ...
        )
)
[1] => ...
]]>
    </screen>
  </para>
  <para>
   The value of <varname>action</varname> is a subset of the
   <ulink url="http://svnbook.red-bean.com/en/1.2/svn.ref.svn.c.status.html";>status output
   in the first column</ulink>, where possible values are:
  </para>
  <variablelist>
   <varlistentry>
    <term>M</term>
    <listitem>
     <simpara>
      Item/props was modified
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>A</term>
    <listitem>
     <simpara>
      Item was added
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>D</term>
    <listitem>
     <simpara>
      Item was deleted
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>R</term>
    <listitem>
     <simpara>
      Item was replaced
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
  <para>
   If no changes were made to the item, an empty array is returned.
  </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>
 -->

 <!-- Use when examples exist
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>svn_log</function> example</title>
    <para>
     Any text that describes the purpose of the example, or
     what goes on in the example should go here (inside the
     <example> tag, not out
    </para>
    <programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
    echo 'Use the PEAR Coding Standards';
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 -->

 <!-- Use when adding See Also links
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function></function></member>
    <member>Or <link linkend="somethingelse">something else</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:"../../../../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
-->

Attachment: signature.asc
Description: OpenPGP digital signature

Reply via email to