Clarify io_activity (#11427)

Summary: Document ReadOptions::io_activity as internal-use-only. And to keep kUnknown as last (and why). Pull Request resolved: #11427 Test Plan: comments only Reviewed By: hx235 Differential Revision: D45576986 Pulled By: pdillinger fbshipit-source-id: aae15aa22ea91370c2b7366154e45d4b91a79ad2
facebook · May 4, 2023 · a5909f8 · a5909f8
1 parent a11f1e1
commit a5909f8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/include/rocksdb/env.h b/include/rocksdb/env.h
@@ -441,7 +441,7 @@ class Env : public Customizable {
     kFlush = 0,
     kCompaction = 1,
     kDBOpen = 2,
-    kUnknown,
+    kUnknown,  // Keep last for easy array of non-unknowns
   };
 
   // Arrange to run "(*function)(arg)" once in a background thread, in

diff --git a/include/rocksdb/options.h b/include/rocksdb/options.h
@@ -1696,6 +1696,7 @@ struct ReadOptions {
   // Default: true
   bool optimize_multiget_for_io;
 
+  // ** For RocksDB internal use only **
   Env::IOActivity io_activity;
 
   ReadOptions();