Clarify insert documentation

This commit is contained in:
2024-08-06 11:29:33 -07:00
parent c3a047fdf8
commit a7b3d8fe4c

View File

@@ -2882,9 +2882,9 @@ checkMaxBetweenExclusiveImpl<true>(Node *n, int begin, int end,
#endif #endif
// Returns a pointer to the newly inserted node. Caller must set // Returns a pointer to the newly inserted node. Caller must set
// `entryPresent`, and `entry` fields. The search path of the result will have // `entryPresent`, and `entry` fields. All nodes along the search path of the
// `maxVersion` at least `writeVersion` as a postcondition. Nodes along the // result will have `maxVersion` set to `writeVersion` as a postcondition. Nodes
// search path to `key` may be invalidated. // along the search path may be invalidated.
[[nodiscard]] Node *insert(Node **self, std::span<const uint8_t> key, [[nodiscard]] Node *insert(Node **self, std::span<const uint8_t> key,
InternalVersionT writeVersion, WriteContext *tls, InternalVersionT writeVersion, WriteContext *tls,
ConflictSet::Impl *impl) { ConflictSet::Impl *impl) {