From 41251fe567724b9f453d7cecf1ddecf27cb94bd3 Mon Sep 17 00:00:00 2001
From: Kristina Chodorow <kristina@php.net>
Date: Thu, 11 Feb 2010 16:37:10 +0000
Subject: [PATCH] added "see also" links

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@294889 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/mongo/mongo.xml                     |  8 +++++++
 reference/mongo/mongocollection.xml           |  7 ++++++
 .../mongo/mongocollection/ensureindex.xml     |  7 ++++++
 reference/mongo/mongocollection/find.xml      |  7 ++++++
 reference/mongo/mongocollection/insert.xml    |  7 ++++++
 reference/mongo/mongocollection/update.xml    | 16 ++++++++++++-
 reference/mongo/mongocursor.xml               |  7 ++++++
 reference/mongo/mongocursor/explain.xml       |  8 +++++++
 reference/mongo/mongocursor/limit.xml         |  6 +++++
 reference/mongo/mongodb.xml                   |  7 ++++++
 reference/mongo/mongodb/authenticate.xml      |  7 ++++++
 reference/mongo/mongodb/command.xml           |  8 +++++++
 reference/mongo/mongodb/getgridfs.xml         | 18 +++------------
 reference/mongo/mongodb/getprofilinglevel.xml |  8 +++++++
 reference/mongo/mongodb/repair.xml            |  8 +++++++
 reference/mongo/mongodbref.xml                |  6 +++++
 reference/mongo/mongogridfs.xml               |  6 +++++
 reference/mongo/mongogridfs/construct.xml     | 23 ++-----------------
 reference/mongo/mongoid.xml                   |  6 +++++
 19 files changed, 133 insertions(+), 37 deletions(-)

diff --git a/reference/mongo/mongo.xml b/reference/mongo/mongo.xml
index 6ac91bb2cc..611666ac11 100644
--- a/reference/mongo/mongo.xml
+++ b/reference/mongo/mongo.xml
@@ -144,6 +144,14 @@ $db = $m->foo; // get the database named "foo"
     </variablelist>
    </section>
   </section>
+
+  <section>
+   &reftitle.seealso;
+   <para>
+    MongoDB core docs on <link xlink:href="&url.mongodb.dochub.connections;">connecting</link>.
+   </para>
+  </section>
+
 <!-- }}} -->
  </partintro>
 
diff --git a/reference/mongo/mongocollection.xml b/reference/mongo/mongocollection.xml
index 208058ee6a..4d229c954d 100644
--- a/reference/mongo/mongocollection.xml
+++ b/reference/mongo/mongocollection.xml
@@ -51,6 +51,13 @@
 
   </section>
 
+  <section>
+   &reftitle.seealso;
+   <para>
+    MongoDB core docs on <link xlink:href="&url.mongodb.dochub.collections;">collections</link>.
+   </para>
+  </section>
+
  </partintro>
 
  &reference.mongo.entities.mongocollection;
diff --git a/reference/mongo/mongocollection/ensureindex.xml b/reference/mongo/mongocollection/ensureindex.xml
index ccae52d5b9..7ac84416f5 100644
--- a/reference/mongo/mongocollection/ensureindex.xml
+++ b/reference/mongo/mongocollection/ensureindex.xml
@@ -159,6 +159,13 @@ $collection->insert(array("username" => "joeschmoe"));
   </example>
  </refsect1>
 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   MongoDB core docs on <link xlink:href="&url.mongodb.dochub.indexes;">indexes</link>.
+  </para>
+ </refsect1>
+
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/mongo/mongocollection/find.xml b/reference/mongo/mongocollection/find.xml
index f299b6ebc4..471e2761fb 100644
--- a/reference/mongo/mongocollection/find.xml
+++ b/reference/mongo/mongocollection/find.xml
@@ -71,6 +71,13 @@ $cursor = $collection->find($rangeQuery);
   </example>
  </refsect1>
 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   MongoDB core docs on <link xlink:href="&url.mongodb.dochub.find;">find</link>.
