Skip to content

Commit d6b17d6

Browse files
authored
RUBY-3549: Updated specification links from RST to MD (#2898)
1 parent 40f92de commit d6b17d6

File tree

22 files changed

+27
-27
lines changed

22 files changed

+27
-27
lines changed

lib/mongo/auth/aws/conversation.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class Aws
2222
# Defines behavior around a single MONGODB-AWS conversation between the
2323
# client and server.
2424
#
25-
# @see https://github.com/mongodb/specifications/blob/master/source/auth/auth.rst#mongodb-aws
25+
# @see https://github.com/mongodb/specifications/blob/master/source/auth/auth.md#mongodb-aws
2626
#
2727
# @api private
2828
class Conversation < SaslConversationBase

lib/mongo/client_encryption.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ def create_encrypted_collection(database, coll_name, coll_opts, kms_provider, ma
294294
def create_data_keys(encrypted_fields, kms_provider, master_key)
295295
encrypted_fields = encrypted_fields.dup
296296
# We must return the partially formed encrypted_fields hash if an error
297-
# occurs - https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#create-encrypted-collection-helper
297+
# occurs - https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.md#create-encrypted-collection-helper
298298
# Thefore, we do this in a loop instead of using #map.
299299
encrypted_fields[:fields].size.times do |i|
300300
field = encrypted_fields[:fields][i]

lib/mongo/cluster/sdam_flow.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ def update_server_descriptions
6868
if server.address == updated_desc.address
6969
# SDAM flow must be run when topology version in the new description
7070
# is equal to the current topology version, per the example in
71-
# https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#what-is-the-purpose-of-topologyversion
71+
# https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.md#what-is-the-purpose-of-topologyversion
7272
unless updated_desc.topology_version_gte?(server.description)
7373
return false
7474
end

lib/mongo/collection/view/aggregation.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ def initial_query_op(session, read_preference)
9292
# aggregation will be routed to primary. Otherwise return the original
9393
# read preference.
9494
#
95-
# See https://github.com/mongodb/specifications/blob/master/source/crud/crud.rst#read-preferences-and-server-selection
95+
# See https://github.com/mongodb/specifications/blob/master/source/crud/crud.md#read-preferences-and-server-selection
9696
#
9797
# @param [ Server::Connection ] connection The connection which
9898
# will be used for the operation.

lib/mongo/cursor.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ def get_more
395395
# Legacy retryable read logic used to retry getMores, but since
396396
# doing so may result in silent data loss, the driver no longer retries
397397
# getMore operations in any circumstance.
398-
# https://github.com/mongodb/specifications/blob/master/source/retryable-reads/retryable-reads.rst#qa
398+
# https://github.com/mongodb/specifications/blob/master/source/retryable-reads/retryable-reads.md#qa
399399
process(execute_operation(get_more_operation))
400400
end
401401

lib/mongo/error/sdam_error_detection.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module SdamErrorDetection
2222

2323
# Whether the error is a "not master" error, or one of its variants.
2424
#
25-
# See https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#not-master-and-node-is-recovering.
25+
# See https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.md#not-writable-primary-and-node-is-recovering
2626
#
2727
# @return [ true | false ] Whether the error is a not master.
2828
#
@@ -45,7 +45,7 @@ def not_master?
4545

4646
# Whether the error is a "node is recovering" error, or one of its variants.
4747
#
48-
# See https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#not-master-and-node-is-recovering.
48+
# See https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.md#not-writable-primary-and-node-is-recovering
4949
#
5050
# @return [ true | false ] Whether the error is a node is recovering.
5151
#
@@ -66,7 +66,7 @@ def node_recovering?
6666

6767
# Whether the error is a "node is shutting down" type error.
6868
#
69-
# See https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#not-master-and-node-is-recovering.
69+
# See https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.md#not-writable-primary-and-node-is-recovering
7070
#
7171
# @return [ true | false ] Whether the error is a node is shutting down.
7272
#

lib/mongo/lint.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def validate_camel_case_read_preference_mode(mode)
5757

5858
# Validates the provided hash as a read concern object, per the
5959
# read/write concern specification
60-
# (https://github.com/mongodb/specifications/blob/master/source/read-write-concern/read-write-concern.rst#read-concern).
60+
# (https://github.com/mongodb/specifications/blob/master/source/read-write-concern/read-write-concern.md#read-concern).
6161
#
6262
# This method also accepts nil as input for convenience.
6363
#

lib/mongo/monitoring.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ def publish_heartbeat(server, awaited: false)
319319
# the time spent on the entire heartbeat. This could include time
320320
# to connect the socket (including TLS handshake), not just time
321321
# spent on hello call itself.
322-
# The spec at https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring-monitoring.rst
322+
# The spec at https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring-logging-and-monitoring.md
323323
# requires that the duration exposed here start from "sending the
324324
# message" (hello). This requirement does not make sense if,
325325
# for example, we were never able to connect to the server at all

lib/mongo/monitoring/event/secure.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def sensitive?(command_name:, document:)
5858
# According to Command Monitoring spec,for hello/legacy hello commands
5959
# when speculativeAuthenticate is present, their commands AND replies
6060
# MUST be redacted from the events.
61-
# See https://github.com/mongodb/specifications/blob/master/source/command-logging-and-monitoring/command-logging-and-monitoring.rst#security
61+
# See https://github.com/mongodb/specifications/blob/master/source/command-logging-and-monitoring/command-logging-and-monitoring.md#security
6262
true
6363
else
6464
false

lib/mongo/operation/shared/read_preference_supported.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def options(connection)
5757
#
5858
# @return [ true | false ] Whether the :secondary_ok flag should be added.
5959
def add_secondary_ok_flag?(connection)
60-
# https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#topology-type-single
60+
# https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.md#topology-type-single
6161
if connection.description.standalone?
6262
# Read preference is never sent to standalones.
6363
false
@@ -83,7 +83,7 @@ def command(connection)
8383
#
8484
# $readPreference is only sent when the server is a mongos,
8585
# following the rules described in
86-
# https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#passing-read-preference-to-mongos.
86+
# https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.md#passing-read-preference-to-mongos.
8787
# The topology does not matter for figuring out whether to send
8888
# $readPreference since the decision is always made based on
8989
# server type.

lib/mongo/operation/shared/sessions_supported.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ def command(connection)
154154
#
155155
# $readPreference is only sent when the server is a mongos,
156156
# following the rules described in
157-
# https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#passing-read-preference-to-mongos.
157+
# https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.md#passing-read-preference-to-mongos.
158158
# The topology does not matter for figuring out whether to send
159159
# $readPreference since the decision is always made based on
160160
# server type.
@@ -167,7 +167,7 @@ def command(connection)
167167
def add_read_preference(sel, connection)
168168
Lint.assert_type(connection, Server::Connection)
169169

170-
# https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#topology-type-single
170+
# https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.md#topology-type-single
171171
read_doc = if connection.description.standalone?
172172
# Read preference is never sent to standalones.
173173
nil

lib/mongo/protocol/compressed.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ module Protocol
2121
# MongoDB Wire protocol Compressed message.
2222
#
2323
# This is a bi-directional message that compresses another opcode.
24-
# See https://github.com/mongodb/specifications/blob/master/source/compression/OP_COMPRESSED.rst
24+
# See https://github.com/mongodb/specifications/blob/master/source/compression/OP_COMPRESSED.md
2525
#
2626
# @api semipublic
2727
#

lib/mongo/protocol/msg.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ def add_check_sum(buffer)
359359

360360
# Encapsulates a type 1 OP_MSG section.
361361
#
362-
# @see https://github.com/mongodb/specifications/blob/master/source/message/OP_MSG.rst#sections
362+
# @see https://github.com/mongodb/specifications/blob/master/source/message/OP_MSG.md#sections
363363
#
364364
# @api private
365365
class Section1

lib/mongo/server/push_monitor.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ def do_work
104104
# include topology version. In this case we need to keep our existing
105105
# topology version so that we can resume monitoring.
106106
# The spec does not appear to directly address this case but
107-
# https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-monitoring.rst#streaming-ismaster
107+
# https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-monitoring.md#streamable-hello-or-legacy-hello-command
108108
# says that topologyVersion should only be updated from successful
109109
# hello responses.
110110
if new_description.topology_version

lib/mongo/session/server_session/dirtyable.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class Session
1919
class ServerSession
2020
# Functionality for manipulating and querying a session's
2121
# "dirty" state, per the last paragraph at
22-
# https://github.com/mongodb/specifications/blob/master/source/sessions/driver-sessions.rst#server-session-pool
22+
# https://github.com/mongodb/specifications/blob/master/source/sessions/driver-sessions.md#server-session-pool
2323
#
2424
# If a driver has a server session pool and a network error is
2525
# encountered when executing any command with a ClientSession, the

lib/mongo/uri/srv_protocol.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class URI
2828
#
2929
# Please refer to the Initial DNS Seedlist Discovery spec for details.
3030
#
31-
# https://github.com/mongodb/specifications/blob/master/source/initial-dns-seedlist-discovery
31+
# https://github.com/mongodb/specifications/blob/master/source/initial-dns-seedlist-discovery/initial-dns-seedlist-discovery.md
3232
#
3333
# @example Use the uri string to make a client connection.
3434
# client = Mongo::Client.new('mongodb+srv://test6.test.build.10gen.cc/')

spec/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ described in `.evergreen/README.md`.
221221

222222
OCSP connectivity tests are in `spec/integration/ocsp_connectivity.rb`.
223223
These test the combinations described
224-
[here](https://github.com/mongodb/specifications/blob/master/source/ocsp-support/tests/README.rst#integration-tests-permutations-to-be-tested).
224+
[here](https://github.com/mongodb/specifications/blob/master/source/ocsp-support/tests/README.md#integration-tests-permutations-to-be-tested).
225225
To run these tests, set `OCSP_CONNECTIVITY=pass` environment variable if
226226
the tests are expected to connect successfully or `OCSP_CONNECTIVITY=fail` if
227227
the tests are expected to not connect.

spec/integration/ocsp_connectivity_spec.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
require 'lite_spec_helper'
55

66
# These tests test the configurations described in
7-
# https://github.com/mongodb/specifications/blob/master/source/ocsp-support/tests/README.rst#integration-tests-permutations-to-be-tested
7+
# https://github.com/mongodb/specifications/blob/master/source/ocsp-support/tests/README.md#integration-tests-permutations-to-be-tested
88
describe 'OCSP connectivity' do
99
require_ocsp_connectivity
1010
clear_ocsp_cache

spec/integration/search_indexes_prose_spec.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ class SearchIndexHelper
88
def initialize(client)
99
@client = client
1010

11-
# https://github.com/mongodb/specifications/blob/master/source/index-management/tests/README.rst#id4
11+
# https://github.com/mongodb/specifications/blob/master/source/index-management/tests/README.md#search-index-management-helpers
1212
# "...each test uses a randomly generated collection name. Drivers may
1313
# generate this collection name however they like, but a suggested
1414
# implementation is a hex representation of an ObjectId..."
@@ -68,7 +68,7 @@ def filter_results(result, names)
6868
end
6969

7070
describe 'Mongo::Collection#search_indexes prose tests' do
71-
# https://github.com/mongodb/specifications/blob/master/source/index-management/tests/README.rst#id5
71+
# https://github.com/mongodb/specifications/blob/master/source/index-management/tests/README.md#setup
7272
# "These tests must run against an Atlas cluster with a 7.0+ server."
7373
require_atlas
7474

spec/runners/auth.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
RSpec::Matchers.define :have_blank_credentials do
1818
match do |client|
1919
# The "null credential" definition in auth spec tests readme at
20-
# https://github.com/mongodb/specifications/blob/master/source/auth/tests/README.rst
20+
# https://github.com/mongodb/specifications/blob/master/source/auth/tests/README.md
2121
# is as follows:
2222
#
2323
# credential: If null, the credential must not be considered configured

spec/spec_tests/data/crud_unified/insertOne-dots_and_dollars.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ tests:
198198
# Using "$db" here works for libmongoc so long as it's a string type;
199199
# however, neither $ref nor $id would be accepted on their own.
200200
#
201-
# See https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#parsers
201+
# See https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md#parsers
202202
document: &dbrefLikeKey { _id: 1, a: { $db: "foo" } }
203203
expectResult: *insertResult
204204
expectEvents:

spec/spec_tests/data/run_command_unified/runCommand.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ tests:
143143
# This test assumes that the single topology contains a standalone server;
144144
# however, it is possible for a single topology to contain a direct
145145
# connection to another server type.
146-
# See: https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#topology-type-single
146+
# See: https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.md#topology-type-single
147147
- topologies: [ single ]
148148
operations:
149149
- name: runCommand

0 commit comments

Comments
 (0)