Skip to content

Commit fce1ba0

Browse files
committed
format symbols in monospace throughout docs
1 parent 59dd479 commit fce1ba0

File tree

227 files changed

+452
-452
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

227 files changed

+452
-452
lines changed

doc/bulk.page

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@
99
<info><link xref="index#bulk" type="guide"/></info>
1010
<title>Bulk Insert</title>
1111
<p><em>New in MongoDB C driver 0.94.2.</em></p>
12-
<p>First we need to fetch a bulk operation handle from the <link xref="mongoc_collection_t">mongoc_collection_t</link>. This can be performed in either ordered or unordered mode. Unordered mode allows for greater parallelization when working with sharded clusters.</p>
12+
<p>First we need to fetch a bulk operation handle from the <code xref="mongoc_collection_t">mongoc_collection_t</code>. This can be performed in either ordered or unordered mode. Unordered mode allows for greater parallelization when working with sharded clusters.</p>
1313
<synopsis><code mime="text/x-csrc"><![CDATA[mongoc_bulk_operation_t *bulk = mongoc_collection_create_bulk_operation (collection, true, write_concern);]]></code></synopsis>
1414
<p>We can now start inserting documents to the bulk operation. These will be buffered until we execute the operation.</p>
15-
<p>The bulk operation will coalesce insertions as a single batch for each consecutive call to <link xref="mongoc_bulk_operation_insert">mongoc_bulk_operation_insert()</link>. This creates a pipelined effect when possible.</p>
15+
<p>The bulk operation will coalesce insertions as a single batch for each consecutive call to <code xref="mongoc_bulk_operation_insert">mongoc_bulk_operation_insert()</code>. This creates a pipelined effect when possible.</p>
1616
<note style="tip"><p>The bulk operation API will automatically handle MongoDB servers &lt; 2.6 by speaking the old wire protocol. However, some performance degredation may occur.</p></note>
17-
<p>To execute the bulk operation and receive the result we call <link xref="mongoc_bulk_operation_execute">mongoc_bulk_operation_execute()</link>.</p>
17+
<p>To execute the bulk operation and receive the result we call <code xref="mongoc_bulk_operation_execute">mongoc_bulk_operation_execute()</code>.</p>
1818
<synopsis><code mime="text/x-csrc"><include parse="text" href="../examples/bulk/bulk1.c" xmlns="http://www.w3.org/2001/XInclude" /></code></synopsis>
1919
<synopsis><code mime="text/x-json">{"nInserted" : 10000,
2020
"nMatched" : 0,
@@ -29,7 +29,7 @@
2929
<title>Mixed Bulk Write Operations</title>
3030
<p><em>New in MongoDB C driver 0.94.2</em></p>
3131
<p>MongoDB C driver also supports executing mixed bulk write operations. A batch of insert, update, and remove operations can be executed together using the bulk write operations API.</p>
32-
<note style="tip"><p>Though the following API will work with all versions of MongoDB, it is designed to be used with MongoDB versions &gt;= 2.6. Much better bulk insert performance can be achieved with older versions of MongoDB through the deprecated <link xref="mongoc_collection_insert_bulk">mongoc_collection_insert_bulk()</link> method.</p></note>
32+
<note style="tip"><p>Though the following API will work with all versions of MongoDB, it is designed to be used with MongoDB versions &gt;= 2.6. Much better bulk insert performance can be achieved with older versions of MongoDB through the deprecated <code xref="mongoc_collection_insert_bulk">mongoc_collection_insert_bulk()</code> method.</p></note>
3333
</section>
3434

3535
<section id="ordered-bulk-write">
@@ -70,7 +70,7 @@ Error: insertDocument :: caused by :: 11000 E11000 duplicate key error index: te
7070
<section id="bulk-write-concern">
7171
<info><link xref="index#bulk" type="guide"/></info>
7272
<title>Bulk Operations Write Concerns</title>
73-
<p>By default bulk operations are executed with the <link xref="mongoc_write_concern_t">write_concern</link> of the collection they are executed against. A custom write concern can be passed to the <link xref="mongoc_collection_create_bulk_operation">mongoc_collection_create_bulk_operation()</link> method. Write concern errors (e.g. wtimeout) will be reported after all operations are attempted, regardless of execution order.</p>
73+
<p>By default bulk operations are executed with the <code xref="mongoc_write_concern_t">write_concern</code> of the collection they are executed against. A custom write concern can be passed to the <code xref="mongoc_collection_create_bulk_operation">mongoc_collection_create_bulk_operation()</code> method. Write concern errors (e.g. wtimeout) will be reported after all operations are attempted, regardless of execution order.</p>
7474
</section>
7575

7676
</page>

doc/cursors.page

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ print_all_documents (mongoc_collection_t *collection)
3939
<section id="killing-cursors">
4040
<info><link type="guide" xref="index#cursors"/></info>
4141
<title>Destroying Server-Side Cursors</title>
42-
<p>The MongoDB C driver will automatically destroy a server-side cursor when <link xref="mongoc_cursor_destroy">mongoc_cursor_destroy()</link> is called. Failure to call this function when done with a cursor will leak memory client side as well as consume extra memory server side. If the cursor was configured to never timeout, it will become a memory leak on the server.</p>
42+
<p>The MongoDB C driver will automatically destroy a server-side cursor when <code xref="mongoc_cursor_destroy">mongoc_cursor_destroy()</code> is called. Failure to call this function when done with a cursor will leak memory client side as well as consume extra memory server side. If the cursor was configured to never timeout, it will become a memory leak on the server.</p>
4343
</section>
4444

4545
<section id="tailable">
4646
<title>Tailable Cursors</title>
4747
<info><link type="guide" xref="index#cursors"/></info>
4848

49-
<p>Tailable cursors are cursors that remain open even after they've returned a final result. This way, if more documents are added to a collection (i.e., to the cursor's result set), then you can continue to call <link xref="mongoc_cursor_next">mongoc_cursor_next()</link> to retrieve those additional results.</p>
49+
<p>Tailable cursors are cursors that remain open even after they've returned a final result. This way, if more documents are added to a collection (i.e., to the cursor's result set), then you can continue to call <code xref="mongoc_cursor_next">mongoc_cursor_next()</code> to retrieve those additional results.</p>
5050
<p>Here's a complete test case that demonstrates the use of tailable cursors.</p>
5151

