[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/_language-snippets.ent_reference/mongo/mongocollection/bat
From:       Hannes_Magnusson <bjori () php ! net>
Date:       2012-11-28 20:33:41
Message-ID: svn-bjori-1354134821-328545-1030217145 () svn ! php ! net
[Download RAW message or body]

bjori                                    Wed, 28 Nov 2012 20:33:41 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=328545

Log:
Make the role=errors section consistent for all write methods

Changed paths:
    U   phpdoc/en/trunk/language-snippets.ent
    U   phpdoc/en/trunk/reference/mongo/mongocollection/batchinsert.xml
    U   phpdoc/en/trunk/reference/mongo/mongocollection/ensureindex.xml
    U   phpdoc/en/trunk/reference/mongo/mongocollection/insert.xml
    U   phpdoc/en/trunk/reference/mongo/mongocollection/remove.xml
    U   phpdoc/en/trunk/reference/mongo/mongocollection/save.xml
    U   phpdoc/en/trunk/reference/mongo/mongocollection/update.xml
    U   phpdoc/en/trunk/reference/mongo/mongogridfs/storebytes.xml
    U   phpdoc/en/trunk/reference/mongo/mongogridfs/storefile.xml


["svn-diffs-328545.txt" (text/x-diff)]

Modified: phpdoc/en/trunk/language-snippets.ent
===================================================================
--- phpdoc/en/trunk/language-snippets.ent	2012-11-28 20:18:45 UTC (rev 328544)
+++ phpdoc/en/trunk/language-snippets.ent	2012-11-28 20:33:41 UTC (rev 328545)
@@ -1725,3 +1725,4 @@
 <!ENTITY mongo.writes.parameters.fsync '<listitem \
xmlns="http://docbook.org/ns/docbook"><para><literal>"fsync"</literal></para><para>Boolean, \
defaults to &false;. Forces the insert to be synced to disk before returning success. \
If &true;, an acknowledged insert is implied and will override setting \
<literal>w</literal> to <literal>0</literal>.</para></listitem>'>  <!ENTITY \
mongo.writes.parameters.timeout '<listitem \
xmlns="http://docbook.org/ns/docbook"><para><literal>"timeout"</literal></para><para>Integer, \
defaults to <literal>MongoCursor::$timeout</literal>.  If "safe" is set, this sets \
how long (in milliseconds) for the client to wait for a database response.  If the \
database does not respond within the timeout period, a \
<classname>MongoCursorTimeoutException</classname> will be \
thrown.</para></listitem>'>  <!ENTITY mongo.writes.parameters.safe '<listitem \
xmlns="http://docbook.org/ns/docbook"><para><literal>"safe"</literal></para><para><emphasis>Deprecated</emphasis>. \
Please use the <link linkend="mongo.writeconcerns">WriteConcern</link> \
<literal>w</literal> option.</para></listitem>'> +<!ENTITY \
mongo.errors.exceptions.writeconcern '<para>Throws \
<classname>MongoCursorException</classname> if the "w" option is set and the write \
fails.</para><para>Throws <classname>MongoCursorTimeoutException</classname> if the \
"w" option is set to a value greater than one and the operation takes longer than \
<varname>MongoCursor::$timeout</varname> milliseconds to complete.  This does not \
kill the operation on the server, it is a client-side timeout. The operation in \
<literal>MongoCollection::$wtimeout</literal> is milliseconds.</para>'>

Modified: phpdoc/en/trunk/reference/mongo/mongocollection/batchinsert.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/batchinsert.xml	2012-11-28 \
                20:18:45 UTC (rev 328544)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/batchinsert.xml	2012-11-28 \
20:33:41 UTC (rev 328545) @@ -76,15 +76,7 @@

  <refsect1 role="errors">
   &reftitle.errors;
-  <para>
-   Throws <classname>MongoCursorException</classname> if the "w" option is
-   set and the insert fails.
-  </para>
-  <para>
-   Throws <classname>MongoCursorTimeoutException</classname> if the "w"
-   option is set to a value greater than one and the database cannot replicate
-   the operation in <literal>MongoCollection::$wtimeout</literal> milliseconds.
-  </para>
+  &mongo.errors.exceptions.writeconcern;
  </refsect1>

  <refsect1 role="changelog">

Modified: phpdoc/en/trunk/reference/mongo/mongocollection/ensureindex.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/ensureindex.xml	2012-11-28 \
                20:18:45 UTC (rev 328544)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/ensureindex.xml	2012-11-28 \
20:33:41 UTC (rev 328545) @@ -215,16 +215,7 @@
    Throws <classname>MongoException</classname> if the index name is longer than
    128 bytes. (Version 1.0.11+)
   </para>
-  <para>
-   Throws <classname>MongoCursorException</classname> if the "w" option is
-   set and the index creation fails.
-  </para>
-  <para>
-   Throws <classname>MongoCursorTimeoutException</classname> if the "w"
-   option is set and the operation takes longer than
-   <varname>MongoCursor::$timeout</varname> milliseconds to complete.  This does
-   not kill the operation on the server, it is a client-side timeout.
-  </para>
+  &mongo.errors.exceptions.writeconcern;
  </refsect1>

  <refsect1 role="examples">

Modified: phpdoc/en/trunk/reference/mongo/mongocollection/insert.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/insert.xml	2012-11-28 20:18:45 \
                UTC (rev 328544)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/insert.xml	2012-11-28 20:33:41 \
UTC (rev 328545) @@ -189,16 +189,7 @@
   <para>
    Throws <classname>MongoException</classname> if the inserted array is empty.
   </para>
-  <para>
-   Throws <classname>MongoCursorException</classname> if the
-   <literal>"w"</literal> option is set and the operation fails.
-  </para>
-  <para>
-   Throws <classname>MongoCursorTimeoutException</classname> if the
-   <literal>"w"</literal> option is set and the operation takes longer than
-   <varname>MongoCursor::$timeout</varname> milliseconds to complete. This does
-   not kill the operation on the server; it is a client-side timeout.
-  </para>
+  &mongo.errors.exceptions.writeconcern;
  </refsect1>

  <refsect1 role="changelog">

Modified: phpdoc/en/trunk/reference/mongo/mongocollection/remove.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/remove.xml	2012-11-28 20:18:45 \
                UTC (rev 328544)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/remove.xml	2012-11-28 20:33:41 \
UTC (rev 328545) @@ -72,16 +72,7 @@

  <refsect1 role="errors">
   &reftitle.errors;
-  <para>
-   Throws <classname>MongoCursorException</classname> if the
-   <literal>"w"</literal> option is set and the operation fails.
-  </para>
-  <para>
-   Throws <classname>MongoCursorTimeoutException</classname> if the
-   <literal>"w"</literal> option is set and the operation takes longer than
-   <varname>MongoCursor::$timeout</varname> milliseconds to complete. This does
-   not kill the operation on the server; it is a client-side timeout.
-  </para>
+  &mongo.errors.exceptions.writeconcern;
  </refsect1>

  <refsect1 role="changelog">

Modified: phpdoc/en/trunk/reference/mongo/mongocollection/save.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/save.xml	2012-11-28 20:18:45 UTC \
                (rev 328544)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/save.xml	2012-11-28 20:33:41 UTC \
(rev 328545) @@ -65,16 +65,7 @@

  <refsect1 role="errors">
   &reftitle.errors;
-  <para>
-   Throws <classname>MongoCursorException</classname> if the "w" option is
-   set and the save fails.
-  </para>
-  <para>
-   Throws <classname>MongoCursorTimeoutException</classname> if the "w"
-   option is set and the operation takes longer than
-   <varname>MongoCursor::$timeout</varname> milliseconds to complete.  This does
-   not kill the operation on the server, it is a client-side timeout.
-  </para>
+  &mongo.errors.exceptions.writeconcern;
  </refsect1>

  <refsect1 role="changelog">

Modified: phpdoc/en/trunk/reference/mongo/mongocollection/update.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/update.xml	2012-11-28 20:18:45 \
                UTC (rev 328544)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/update.xml	2012-11-28 20:33:41 \
UTC (rev 328545) @@ -109,16 +109,7 @@

  <refsect1 role="errors">
   &reftitle.errors;
-  <para>
-   Throws <classname>MongoCursorException</classname> if the
-   <literal>"w"</literal> option is set and the operation fails.
-  </para>
-  <para>
-   Throws <classname>MongoCursorTimeoutException</classname> if the
-   <literal>"w"</literal> option is set and the operation takes longer than
-   <varname>MongoCursor::$timeout</varname> milliseconds to complete. This does
-   not kill the operation on the server; it is a client-side timeout.
-  </para>
+  &mongo.errors.exceptions.writeconcern;
  </refsect1>

  <refsect1 role="changelog">

Modified: phpdoc/en/trunk/reference/mongo/mongogridfs/storebytes.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongogridfs/storebytes.xml	2012-11-28 20:18:45 \
                UTC (rev 328544)
+++ phpdoc/en/trunk/reference/mongo/mongogridfs/storebytes.xml	2012-11-28 20:33:41 \
UTC (rev 328545) @@ -67,10 +67,7 @@

  <refsect1 role="errors">
   &reftitle.errors;
-  <para>
-   Throws <classname>MongoCursorException</classname> if the "w" option is
-   set and the insert fails.
-  </para>
+  &mongo.errors.exceptions.writeconcern;
  </refsect1>

 </refentry>

Modified: phpdoc/en/trunk/reference/mongo/mongogridfs/storefile.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongogridfs/storefile.xml	2012-11-28 20:18:45 UTC \
                (rev 328544)
+++ phpdoc/en/trunk/reference/mongo/mongogridfs/storefile.xml	2012-11-28 20:33:41 UTC \
(rev 328545) @@ -67,10 +67,7 @@

  <refsect1 role="errors">
   &reftitle.errors;
-  <para>
-   Throws <classname>MongoCursorException</classname> if the "w" option is
-   set and the insert fails.
-  </para>
+  &mongo.errors.exceptions.writeconcern;
  </refsect1>

 </refentry>



-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic