Skip to content

Commit 6564d46

Browse files
committed
CDRIVER-1979 XML fixes to aid RST conversion
1 parent 1eb5955 commit 6564d46

15 files changed

+24
-81
lines changed

doc/mongoc_apm_command_failed_t.page

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121

2222
<section id="seealso">
2323
<title>See Also</title>
24-
<p><link xref="application-performance-monitoring">Introduction to
25-
Application Performance Monitoring</link></p>
24+
<p><link xref="application-performance-monitoring">Introduction to Application Performance Monitoring</link></p>
2625
</section>
2726
</page>

doc/mongoc_basic_troubleshooting.page

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212

1313
<list>
1414
<item><p>Did you call <code>mongoc_init()</code> in <code>main()</code>? If not, you will likely see a segfault.</p></item>
15-
<item><p>Have you leaked any clients or cursors as can be found with <cmd>mongoc-stat <var>PID</var></cmd>?</p></item>
16-
<item><p>Have packets been delivered to the server? See egress bytes from <cmd>mongoc-stat <var>PID</var></cmd>.</p></item>
15+
<item><p>Have you leaked any clients or cursors as can be found with <code>mongoc-stat &lt;PID&gt;</code>?</p></item>
16+
<item><p>Have packets been delivered to the server? See egress bytes from <code>mongoc-stat &lt;PID&gt;</code>.</p></item>
1717
<item><p>Does <code>valgrind</code> show any leaks? Ensure you call <code>mongoc_cleanup()</code> at the end of your process to cleanup lingering allocations from the MongoDB C driver.</p></item>
1818
<item><p>If compiling your own copy of MongoDB C driver, consider configuring with <code>--enable-tracing</code> to enable function tracing and hex dumps of network packets to <code>STDERR</code> and <code>STDOUT</code>.</p></item>
1919
</list>

doc/mongoc_client_command_simple_with_server_id.page

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ mongoc_client_command_simple_with_server_id (mongoc_client_t *client,
3434
<tr><td><p>db_name</p></td><td><p>The name of the database to run the command on.</p></td></tr>
3535
<tr><td><p>read_prefs</p></td><td><p>An optional <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code>.</p></td></tr>
3636
<tr><td><p>server_id</p></td><td><p>An opaque id specifying which server to use.</p></td></tr>
37-
<tr><td><p>reply</p></td><td><p>An optional location for a <code xref="bson:bson_t">bson_t</code>
38-
which will store the server's reply.</p></td></tr>
37+
<tr><td><p>reply</p></td><td><p>An optional location for a <code xref="bson:bson_t">bson_t</code> which will store the server's reply.</p></td></tr>
3938
<tr><td><p>error</p></td><td><p>An optional location for a <code xref="errors">bson_error_t</code> or a <code>NULL</code>.</p></td></tr>
4039
</table>
4140
</section>

doc/mongoc_client_pool_set_error_api.page

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
mongoc_client_pool_set_error_api (mongoc_client_pool_t *client,
1818
int32_t version);
1919
]]></code></synopsis>
20-
<p>Configure how the C Driver reports errors. See <link xref="errors#error-api-version" />.</p>
20+
<p>Configure how the C Driver reports errors. See <link xref="errors#error_api_version">Setting the Error API Version</link>.</p>
2121
</section>
2222

2323
<section id="parameters">

doc/mongoc_client_set_error_api.page

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
mongoc_client_set_error_api (mongoc_client_t *client,
1818
int32_t version);
1919
]]></code></synopsis>
20-
<p>Configure how the C Driver reports errors. See <link xref="errors#error-api-version" />.</p>
20+
<p>Configure how the C Driver reports errors. See <link xref="errors#error_api_version">Setting the Error API Version</link>.</p>
2121
<p>Do not use this function with pooled clients, see <code xref="mongoc_client_pool_set_error_api">mongoc_client_pool_set_error_api</code>.</p>
2222
</section>
2323

doc/mongoc_collection_copy.page

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ mongoc_collection_copy (mongoc_collection_t *collection);
2828
<section id="description">
2929
<title>Description</title>
3030
<p>Performs a deep copy of the <code>collection</code> struct and its configuration. Useful if you intend to call <code xref="mongoc_collection_set_write_concern">mongoc_collection_set_write_concern</code>, <code xref="mongoc_collection_set_read_prefs">mongoc_collection_set_read_prefs</code>, or <code xref="mongoc_collection_set_read_concern">mongoc_collection_set_read_concern</code>, and want to preserve an unaltered copy of the struct.</p>
31-
<p>This function does <em>not</em> copy the contents of the collection on the MongoDB server; use the <link xref="mongoc-common-task-examples#clone-collection"><code>cloneCollection</code> command</link> for that purpose.</p>
31+
<p>This function does <em>not</em> copy the contents of the collection on the MongoDB server; use the <link xref="mongoc-common-task-examples#clone-collection">cloneCollection command</link> for that purpose.</p>
3232
</section>
3333

