summaryrefslogtreecommitdiff
path: root/docs/server-parameters.md
diff options
context:
space:
mode:
authorBilly Donahue <billy.donahue@mongodb.com>2022-03-10 17:55:40 +0000
committerEvergreen Agent <no-reply@evergreen.mongodb.com>2022-03-10 19:32:28 +0000
commit7c5ff6c91299f45dff93e07b13c097ec846ce040 (patch)
treebc879cce28594b06844cb041987760229987649c /docs/server-parameters.md
parentc0652d91db0fb5cc54f12811e100ec8108130112 (diff)
downloadmongo-7c5ff6c91299f45dff93e07b13c097ec846ce040.tar.gz
SERVER-63588 ServerParameter: test for redact, remove self-registration
Diffstat (limited to 'docs/server-parameters.md')
-rw-r--r--docs/server-parameters.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/server-parameters.md b/docs/server-parameters.md
index 84078556428..53b1e03e295 100644
--- a/docs/server-parameters.md
+++ b/docs/server-parameters.md
@@ -163,9 +163,13 @@ used. If `true`, then the implementer must provide a
`{name}::{name}(StringData serverParameterName, ServerParameterType type)` constructor. In addition
to any other work, this custom constructor must invoke its parent's constructor.
-`override_set`: If `false`, a default `Status {name}::set(const BSONElement& val)` implementation
-will be provided which invokes `setFromString()` using `val.String()`, handling exceptions due to
-invalid BSON field types as appropriate. If `true`, the implementer must provide these methods.
+`override_set`: If `true`, the implementer must provide a `set` member function as:
+```cpp
+Status {name}::set(const BSONElement& val);
+```
+Otherwise the base class implementation `ServerParameter::set` is used. It
+invokes `setFromString` using a string representation of `val`, if the `val` is
+holding one of the supported types.
If `param.redact` was specified as `true`, then a standard append method will be provided which
injects a placeholder value. If `param.redact` was not specified as `true`, then an implementation