andreacavalli/rocksdb
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve the documentation of LoadLatestOptions

Browse Source 
Summary: Improve the documentation of LoadLatestOptions

Test Plan: No code change

Reviewers: anthony, IslamAbdelRahman, kradhakrishnan, sdong

Reviewed By: sdong

Subscribers: dhruba, leveldb

Differential Revision: https://reviews.facebook.net/D54087
This commit is contained in:
Yueh-Hsuan Chiang 2016-02-16 14:55:24 -08:00
parent a7b6f0748a
commit 730a422c3a
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/rocksdb/utilities/options_util.h
View File

@ -44,6 +44,12 @@ namespace rocksdb {
// examples/options_file_example.cc demonstrates how to use this function // examples/options_file_example.cc demonstrates how to use this function
// to open a RocksDB instance. // to open a RocksDB instance.
// //
// @return the function returns an OK status when it went successfully. If
// the specified "dbpath" does not contain any option file, then a
// Status::NotFound will be returned. A return value other than
// Status::OK or Status::NotFound indicates there're some error related
// to the options file itself.
//
// @see LoadOptionsFromFile // @see LoadOptionsFromFile
Status LoadLatestOptions(const std::string& dbpath, Env* env, Status LoadLatestOptions(const std::string& dbpath, Env* env,
DBOptions* db_options, DBOptions* db_options,