+  </para>
+ </refsect1>
+
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/mongo/mongocollection/insert.xml b/reference/mongo/mongocollection/insert.xml
index 6a3c2b148c..d85dfcabc9 100644
--- a/reference/mongo/mongocollection/insert.xml
+++ b/reference/mongo/mongocollection/insert.xml
@@ -130,6 +130,13 @@ catch(MongoCursorException $e) {
   </example>
  </refsect1>
 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   MongoDB core docs on <link xlink:href="&url.mongodb.dochub.insert;">insert</link>.
+  </para>
+ </refsect1>
+
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/mongo/mongocollection/update.xml b/reference/mongo/mongocollection/update.xml
index 3d4e2f8ba5..a6b153f958 100644
--- a/reference/mongo/mongocollection/update.xml
+++ b/reference/mongo/mongocollection/update.xml
@@ -65,7 +65,13 @@
           <literal>"multiple"</literal>
          </para>
          <para>
-          All documents matching $criteria will be updated.
+          All documents matching $criteria will be updated.  
+          <function>MongoCollection::update</function> has exactly the opposite 
+          behavior of <function>MongoCollection::remove</function>: it updates 
+          one document by default, not all matching documents.  <emphasis>It is 
+          recommended that you always specify whether you want to update 
+           multiple documents or a single document</emphasis>, as the database 
+          may change its default behavior at some point in the future.
          </para>
         </listitem>
        </itemizedlist>
@@ -197,6 +203,14 @@ $people->update("birthday" => $today), array('$set' => array('gift' => $surprise
    </programlisting>
   </example>
  </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   MongoDB core docs on <link xlink:href="&url.mongodb.dochub.update;">update</link>.
+  </para>
+ </refsect1>
+
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/mongo/mongocursor.xml b/reference/mongo/mongocursor.xml
index 3c9a4902c9..0641314fc6 100644
--- a/reference/mongo/mongocursor.xml
+++ b/reference/mongo/mongocursor.xml
@@ -84,6 +84,13 @@ $cursor->skip(4);
 
   </section>
 
+  <section>
+   &reftitle.seealso;
+   <para>
+    MongoDB core docs on <link xlink:href="&url.mongodb.dochub.cursors;">cursors</link>.
+   </para>
+  </section>
+
  </partintro>
 
  &reference.mongo.entities.mongocursor;
diff --git a/reference/mongo/mongocursor/explain.xml b/reference/mongo/mongocursor/explain.xml
index 004317a290..da005537fb 100644
--- a/reference/mongo/mongocursor/explain.xml
+++ b/reference/mongo/mongocursor/explain.xml
@@ -107,6 +107,14 @@ array(8) {
    database.
   </para>
  </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   MongoDB core docs on <link xlink:href="&url.mongodb.dochub.explain;">explain</link>.
+  </para>
+ </refsect1>
+
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/mongo/mongocursor/limit.xml b/reference/mongo/mongocursor/limit.xml
index 276ba0712f..d2f35cfeef 100644
--- a/reference/mongo/mongocursor/limit.xml
+++ b/reference/mongo/mongocursor/limit.xml
@@ -47,6 +47,12 @@
   </para>
  </refsect1>
 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   MongoDB core docs on <link xlink:href="&url.mongodb.dochub.limit;">limit</link>.
+  </para>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/mongo/mongodb.xml b/reference/mongo/mongodb.xml
index 1aecbc0ba9..c66ca7f34b 100644
--- a/reference/mongo/mongodb.xml
+++ b/reference/mongo/mongodb.xml
@@ -111,6 +111,13 @@ $db = $m->selectDB("example");
     </variablelist>
    </section>
   </section>
+
+  <section>
+   &reftitle.seealso;
+   <para>
+    MongoDB core docs on <link xlink:href="&url.mongodb.dochub.databases;">databases</link>.
+   </para>
+  </section>
  </partintro>
 
  &reference.mongo.entities.mongodb;
diff --git a/reference/mongo/mongodb/authenticate.xml b/reference/mongo/mongodb/authenticate.xml
index 1235ecf59f..b07688fda9 100644
--- a/reference/mongo/mongodb/authenticate.xml
+++ b/reference/mongo/mongodb/authenticate.xml
@@ -74,6 +74,13 @@ $result = $db->command(array("authenticate" => 1,
    Returns database response.
   </para>
  </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   MongoDB core docs on <link xlink:href="&url.mongodb.dochub.authenticate;">authenticate</link>.
+  </para>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/mongo/mongodb/command.xml b/reference/mongo/mongodb/command.xml
index 12d2664a23..66cb6ba986 100644
--- a/reference/mongo/mongodb/command.xml
+++ b/reference/mongo/mongodb/command.xml
@@ -142,6 +142,14 @@ User 4af467e4fd543cce7b0ea8e2 had 1 sale(s).
    </para>
   </example>
  </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   MongoDB core docs on <link xlink:href="&url.mongodb.dochub.commands;">database commands</link>
+   and <link xlink:href="&url.mongodb.dochub.mapreduce;">MapReduce</link>.
+  </para>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/mongo/mongodb/getgridfs.xml b/reference/mongo/mongodb/getgridfs.xml
index 76025dd31e..4878550893 100644
--- a/reference/mongo/mongodb/getgridfs.xml
+++ b/reference/mongo/mongodb/getgridfs.xml
@@ -11,8 +11,7 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>MongoGridFS</type><methodname>MongoDB::getGridFS</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>arg1</parameter><initializer>&quot;fs&quot;</initializer></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>arg2</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>prefix</parameter><initializer>&quot;fs&quot;</initializer></methodparam>
   </methodsynopsis>
  </refsect1>
 
@@ -22,22 +21,11 @@
    <variablelist>
     <varlistentry>
      <term>
-      <parameter>arg1</parameter>
+      <parameter>prefix</parameter>
      </term>
      <listitem>
       <para>
-       If the only argument, the prefix for the files and chunks collections.  Otherwise,
-       the name of the files collection.
-      </para>
-     </listitem>
-    </varlistentry>   
-    <varlistentry>
-     <term>
-      <parameter>arg2</parameter>
-     </term>
-     <listitem>
-      <para>
-       Name of the chunks collection.
+       The prefix for the files and chunks collections.
       </para>
      </listitem>
     </varlistentry>   
diff --git a/reference/mongo/mongodb/getprofilinglevel.xml b/reference/mongo/mongodb/getprofilinglevel.xml
index 973fae6e4f..fe1aa95bc5 100644
--- a/reference/mongo/mongodb/getprofilinglevel.xml
+++ b/reference/mongo/mongodb/getprofilinglevel.xml
@@ -26,6 +26,14 @@
    Returns the profiling level.
   </para>
  </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   MongoDB core docs on <link xlink:href="&url.mongodb.dochub.profiling;">profiling</link>
+   and <function>MongoDB::setProfilingLevel</function>.
+  </para>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/mongo/mongodb/repair.xml b/reference/mongo/mongodb/repair.xml
index fa5a167209..d46a74583a 100644
--- a/reference/mongo/mongodb/repair.xml
+++ b/reference/mongo/mongodb/repair.xml
@@ -50,6 +50,14 @@
    Returns db response.
   </para>
  </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   MongoDB core docs on <link xlink:href="&url.mongodb.dochub.repair;">repair</link>.
+  </para>
+ </refsect1>
+
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/mongo/mongodbref.xml b/reference/mongo/mongodbref.xml
index 6b77ee3558..5b4b67b7da 100644
--- a/reference/mongo/mongodbref.xml
+++ b/reference/mongo/mongodbref.xml
@@ -105,6 +105,12 @@ $people->insert(array("name" => "Fred", "likes" => array($trainRef, $soccerRef))
 
   </section>
 
+  <section>
+   &reftitle.seealso;
+   <para>
+    MongoDB core docs on <link xlink:href="&url.mongodb.dochub.dbrefs;">databases references</link>.
+   </para>
+  </section>
  </partintro>
 
  &reference.mongo.entities.mongodbref;
diff --git a/reference/mongo/mongogridfs.xml b/reference/mongo/mongogridfs.xml
index 3064839bc7..0590067381 100644
--- a/reference/mongo/mongogridfs.xml
+++ b/reference/mongo/mongogridfs.xml
@@ -220,6 +220,12 @@ $grid->storeBytes($bytes, array("whatever" => "metadata", "you" => "want");
 
   </section>
 
+  <section>
+   &reftitle.seealso;
+   <para>
+    MongoDB core docs on <link xlink:href="&url.mongodb.dochub.gridfs;">GridFS</link>.
+   </para>
+  </section>
  </partintro>
 
  &reference.mongo.entities.mongogridfs;
diff --git a/reference/mongo/mongogridfs/construct.xml b/reference/mongo/mongogridfs/construct.xml
index 5b6ca6183e..fe57e7550b 100644
--- a/reference/mongo/mongogridfs/construct.xml
+++ b/reference/mongo/mongogridfs/construct.xml
@@ -11,8 +11,7 @@
   <methodsynopsis>
    <methodname>MongoGridFS::__construct</methodname>
    <methodparam><type>MongoDB</type><parameter>db</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>files</parameter><initializer>&null;</initializer></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>chunks</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>prefix</parameter><initializer>&quot;fs&quot;</initializer></methodparam>
   </methodsynopsis>
 
   <para>
@@ -27,13 +26,6 @@ $fs = new MongoGridFS($db, "myfiles");
 ]]>
    uses myfiles.files and myfiles.chunks collections.
   </para>
-  <para>
-   Use two arguments to fully specify the collection names:
-<![CDATA[
-$fs = new MongoGridFS($db, "myfiles", "mychunks");
-]]>
-   uses myfiles and mychunks collections.
-  </para>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -56,18 +48,7 @@ $fs = new MongoGridFS($db, "myfiles", "mychunks");
      </term>
      <listitem>
       <para>
-       Optional files collection name.  If chunks is not given,
-       <literal>files</literal> is used as both collections&apos; prefix.
-      </para>
-     </listitem>
-    </varlistentry>   
-    <varlistentry>
-     <term>
-      <parameter>chunks</parameter>
-     </term>
-     <listitem>
-      <para>
-       Optional chunks collection name.
+       Optional collection name prefix.
       </para>
      </listitem>
     </varlistentry>   
diff --git a/reference/mongo/mongoid.xml b/reference/mongo/mongoid.xml
index a18ecd3b26..d41a44c922 100644
--- a/reference/mongo/mongoid.xml
+++ b/reference/mongo/mongoid.xml
@@ -68,6 +68,12 @@ C:7:"MongoId":24:{4af9f23d8ead0e1d32000000}
 
   </section>
 
+  <section>
+   &reftitle.seealso;
+   <para>
+    MongoDB core docs on <link xlink:href="&url.mongodb.dochub.objectids;">ids</link>.
+   </para>
+  </section>
  </partintro>
 
  &reference.mongo.entities.mongoid;