Skip to content

Commit

Permalink
Adjust warning.
Browse files Browse the repository at this point in the history
  • Loading branch information
nnethercote committed Feb 4, 2024
1 parent f367925 commit 05c8e86
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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].

Expand All @@ -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
Expand Down
12 changes: 7 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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].
//!
Expand All @@ -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
Expand Down

0 comments on commit 05c8e86

Please sign in to comment.