summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVictor Costan <costan@google.com>2020-01-08 09:14:53 -0800
committerVictor Costan <pwnall@chromium.org>2020-01-09 09:18:14 -0800
commita0191e5563b7a6c24b39edcbdbff29e602e0acfc (patch)
treec3e49f71d5e21af688f6c554431ee33e53425c46 /doc
parentd152b23f3b787f67a0ac3a40498e13831f3778d7 (diff)
downloadleveldb-a0191e5563b7a6c24b39edcbdbff29e602e0acfc.tar.gz
Add Env::Remove{File,Dir} which obsolete Env::Delete{File,Dir}.
The "DeleteFile" method name causes pain for Windows developers, because <windows.h> #defines a DeleteFile macro to DeleteFileW or DeleteFileA. Current code uses workarounds, like #undefining DeleteFile everywhere an Env is declared, implemented, or used. This CL removes the need for workarounds by renaming Env::DeleteFile to Env::RemoveFile. For consistency, Env::DeleteDir is also renamed to Env::RemoveDir. A few internal methods are also renamed for consistency. Software that supports Windows is expected to migrate any Env implementations and usage to Remove{File,Dir}, and never use the name Env::Delete{File,Dir} in its code. The renaming is done in a backwards-compatible way, at the risk of making it slightly more difficult to build a new correct Env implementation. The backwards compatibility is achieved using the following hacks: 1) Env::Remove{File,Dir} methods are added, with a default implementation that calls into Env::Delete{File,Dir}. This makes old Env implementations compatible with code that calls into the updated API. 2) The Env::Delete{File,Dir} methods are no longer pure virtuals. Instead, they gain a default implementation that calls into Env::Remove{File,Dir}. This makes updated Env implementations compatible with code that calls into the old API. The cost of this approach is that it's possible to write an Env without overriding either Rename{File,Dir} or Delete{File,Dir}, without getting a compiler warning. However, attempting to run the test suite will immediately fail with an infinite call stack ending in {Remove,Delete}{File,Dir}, making developers aware of the problem. PiperOrigin-RevId: 288710907
Diffstat (limited to 'doc')
-rw-r--r--doc/impl.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/impl.md b/doc/impl.md
index cacabb9..45187a2 100644
--- a/doc/impl.md
+++ b/doc/impl.md
@@ -166,7 +166,7 @@ So maybe even the sharding is not necessary on modern filesystems?
## Garbage collection of files
-`DeleteObsoleteFiles()` is called at the end of every compaction and at the end
+`RemoveObsoleteFiles()` is called at the end of every compaction and at the end
of recovery. It finds the names of all files in the database. It deletes all log
files that are not the current log file. It deletes all table files that are not
referenced from some level and are not the output of an active compaction.