3434
<section id="return">

doc/mongoc_collection_find_with_opts.page

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,12 +117,7 @@ cursor = mongoc_collection_find_with_opts (collection, filter, opts, read_prefs)
117117

118118
<p>The following options are supported.</p>
119119
<table shade="rows" rules="colgroups" frame="all">
120-
<colgroup><col/><col/></colgroup>
121-
<colgroup><col/><col/></colgroup>
122-
<thead>
123120
<tr><td><p>Option</p></td> <td><p>BSON type</p></td><td><p>Option</p></td> <td><p>BSON type</p></td></tr>
124-
</thead>
125-
<tbody>
126121
<!-- common options at the top -->
127122
<tr><td><p><code>projection</code></p></td><td><p>document</p> <!-- downgraded to "fields" --> </td><td><p><code>max</code></p></td><td><p>document</p></td> </tr>
128123
<tr><td><p><code>sort</code></p></td><td><p>document</p> <!-- downgraded to $orderby --> </td><td><p><code>maxScan</code></p></td><td><p>non-negative int64</p></td> </tr>
@@ -136,7 +131,6 @@ cursor = mongoc_collection_find_with_opts (collection, filter, opts, read_prefs)
136131
<tr><td><p><code>awaitData</code></p></td><td><p>bool</p></td><td><p><code>singleBatch</code></p></td><td><p>bool</p></td> </tr>
137132
<tr><td><p><code>collation</code></p></td><td><p>document</p></td><td><p><code>snapshot</code></p></td><td><p>bool</p></td> </tr>
138133
<tr><td><p><code>comment</code></p></td><td><p>string</p></td><td><p><code>tailable</code></p></td><td><p>bool</p></td> </tr>
139-
</tbody>
140134
</table>
141135
<p>
142136
For some options like "collation", the driver returns an error if the server version is too old to support the feature.

doc/mongoc_database_copy.page

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ mongoc_database_copy (mongoc_database_t *database);
2828
<section id="description">
2929
<title>Description</title>
3030
<p>Performs a deep copy of the <code>database</code> struct and its configuration. Useful if you intend to call <code xref="mongoc_database_set_write_concern">mongoc_database_set_write_concern</code>, <code xref="mongoc_database_set_read_prefs">mongoc_database_set_read_prefs</code>, or <code xref="mongoc_database_set_read_concern">mongoc_database_set_read_concern</code>, and want to preserve an unaltered copy of the struct.</p>
31-
<p>This function does <em>not</em> copy the contents of the database on the MongoDB server; use the <link xref="mongoc-common-task-examples#copydb"><code>copydb</code> command</link> for that purpose.</p>
31+
<p>This function does <em>not</em> copy the contents of the database on the MongoDB server; use the <link xref="mongoc-common-task-examples#copydb">copydb command</link> for that purpose.</p>
3232
</section>
3333

3434
<section id="return">

