lib: document blanket behavior

lovesegfault · Feb 18, 2020 · ea9fb0d · ea9fb0d
1 parent 6e11791
commit ea9fb0d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -4,6 +4,9 @@
 //! the [`raw_cpuid`](raw_cpuid) crate. It is a goal to support other architectures; PRs are
 //! welcome!
 //!
+//! Note that the library will still compile and work on non x86 architectures, but the result of
+//! all the cache queries will be `None`.
+//!
 //! Check the [Intel 64 and IA-32 Architectures Software Developers Manual](https://software.intel.com/sites/default/files/managed/39/c5/325462-sdm-vol-1-2abcd-3abcd.pdf)
 //! for more information on the `CPUID` instruction.