5252
<note style="info"><p>Note that tailable cursors are for capped collections only.</p></note>

doc/deleting-document.page

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ main (int argc,
8585

8686
<note style="warning">
8787
<p>
88-
When using the MongoDB C Driver, you must call <link xref="mongoc_init">mongoc_init()</link> at the beginning of your application.
88+
When using the MongoDB C Driver, you must call <code xref="mongoc_init">mongoc_init()</code> at the beginning of your application.
8989
This allows the driver to initialize it's required subsystems.
9090
Failure to do so will result in a runtime crash.
9191
</p>

doc/executing-command.page

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ main (int argc,
8383

8484
<note style="warning">
8585
<p>
86-
When using the MongoDB C Driver, you must call <link xref="mongoc_init">mongoc_init()</link> at the beginning of your application.
86+
When using the MongoDB C Driver, you must call <code xref="mongoc_init">mongoc_init()</code> at the beginning of your application.
8787
This allows the driver to initialize it's required subsystems.
8888
Failure to do so will result in a runtime crash.
8989
</p>

doc/finding-document.page

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ main (int argc,
7979

8080
<note style="warning">
8181
<p>
82-
When using the MongoDB C Driver, you must call <link xref="mongoc_init">mongoc_init()</link> at the beginning of your application.
82+
When using the MongoDB C Driver, you must call <code xref="mongoc_init">mongoc_init()</code> at the beginning of your application.
8383
This allows the driver to initialize it's required subsystems.
8484
Failure to do so will result in a runtime crash.
8585
</p>

doc/inserting-document.page

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ main (int argc,
7575

7676
<note style="warning">
7777
<p>
78-
When using the MongoDB C Driver, you must call <link xref="mongoc_init">mongoc_init()</link> at the beginning of your application.
78+
When using the MongoDB C Driver, you must call <code xref="mongoc_init">mongoc_init()</code> at the beginning of your application.
7979
This allows the driver to initialize it's required subsystems.
8080
Failure to do so will result in a runtime crash.
8181
</p>

doc/mongoc_bulk_operation_delete.page

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,26 @@
1919
mongoc_bulk_operation_delete (mongoc_bulk_operation_t *bulk,
2020
const bson_t *selector);
2121
]]></code></synopsis>
22-
<p>This function queues a delete operation as part of <code>bulk</code> that will delete all documents matching <code>selector</code>. To delete a single document, see <link xref="mongoc_bulk_operation_remove_one">mongoc_bulk_operation_remove_one()</link>.</p>
22+
<p>This function queues a delete operation as part of <code>bulk</code> that will delete all documents matching <code>selector</code>. To delete a single document, see <code xref="mongoc_bulk_operation_remove_one">mongoc_bulk_operation_remove_one()</code>.</p>
2323
</section>
2424

2525
<section id="deprecated">
2626
<title>Deprecated</title>
2727
<note style="warning"><p>This function is deprecated and should not be used in new code.</p></note>
28-
<p>Please use <link xref="mongoc_bulk_operation_remove">mongoc_bulk_operation_remove()</link> instead.</p>
28+
<p>Please use <code xref="mongoc_bulk_operation_remove">mongoc_bulk_operation_remove()</code> instead.</p>
2929
</section>
3030

3131
<section id="parameters">
3232
<title>Parameters</title>
3333
<table>
34-
<tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
34+
<tr><td><p>bulk</p></td><td><p>A <code xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</code>.</p></td></tr>
3535
<tr><td><p>selector</p></td><td><p>A <code xref="bson:bson_t">bson_t</code>.</p></td></tr>
3636
</table>
3737
</section>
3838

3939
<section id="errors">
4040
<title>Errors</title>
41-
<p>Errors are propagated via <link xref="mongoc_bulk_operation_execute">mongoc_bulk_operation_execute()</link>.</p>
41+
<p>Errors are propagated via <code xref="mongoc_bulk_operation_execute">mongoc_bulk_operation_execute()</code>.</p>
4242
</section>
4343

4444
</page>

doc/mongoc_bulk_operation_delete_one.page

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,26 @@
1919
mongoc_bulk_operation_delete_one (mongoc_bulk_operation_t *bulk,
2020
const bson_t *selector);
2121
]]></code></synopsis>
22-
<p>This function queues a delete operation as part of <code>bulk</code> that will delete a single document matching <code>selector</code>. To delete a multiple documents, see <link xref="mongoc_bulk_operation_delete">mongoc_bulk_operation_delete()</link>.</p>
22+
<p>This function queues a delete operation as part of <code>bulk</code> that will delete a single document matching <code>selector</code>. To delete a multiple documents, see <code xref="mongoc_bulk_operation_delete">mongoc_bulk_operation_delete()</code>.</p>
2323
</section>
2424