doc/mongoc_errors.page

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
128128
<p><code>MONGOC_ERROR_QUERY_FAILURE</code></p>
129129
</td>
130130
<td>
131-
<p><link xref="#error-api-version">Error API Version 1</link>: Server error from command or query. The server error message is in <code>message</code>.</p>
131+
<p><link xref="#error_api_version">Error API Version 1</link>: Server error from command or query. The server error message is in <code>message</code>.</p>
132132
</td>
133133
</tr>
134134
<tr>
@@ -139,7 +139,7 @@
139139
<p><code>MONGOC_ERROR_QUERY_FAILURE</code></p>
140140
</td>
141141
<td>
142-
<p><link xref="#error-api-version">Error API Version 2</link>: Server error from command or query. The server error message is in <code>message</code>.</p>
142+
<p><link xref="#error_api_version">Error API Version 2</link>: Server error from command or query. The server error message is in <code>message</code>.</p>
143143
</td>
144144
</tr>
145145
<tr>
@@ -212,7 +212,7 @@
212212
<p><link href="https://github.com/mongodb/mongo/blob/master/src/mongo/base/error_codes.err">Error code from server</link>.</p>
213213
</td>
214214
<td>
215-
<p><link xref="#error-api-version">Error API Version 1</link>: Server error from a command. The server error message is in <code>message</code>.</p>
215+
<p><link xref="#error_api_version">Error API Version 1</link>: Server error from a command. The server error message is in <code>message</code>.</p>
216216
</td>
217217
</tr>
218218
<tr>
@@ -223,7 +223,7 @@
223223
<p><link href="https://github.com/mongodb/mongo/blob/master/src/mongo/base/error_codes.err">Error code from server</link>.</p>
224224
</td>
225225
<td>
226-
<p><link xref="#error-api-version">Error API Version 2</link>: Server error from a command. The server error message is in <code>message</code>.</p>
226+
<p><link xref="#error_api_version">Error API Version 2</link>: Server error from a command. The server error message is in <code>message</code>.</p>
227227
</td>
228228
</tr>
229229
<tr>
@@ -245,7 +245,7 @@
245245
<p><link href="https://github.com/mongodb/mongo/blob/master/src/mongo/base/error_codes.err">Error code from server</link>.</p>
246246
</td>
247247
<td>
248-
<p><link xref="#error-api-version">Error API Version 1</link>: Server error from <code xref="mongoc_collection_insert">mongoc_collection_insert</code>, <code xref="mongoc_collection_insert_bulk">mongoc_collection_insert_bulk</code>, <code xref="mongoc_collection_update">mongoc_collection_update</code>, or <code xref="mongoc_collection_remove">mongoc_collection_remove</code>.</p>
248+
<p><link xref="#error_api_version">Error API Version 1</link>: Server error from <code xref="mongoc_collection_insert">mongoc_collection_insert</code>, <code xref="mongoc_collection_insert_bulk">mongoc_collection_insert_bulk</code>, <code xref="mongoc_collection_update">mongoc_collection_update</code>, or <code xref="mongoc_collection_remove">mongoc_collection_remove</code>.</p>
249249
</td>
250250
</tr>
251251
<tr>
@@ -256,7 +256,7 @@
256256
<p><link href="https://github.com/mongodb/mongo/blob/master/src/mongo/base/error_codes.err">Error code from server</link>.</p>
257257
</td>
258258
<td>
259-
<p><link xref="#error-api-version">Error API Version 2</link>: Server error from <code xref="mongoc_collection_insert">mongoc_collection_insert</code>, <code xref="mongoc_collection_insert_bulk">mongoc_collection_insert_bulk</code>, <code xref="mongoc_collection_update">mongoc_collection_update</code>, or <code xref="mongoc_collection_remove">mongoc_collection_remove</code>.</p>
259+
<p><link xref="#error_api_version">Error API Version 2</link>: Server error from <code xref="mongoc_collection_insert">mongoc_collection_insert</code>, <code xref="mongoc_collection_insert_bulk">mongoc_collection_insert_bulk</code>, <code xref="mongoc_collection_update">mongoc_collection_update</code>, or <code xref="mongoc_collection_remove">mongoc_collection_remove</code>.</p>
260260
</td>
261261
</tr>
262262
<tr>
@@ -325,7 +325,7 @@
325325
</table>
326326
</section>
327327

328-
<section id="error-api-version">
328+
<section id="error_api_version">
329329
<title>Setting the Error API Version</title>
330330

331331
<p>The driver's error reporting began with a design flaw: when the error <em style="strong">domain</em> is <code>MONGOC_ERROR_COLLECTION</code>, <code>MONGOC_ERROR_QUERY</code>, or <code>MONGOC_ERROR_COMMAND</code>, the error <em style="strong">code</em> might originate from the server or the driver. An application cannot always know where an error originated, and therefore cannot tell what the code means.</p>
@@ -399,14 +399,8 @@
399399
<td>
400400
<p>
401401
<code xref="mongoc_collection_insert">mongoc_collection_insert</code>
402-
</p>
403-
<p>
404402
<code xref="mongoc_collection_insert_bulk">mongoc_collection_insert_bulk</code>
405-
</p>
406-
<p>
407403
<code xref="mongoc_collection_update">mongoc_collection_update</code>
408-
</p>
409-
<p>
410404
<code xref="mongoc_collection_remove">mongoc_collection_remove</code>
411405
</p>
412406
</td>

doc/mongoc_gridfs_file_set_id.page

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,9 @@ mongoc_gridfs_file_set_id (mongoc_gridfs_file_t *file,
2222
<section id="parameters">
2323
<title>Parameters</title>
2424
<table>
25-
<tr><td><p>file</p></td><td><p>A <code xref="mongoc_gridfs_file_t">
26-
mongoc_gridfs_file_t</code>.</p></td></tr>
27-
<tr><td><p>id</p></td><td><p>A <code xref="bson:bson_value_t">
28-
bson_value_t</code>.</p></td></tr>
29-
<tr><td><p>error</p></td><td><p>A <code xref="errors">
30-
bson_error_t</code>.</p></td></tr>
25+
<tr><td><p>file</p></td><td><p>A <code xref="mongoc_gridfs_file_t"> mongoc_gridfs_file_t</code>.</p></td></tr>
26+
<tr><td><p>id</p></td><td><p>A <code xref="bson:bson_value_t">bson_value_t</code>.</p></td></tr>
27+
<tr><td><p>error</p></td><td><p>A <code xref="errors">bson_error_t</code>.</p></td></tr>
3128
</table>
3229
</section>
3330

0 commit comments

Comments
 (0)