add "unstable" feature plus test support

2 files changed, 9 insertions, 0 deletions

diff --git a/CHANGELOG b/CHANGELOG
index 7ed3def..cc221ab 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -9,6 +9,8 @@
 * removed 3DNow support from AMD uarch-specific decoders after K10
 * RegSpec register helpers to construct RegSpec from register numbers are now const fn
   (RegSpec::xmm, RegSpec::q, RegSpec::d, RegSpec::st, etc)
+* new crate feature flag, `unstable`, for library features that may see
+  breaking changes across semver-compatible releases.
 * for uarch-specific decoding, there is now a feature bit for Intel Key Locker. this corrects an
   issue where Key Locker instructions would decode under AMD-specific decoders.
 * push-immediate, pushf, popf, leave, and xlat now all report a correct memory
diff --git a/Cargo.toml b/Cargo.toml
index eecfad1..cb90983 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -56,6 +56,10 @@ use-serde = ["yaxpeax-arch/use-serde", "serde", "serde_derive"]
 
 colors = ["yaxpeax-arch/colors"]
 
+# feature for library surface areas that are *NOT STABLE*. these will change in
+# semver-incompatible ways across any releases.
+unstable = []
+
 # This enables some capstone benchmarks over the same
 # instruction bytes used to bench this code.
 capstone_bench = []
@@ -66,3 +70,6 @@ profiling = []
 
 # do not use this. it is for development and library debugging only.
 _debug_internal_disasm_stats = []
+
+# do not use this. it is for development and library testing only.
+_debug_internal_asserts = []