constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="svn.constants" xmlns="http://docbook.org/ns/docbook">
 &reftitle.constants;
 &extension.constants;
 <variablelist>
  <varlistentry xml:id="constant.svn-revision-head">
   <term>
    <constant>SVN_REVISION_HEAD</constant>
     (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Magic number (-1) specifying the HEAD revision
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="svn.constants.auth">
  <title>Constants usable with <function>svn_auth_set_parameter</function></title>
  <varlistentry xml:id="constant.svn-auth-param-default-username">
   <term>
    <constant>SVN_AUTH_PARAM_DEFAULT_USERNAME</constant> 
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Property for default username to use when performing basic authentication
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-auth-param-default-password">
   <term>
    <constant>SVN_AUTH_PARAM_DEFAULT_PASSWORD</constant> 
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Property for default password to use when performing basic authentication
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-auth-param-non-interactive">
   <term>
    <constant>SVN_AUTH_PARAM_NON_INTERACTIVE</constant> 
    (<type>string</type>)
   </term>
   <listitem><simpara /></listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-auth-param-dont-store-passwords">
   <term>
    <constant>SVN_AUTH_PARAM_DONT_STORE_PASSWORDS</constant> 
    (<type>string</type>)
   </term>
   <listitem><simpara /></listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-auth-param-no-auth-cache">
   <term>
    <constant>SVN_AUTH_PARAM_NO_AUTH_CACHE</constant> 
    (<type>string</type>)
   </term>
   <listitem><simpara /></listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-auth-param-ssl-server-failures">
   <term>
    <constant>SVN_AUTH_PARAM_SSL_SERVER_FAILURES</constant> 
    (<type>string</type>)
   </term>
   <listitem><simpara /></listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-auth-param-ssl-server-cert-info">
   <term>
    <constant>SVN_AUTH_PARAM_SSL_SERVER_CERT_INFO</constant> 
    (<type>string</type>)
   </term>
   <listitem><simpara /></listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-auth-param-config">
   <term>
    <constant>SVN_AUTH_PARAM_CONFIG</constant> 
    (<type>string</type>)
   </term>
   <listitem><simpara /></listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-auth-param-server-group">
   <term>
    <constant>SVN_AUTH_PARAM_SERVER_GROUP</constant> 
    (<type>string</type>)
   </term>
   <listitem><simpara /></listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-auth-param-config-dir">
   <term>
    <constant>SVN_AUTH_PARAM_CONFIG_DIR</constant> 
    (<type>string</type>)
   </term>
   <listitem><simpara /></listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-svn-auth-param-ignore-ssl-verify-errors">
   <term>
    <constant>PHP_SVN_AUTH_PARAM_IGNORE_SSL_VERIFY_ERRORS</constant> 
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
      Custom property for ignoring SSL cert verification errors
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist>
  <title>Filesystem constants</title>
  <varlistentry xml:id="constant.svn-fs-config-fs-type">
   <term>
    <constant>SVN_FS_CONFIG_FS_TYPE</constant> 
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Configuration key that determines filesystem type
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-fs-type-bdb">
   <term>
    <constant>SVN_FS_TYPE_BDB</constant> 
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Filesystem is Berkeley-DB implementation
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-fs-type-fsfs">
   <term>
    <constant>SVN_FS_TYPE_FSFS</constant> 
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Filesystem is native-filesystem implementation
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist>
  <title>Reserved property constants</title>
  <varlistentry xml:id="constant.svn-prop-revision-date">
   <term>
    <constant>SVN_PROP_REVISION_DATE</constant> 
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     svn:date
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-prop-revision-orig-date">
   <term>
    <constant>SVN_PROP_REVISION_ORIG_DATE</constant> 
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     svn:original-date
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-prop-revision-author">
   <term>
    <constant>SVN_PROP_REVISION_AUTHOR</constant> 
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     svn:author
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-prop-revision-log">
   <term>
    <constant>SVN_PROP_REVISION_LOG</constant> 
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     svn:log
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="svn.constants.status">
  <title>Working copy status constants</title>
  <varlistentry xml:id="constant.svn-wc-status-none">
   <term>
    <constant>SVN_WC_STATUS_NONE</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Status does not exist
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-unversioned">
   <term>
    <constant>SVN_WC_STATUS_UNVERSIONED</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Item is not versioned in working copy
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-normal">
   <term>
    <constant>SVN_WC_STATUS_NORMAL</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Item exists, nothing else is happening
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-added">
   <term>
    <constant>SVN_WC_STATUS_ADDED</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Item is scheduled for addition
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-missing">
   <term>
    <constant>SVN_WC_STATUS_MISSING</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Item is versioned but missing from the working copy
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-deleted">
   <term>
    <constant>SVN_WC_STATUS_DELETED</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Item is scheduled for deletion
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-replaced">
   <term>
    <constant>SVN_WC_STATUS_REPLACED</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Item was deleted and then re-added
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-modified">
   <term>
    <constant>SVN_WC_STATUS_MODIFIED</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Item (text or properties) was modified
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-merged">
   <term>
    <constant>SVN_WC_STATUS_MERGED</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Item's local modifications were merged with repository modifications
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-conflicted">
   <term>
    <constant>SVN_WC_STATUS_CONFLICTED</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Item's local modifications conflicted with repository modifications
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-ignored">
   <term>
    <constant>SVN_WC_STATUS_IGNORED</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Item is unversioned but configured to be ignored
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-obstructed">
   <term>
    <constant>SVN_WC_STATUS_OBSTRUCTED</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Unversioned item is in the way of a versioned resource
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-external">
   <term>
    <constant>SVN_WC_STATUS_EXTERNAL</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Unversioned path that is populated using svn:externals
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-wc-status-incomplete">
   <term>
    <constant>SVN_WC_STATUS_INCOMPLETE</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Directory does not contain complete entries list
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="svn.constants.type">
  <title>Node type constants</title>
  <varlistentry xml:id="constant.svn-node-none">
   <term>
    <constant>SVN_NODE_NONE</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Absent
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-node-file">
   <term>
    <constant>SVN_NODE_FILE</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     File
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-node-dir">
   <term>
    <constant>SVN_NODE_DIR</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Directory
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.svn-node-unknown">
   <term>
    <constant>SVN_NODE_UNKNOWN</constant> 
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Something Subversion cannot identify
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
</appendix>

<!-- 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
-->