Improve comment in db_impl.h #5338
Closed
Conversation
This file contains 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
|
ping |
db/db_impl.h
Outdated
| @@ -75,16 +75,31 @@ struct JobContext; | |||
| struct ExternalSstFileInfo; | |||
| struct MemTableInfo; | |||
|
|
|||
| // While DB is the public interface of RocksDB, and DBImpl is the actual | |||
| // class implementing it. It's the entrance of the core RocksdB engine. | |||
| // All other DB implementations, e.g. TransactionDB, BlobDB, etc, wraps a | |||
db/db_impl.h
Outdated
| // All other DB implementations, e.g. TransactionDB, BlobDB, etc, wraps a | ||
| // DBImpl internally. | ||
| // Other than functions implementing the DB interface, some public | ||
| // functions are there for other internal components to call. It includes |
There was a problem hiding this comment.
"It" refers to "some public functions"? maybe should be "They include"?
db/db_impl.h
Outdated
| // DBImpl internally. | ||
| // Other than functions implementing the DB interface, some public | ||
| // functions are there for other internal components to call. It includes | ||
| // components of higher layer. For example, TransactionDB directly |
There was a problem hiding this comment.
"higher layers" or "the high layer"?
db/db_impl.h
Outdated
| // components of higher layer. For example, TransactionDB directly | ||
| // calls DBImpl::WriteImpl() and BlobDB directly calls | ||
| // DBImpl::GetImpl(). Other functions are public for sub-componets | ||
| // to interace. For example, ColumnFamilyHandleImpl calls into |
There was a problem hiding this comment.
"calls into" -> "calls"?
| // mode and LastAllocatedSequence otherwise. This is useful when visiblility | ||
| // depends also on data written to the WAL but not to the memtable. | ||
| SequenceNumber TEST_GetLastVisibleSequence() const; | ||
|
|
db/db_impl.h
Outdated
| // load list of snapshots to `snap_vector` that is no newer than `max_seq` | ||
| // in ascending order. | ||
| // `oldest_write_conflict_snapshot` is filled with the oldest snapshot | ||
| // which satifies SnapshotImpl.is_write_conflict_boundary_ = true. |
db/db_impl.h
Outdated
| @@ -748,6 +701,8 @@ class DBImpl : public DB { | |||
|
|
|||
| InstrumentedMutex* mutex() const { return &mutex_; } | |||
|
|
|||
| // Initial a brand new DB. The DB directory is expected to be empty before | |||
miasantreble
approved these changes
May 24, 2019
There was a problem hiding this comment.
@siying is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
Summary: Add some comments in db_impl.h. Also reordered function order a little bit so that I can add a comment to flag the area of functions implementing DB interface. Test Plan: make check with both of LITE and normal build Some wording improvements. Address comments.
There was a problem hiding this comment.
@siying is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
vagogte
pushed a commit
to vagogte/rocksdb
that referenced
this pull request
Jun 18, 2019
Summary: Add some comments in db_impl.h. Also reordered function order a little bit so that I can add a comment to flag the area of functions implementing DB interface. Pull Request resolved: facebook#5338 Differential Revision: D15498284 Pulled By: siying fbshipit-source-id: 3d7c59c8303577fe44d13c74ae84c7ce05164f77
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
Add some comments in db_impl.h. Also reordered function order a little bit so that I can add a comment to flag the area of functions implementing DB interface.
Test Plan: make check with both of LITE and normal build