From a5909f88641a1222865839e62c91e43e6ee36c03 Mon Sep 17 00:00:00 2001
From: Peter Dillinger <peterd@fb.com>
Date: Thu, 4 May 2023 12:41:28 -0700
Subject: [PATCH] Clarify io_activity (#11427)

Summary:
Document ReadOptions::io_activity as internal-use-only. And to keep kUnknown as last (and why).

Pull Request resolved: https://github.com/facebook/rocksdb/pull/11427

Test Plan: comments only

Reviewed By: hx235

Differential Revision: D45576986

Pulled By: pdillinger

fbshipit-source-id: aae15aa22ea91370c2b7366154e45d4b91a79ad2
---
 include/rocksdb/env.h     | 2 +-
 include/rocksdb/options.h | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/include/rocksdb/env.h b/include/rocksdb/env.h
index c6523f063..e3d414641 100644
--- 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
index 611ba8b79..7b1de7942 100644
--- 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();