ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-contrib-iverilog

by jfcherng ST3

This linter plugin for SublimeLinter provides an interface to iverilog (verilog compiler).

Details

Installs

  • Total 2K
  • Win 1K
  • OS X 371
  • Linux 417
Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8 Feb 7 Feb 6 Feb 5 Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5
Windows 0 0 2 2 1 1 0 0 1 1 1 1 0 2 2 0 1 2 2 1 5 1 1 2 0 0 1 0 0 1 2 1 1 1 1 2 4 1 2 6 1 2 0 0 2
OS X 0 1 0 0 0 0 0 0 2 1 1 0 0 0 0 1 0 0 1 1 0 0 0 1 0 0 1 0 0 1 0 0 0 0 0 1 1 0 0 0 0 0 0 1 0
Linux 0 0 0 0 0 0 1 0 0 0 3 0 3 1 0 0 2 1 0 1 2 0 1 1 0 0 0 0 0 0 2 0 1 0 1 0 0 0 0 0 1 0 1 0 2

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-contrib-iverilog

This linter plugin for SublimeLinter provides an interface to iverilog into Sublime Text. To make this plugin work, you need to have iverilog installed. This plugin will be activated with files that have the Verilog syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Verilog syntax highlight is not natively supplied by Sublime Text. You may install Sublime Text Verilog to do the job.

Linter installation

Before installing this plugin, you must ensure that iverilog is installed on your system. To install iverilog, please see this.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won't cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type iverilog. Among the entries you should see SublimeLinter-contrib-iverilog. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

Demo

linting_example

Constraints

If your module references design(s) from other .v file(s), you must use include "module.v" to include them for this linting plugin.

For example, one of ways to do a simulation is iverilog module.v module_t.v -o a.out where module_t.v is a testbench file. This way does not use the include syntax in module_t.v but lists files in the command line. Therefore, you will see Unknown module type: module in module_t.v since this plugin only check the current file. To avoid this, you have to modify module_t.v to include module.v and use iverilog module_t.v -o a.out instead.

include_module_file

You may use “include guard” to prevent from module redefinition.

`ifndef _MODULE_
`define _MODULE_
    // your module design here
`endif

But honestly, this is pretty annoying and iverilog module.v module_t.v -o a.out is more sweet for scripts…

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modifications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don't be afraid to use it.

Thank you for helping out!

Supporters

Thank you guys for sending me some cups of coffee.