From 730a422c3a41df569e0c51cc7b7e0d8938d33ee8 Mon Sep 17 00:00:00 2001 From: Yueh-Hsuan Chiang Date: Tue, 16 Feb 2016 14:55:24 -0800 Subject: [PATCH] Improve the documentation of LoadLatestOptions 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 --- include/rocksdb/utilities/options_util.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/include/rocksdb/utilities/options_util.h b/include/rocksdb/utilities/options_util.h index 9c0894bea..1d961a2bb 100644 --- a/include/rocksdb/utilities/options_util.h +++ b/include/rocksdb/utilities/options_util.h @@ -44,6 +44,12 @@ namespace rocksdb { // examples/options_file_example.cc demonstrates how to use this function // 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 Status LoadLatestOptions(const std::string& dbpath, Env* env, DBOptions* db_options,