Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.64 KB

README.md

File metadata and controls

45 lines (31 loc) · 1.64 KB
Raw

This project is a small collection of data structures for working with Valgrind suppression files.

Installation

This project uses the following software:

Valgrind itself is not technically a requirement, but it is recommended to install Valgrind anyway.

You will need the latest dev build of Rust. You can either download a nightly build of the Rust compiler and tools from http://www.rust-lang.org/install.html or clone the GitHub repository, rust-lang/rust, and build from source. On Mac, it is recommended to use Homebrew's rust formula:

# first installation
brew install rust --HEAD

# update
brew reinstall rust --HEAD

To install Cargo, you will need to build from source. See Compiling cargo for instructions. Homebrew users can automate the work of building from source using the cargo formula from the https://github.com/dtrebbien/homebrew-misc tap:

# first installation
brew tap dtrebbien/misc
brew install cargo --HEAD

# update
brew reinstall cargo --HEAD

With the dependencies installed, the valgrind crate is built by running:

cargo build

To generate the HTML documentation, run:

rustdoc --output doc -w html src/valgrind.rs

License

The valgrind crate source code is licensed under the GNU Lesser General Public License, either version 3 of the LGPL, or (at your option) any later version.