Browse Source

Clarify comments for leveldb::Env file reading methods.

"Create a brand new [adjective] file" seems like the description for a
method that will create a new file, but is used for methods that open
existing files for read access.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=211468002
naive_version
costan 6 years ago
committed by Victor Costan
parent
commit
9b44da73d9
1 changed files with 2 additions and 2 deletions
  1. +2
    -2
      include/leveldb/env.h

+ 2
- 2
include/leveldb/env.h View File

@ -45,7 +45,7 @@ class LEVELDB_EXPORT Env {
// The result of Default() belongs to leveldb and must never be deleted. // The result of Default() belongs to leveldb and must never be deleted.
static Env* Default(); static Env* Default();
// Create a brand new sequentially-readable file with the specified name.
// Create an object that sequentially reads the file with the specified name.
// On success, stores a pointer to the new file in *result and returns OK. // On success, stores a pointer to the new file in *result and returns OK.
// On failure stores nullptr in *result and returns non-OK. If the file does // On failure stores nullptr in *result and returns non-OK. If the file does
// not exist, returns a non-OK status. Implementations should return a // not exist, returns a non-OK status. Implementations should return a
@ -55,7 +55,7 @@ class LEVELDB_EXPORT Env {
virtual Status NewSequentialFile(const std::string& fname, virtual Status NewSequentialFile(const std::string& fname,
SequentialFile** result) = 0; SequentialFile** result) = 0;
// Create a brand new random access read-only file with the
// Create an object supporting random-access reads from the file with the
// specified name. On success, stores a pointer to the new file in // specified name. On success, stores a pointer to the new file in
// *result and returns OK. On failure stores nullptr in *result and // *result and returns OK. On failure stores nullptr in *result and
// returns non-OK. If the file does not exist, returns a non-OK // returns non-OK. If the file does not exist, returns a non-OK

Loading…
Cancel
Save