From 4b1d22d6840f4f8ef482e00ede246e9fb25556ea Mon Sep 17 00:00:00 2001 From: Chaoguang Lin <chaoguang.lin@snowflake.com> Date: Thu, 21 Apr 2022 13:39:08 -0700 Subject: [PATCH] Polish the documentation --- documentation/sphinx/source/special-keys.rst | 2 +- fdbclient/DatabaseContext.h | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/sphinx/source/special-keys.rst b/documentation/sphinx/source/special-keys.rst index 55a6fcdd23..12ec0e00e0 100644 --- a/documentation/sphinx/source/special-keys.rst +++ b/documentation/sphinx/source/special-keys.rst @@ -277,7 +277,7 @@ Versioning For how FDB clients deal with versioning, see :ref:`api-versions`. The special key space deals with versioning by using the ``API_VERSION`` passed to initialize the client. Any module added at a version larger than the API version set by the client will be inaccessible. For example, if a module is added in version 7.0 and the client sets its API version to 630, then the module will not available. When removing or updating existing modules, module developers need to continue to provide the old behavior for clients that specify old API versions. -To remove the functionality of a certain special key(s), specify the API version where the function is being deprecated in the ``registerSpecialKeysImpl`` function. When a client specifies an API version greater than or equal to the deprecation version, the functionality will not be available. Move and update the its documentation to :ref:`special-key-space-deprecation`. +To remove the functionality of a certain special key(s), specify the API version where the function is being deprecated in the ``registerSpecialKeysImpl`` function. When a client specifies an API version greater than or equal to the deprecation version, the functionality will not be available. Move and update its documentation to :ref:`special-key-space-deprecation`. To update the implementation of any special keys, add the new implementation and use ``API_VERSION`` to switch between different implementations. diff --git a/fdbclient/DatabaseContext.h b/fdbclient/DatabaseContext.h index 27f3e450f3..532bc1a096 100644 --- a/fdbclient/DatabaseContext.h +++ b/fdbclient/DatabaseContext.h @@ -595,9 +595,9 @@ public: std::vector<std::unique_ptr<SpecialKeyRangeReadImpl>> specialKeySpaceModules; std::unique_ptr<SpecialKeySpace> specialKeySpace; void registerSpecialKeysImpl(SpecialKeySpace::MODULE module, - SpecialKeySpace::IMPLTYPE type, - std::unique_ptr<SpecialKeyRangeReadImpl>&& impl, - int deprecatedVersion = -1); + SpecialKeySpace::IMPLTYPE type, + std::unique_ptr<SpecialKeyRangeReadImpl>&& impl, + int deprecatedVersion = -1); static bool debugUseTags; static const std::vector<std::string> debugTransactionTagChoices;