# vfilt: a tool for filtering Vivado output

The intention for this tool is to reduce the endless spam generated by running
Vivado down to something useful.

This project is in a very early stage, and contributions are welcome - see
[`CONTRIBUTING.md`](CONTRIBUTING.md) for help getting started.

## Building

vfilt is built with Cargo, the standard Rust build tool.

Use `cargo build` to compile, and the resulting binary can be found in
`target/debug/vfilt`. You can also run `cargo build --release` for a release
build.

This is intended to build only with the latest stable release of Rust.

## Documentation

No documentation yet - try running `vfilt --help`.

## Features

This section is more of a "wish list" than stuff that's currently implemented.

* Per-directory filter levels, so you configure output from third-party IP.
* Colourised output
* Git integration - specify a base branch, and it will only show output
  resulting from changes between the current branch and the base branch.

There is a default list of "useless" critical warnings, "useful" info messages,
and everything in between. You can override any of these in a repository config
file, or in your global config file.

Errors are always displayed no matter what output settings you've configured.
 
## Usage

This section is more "intended usage" than actual usage.

If run with no arguments, or "-" as a file argument, vfilt will read from
stdin. Otherwise, it will filter

Command-line options override repository-specific configuration, which in turn
overrides global configuration.

Run `vfilt --help` for more details.