2525
<section id="deprecated">
2626
<title>Deprecated</title>
2727
<note style="warning"><p>This function is deprecated and should not be used in new code.</p></note>
28-
<p>Please use <link xref="mongoc_bulk_operation_remove_one">mongoc_bulk_operation_remove_one()</link> instead.</p>
28+
<p>Please use <code xref="mongoc_bulk_operation_remove_one">mongoc_bulk_operation_remove_one()</code> instead.</p>
2929
</section>
3030

3131
<section id="parameters">
3232
<title>Parameters</title>
3333
<table>
34-
<tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
34+
<tr><td><p>bulk</p></td><td><p>A <code xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</code>.</p></td></tr>
3535
<tr><td><p>selector</p></td><td><p>A <code xref="bson:bson_t">bson_t</code>.</p></td></tr>
3636
</table>
3737
</section>
3838

3939
<section id="errors">
4040
<title>Errors</title>
41-
<p>Errors are propagated via <link xref="mongoc_bulk_operation_execute">mongoc_bulk_operation_execute()</link>.</p>
41+
<p>Errors are propagated via <code xref="mongoc_bulk_operation_execute">mongoc_bulk_operation_execute()</code>.</p>
4242
</section>
4343

4444
</page>

doc/mongoc_bulk_operation_destroy.page

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@
1818
<synopsis><code mime="text/x-csrc"><![CDATA[void
1919
mongoc_bulk_operation_destroy (mongoc_bulk_operation_t *bulk);
2020
]]></code></synopsis>
21-
<p>Destroys a <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link> and frees the structure.</p>
21+
<p>Destroys a <code xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</code> and frees the structure.</p>
2222
</section>
2323

2424

2525
<section id="parameters">
2626
<title>Parameters</title>
2727
<table>
28-
<tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
28+
<tr><td><p>bulk</p></td><td><p>A <code xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</code>.</p></td></tr>
2929
</table>
3030
</section>
3131

doc/mongoc_bulk_operation_execute.page

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,17 @@ mongoc_bulk_operation_execute (mongoc_bulk_operation_t *bulk,
2020
bson_t *reply,
2121
bson_error_t *error);
2222
]]></code></synopsis>
23-
<p>This function executes all operations queued into the bulk operation. If <code>ordered</code> was specified to <link xref="mongoc_collection_create_bulk_operation">mongoc_collection_create_bulk_operation()</link>, then forward progress will be stopped upon the first error.</p>
23+
<p>This function executes all operations queued into the bulk operation. If <code>ordered</code> was specified to <code xref="mongoc_collection_create_bulk_operation">mongoc_collection_create_bulk_operation()</code>, then forward progress will be stopped upon the first error.</p>
2424

25-
<p>It is only valid to call <link xref="mongoc_bulk_operation_execute">mongoc_bulk_operation_execute()</link> once. The <code>mongoc_bulk_operation_t</code> must be destroyed afterwards.</p>
25+
<p>It is only valid to call <code xref="mongoc_bulk_operation_execute">mongoc_bulk_operation_execute()</code> once. The <code>mongoc_bulk_operation_t</code> must be destroyed afterwards.</p>
2626

2727
<note style="warning"><p><code>reply</code> is always initialized, even upon failure. Callers <em>must</em> call <code xref="bson:bson_destroy">bson_destroy()</code> to release this potential allocation.</p></note>
2828
</section>
2929

3030
<section id="parameters">
3131
<title>Parameters</title>
3232
<table>
33-
<tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
33+
<tr><td><p>bulk</p></td><td><p>A <code xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</code>.</p></td></tr>
3434
<tr><td><p>reply</p></td><td><p>A <code xref="bson:bson_t">bson_t</code>.</p></td></tr>
3535
<tr><td><p>error</p></td><td><p>An optional location for a <code xref="bson:bson_error_t">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
3636
</table>

0 commit comments

Comments
 (0)