Fix misleading doc comment in ReaderWriterLatch#879
Open
Chessing234 wants to merge 1 commit intocmu-db:masterfrom
Open
Fix misleading doc comment in ReaderWriterLatch#879Chessing234 wants to merge 1 commit intocmu-db:masterfrom
Chessing234 wants to merge 1 commit intocmu-db:masterfrom
Conversation
The class documentation for `ReaderWriterLatch` says it is "backed by std::mutex", but the underlying member is actually a `std::shared_mutex`. This is misleading since `std::mutex` does not support shared (reader) locking. Correct the comment to reference `std::shared_mutex`. Signed-off-by: Chessing234 <Chessing234@users.noreply.github.com> Signed-off-by: Taksh <takshkothari09@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ReaderWriterLatchinrwlatch.hstates it is "backed by std::mutex", but the actual underlying member isstd::shared_mutex.std::mutexdoes not support shared/reader locking, whilestd::shared_mutexdoes -- which is the whole point of the class.Test plan
std::shared_mutex mutex_).