Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brlin-tw/clean-filter-for-verilog

Clean your Verilog design code!
https://github.com/brlin-tw/clean-filter-for-verilog

bash clean-filter filter git git-attributes istyle vdent verilog

Last synced: 17 days ago
JSON representation

Clean your Verilog design code!

Awesome Lists containing this project

README

        

# Clean Filter for Verilog
[![Build Status of the latest revision of project on Travis CI](https://travis-ci.org/Lin-Buo-Ren/Clean-Filter-for-Verilog.svg?branch=master)](https://travis-ci.org/Lin-Buo-Ren/Clean-Filter-for-Verilog)
Clean your Verilog design code!

## How to Use

Clone this repository as your project's submodule, and register `filter.bash` as verilog source files' clean filter. Refer the `filter` attribute in the `gitattributes(5)` manual page for more information.

Several runtime configurable options are available, refer the output of `filter.bash --help` for more info.

## Supported Cleaners

The executable path of the following cleaners must be in the executable search `PATH`s.

### vdent

[bmartini/vdent: Verilog Indenter. Simple indent program for Verilog source code. Trims end of line white space and indents lines based on nested depth of code blocks.](https://github.com/bmartini/vdent)

This is the default cleaner.

### iStyle

[thomasrussellmurphy/istyle-verilog-formatter: Open source implementation of a Verilog formatter](https://github.com/thomasrussellmurphy/istyle-verilog-formatter)

Use `--cleaner istyle` to enable this cleaner.

## License

GNU GPLv3+