diff --git a/README.md b/README.md index e126fad..8ad5b24 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # dhat-rs +**Warning** *This crate is experimental. It relies on implementation techniques +that are hard to keep working for 100% of configuratios. It may work fine for +you, or it may crash, hang, or otherwise do the wrong thing. Its maintenance is +not a high priority of the author. Support requests such as issues and pull +requests may receive slow responses, or no response at all. Sorry!* + This crate provides heap profiling and ad hoc profiling capabilities to Rust programs, similar to those provided by [DHAT]. @@ -17,11 +23,6 @@ See the [crate documentation] for details on how to use it. [crate documentation]: https://docs.rs/dhat -**Warning: this crate is experimental and doesn't work in some configurations. -Its maintenance is not a high priority of the author. Support requests such as -issues and pull requests may receive slow responses, or no response at all. -Sorry!** - ## License Licensed under either of diff --git a/src/lib.rs b/src/lib.rs index 417467f..7d3929a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,6 +2,13 @@ #![deny(rustdoc::missing_doc_code_examples)] #![deny(missing_debug_implementations)] +//! **Warning** *This crate is experimental. It relies on implementation +//! techniques that are hard to keep working for 100% of configuratios. It may +//! work fine for you, or it may crash, hang, or otherwise do the wrong thing. +//! Its maintenance is not a high priority of the author. Support requests such +//! as issues and pull requests may receive slow responses, or no response at +//! all. Sorry!* +//! //! This crate provides heap profiling and [ad hoc profiling] capabilities to //! Rust programs, similar to those provided by [DHAT]. //! @@ -21,11 +28,6 @@ //! then check that they allocated as much heap memory as you expected. This //! can be useful for performance-sensitive code. //! -//! **Warning: this crate is experimental and doesn't work in some -//! configurations. Its maintenance is not a high priority of the author. -//! Support requests such as issues and pull requests may receive slow -//! responses, or no response at all. Sorry!** -//! //! # Motivation //! //! DHAT is a powerful heap profiler that comes with Valgrind. This crate is a