rocksdb/claude_md/remove_option.md
Hui Xiao 300fb8cace Add claude md file for deprecated option removal (#14360)
Summary:
**Context/Summary:**

It's very easy to make mistake in removing deprecated option such as deleting the corresponding entry in type info that breaks backward compatibility or missing tests to test backward compatibility. Example: https://github.com/facebook/rocksdb/pull/14350#discussion_r2834554287. Added a claude md file for that.

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

Test Plan: In claude code, prompted for deprecated option removal with this claude md file in a repo separated from my previous deprecation efforts as much as possible and received correct change at one try.

Reviewed By: pdillinger

Differential Revision: D93920127

Pulled By: hx235

fbshipit-source-id: 1977ce7404b0188f84258552b4843e70394a5aea
2026-02-24 23:04:22 -08:00

440 B

Removing Deprecated Options from RocksDB

Keep in these files:

  • KEEP entry in type_info (options/cf_options.cc or options/db_options.cc) with OptionVerificationType::kDeprecated for loading old option files
  • KEEP or add test in options/options_test.cc OptionsOldApiTest::GetOptionsFromMapTest for loading old option files

Documentation:

  • Add release note to HISTORY.md and unreleased_history/