Document SyncPoint::LoadDependency (#11477)

Summary:
It's easy to mix up the ordering when it's undocumented. For an example of the meaning of the order, see DBTest.ThreadStatusFlush.

Pull Request resolved: https://github.com/facebook/rocksdb/pull/11477

Test Plan: comments only

Reviewed By: jaykorean

Differential Revision: D46166683

Pulled By: pdillinger

fbshipit-source-id: 33118ba7ef1b08eab7b077548fe2e70f2c309e3f
This commit is contained in:
Peter Dillinger 2023-05-24 16:49:17 -07:00 committed by Facebook GitHub Bot
parent 17bc27741f
commit e8710303d9
1 changed files with 3 additions and 1 deletions

View File

@ -85,7 +85,9 @@ class SyncPoint {
}; };
// call once at the beginning of a test to setup the dependency between // call once at the beginning of a test to setup the dependency between
// sync points // sync points. Specifically, execution will not be allowed to proceed past
// each successor until execution has reached the corresponding predecessor,
// in any thread.
void LoadDependency(const std::vector<SyncPointPair>& dependencies); void LoadDependency(const std::vector<SyncPointPair>& dependencies);
// call once at the beginning of a test to setup the dependency between // call once at the beginning of a test to setup the dependency between