Move the documentation for the use_heap feature to BUILDING.md.

This commit is contained in:
Brian Smith 2016-07-02 17:22:00 -10:00
parent 636f7dc47f
commit 50e3bf2bc3
3 changed files with 11 additions and 7 deletions

View File

@ -64,6 +64,12 @@ C++ compilers, assemblers, GNU make, msbuild, etc.) for *users* of the crate.
Additional features that are useful for Development
---------------------------------------------------
The `use_heap` feature enables functionality that uses the heap. This is on by
default. Disabling it is useful for code running in kernel space and some
embedded applications. For now some RSA, ECDH, and ECDSA functionality still
uses the heap. This feature will go away once RSA signing is the only feature
that uses the heap.
The `internal_benches` feature enable benchmarks of internal functions. These
benchmarks are only useful for people hacking on the implementation of *ring*.
(The benchmarks for the *ring* API are in the

View File

@ -106,6 +106,11 @@ In addition, we're always interested in these kinds of contributions:
ARM microcontrollers).
* Static analysis and fuzzing in the continuous integration.
Before submitting pull requests, make sure that the tests succeed both when
running `cargo test` and `cargo test --no-default-features`. See
[BUILDING.md](BUILDING.md) for more info about the features flags that are
useful for people hacking on *ring*.
Online Automated Testing

View File

@ -25,13 +25,6 @@
//! supported at runtime. When the `disable_dev_urandom_fallback`
//! feature is enabled, such fallback will not occur. See the
//! documentation for `rand::SystemRandom` for more details.
//! <tr><td><code>use_heap</code>
//! <td>Enable functionality that uses the heap. This is on by default, but
//! disabling it is useful for code running in kernel space and some
//! embedded applications. The goal is to enable as much functionality
//! as is practical in without requiring <code>use_heap</code> mode,
//! but for now some RSA, ECDH, and ECDSA functionality still uses the
//! heap.
//! </table>
#![allow(