More specific names: Adding 'verible-' prefix to tool names.

36 views
Skip to first unread message

Henner Zeller

unread,
Jun 11, 2020, 2:20:15 PM6/11/20
to verib...@googlegroups.com, veribl...@googlegroups.com
TL;DR: tools renamed to be more specific; old names still work.

Hi,
Since the early days, the verible tools had somewhat generic names,
such as 'verilog_lint', 'verilog_format', 'verilog_syntax'. This
sounds overly generic and overly authoritative at the same time (see
also bug in [1]).

So in git commit [2], these have now been renamed to more specific
verible-verilog-lint, verible-verilog-format, ...

The old names continue to work, so no immediate change of your scripts
and Makefiles needed:
if you use the regular bazel install procedure or the releases [3],
there are also shell-scripts installed with the old names that call
the new tool.

Longer term (like in half a year), I think it is good to phase them
out, but there will be a warning message by these tools beforehand. If
you use verible tools now, consider changing your scripts to use the
new name once you have switched to a newer release [3].

Cheers,
Henner.

[1]: https://github.com/google/verible/issues/169
[2]: https://github.com/google/verible/commit/a6d36642f30bacefef405c00ba770b582eb1b2bb
[3]: https://github.com/google/verible/releases

Henner Zeller

unread,
Sep 14, 2020, 6:09:50 PM9/14/20
to verib...@googlegroups.com, veribl...@googlegroups.com
> The old names continue to work, so no immediate change of your scripts
> and Makefiles needed:
> if you use the regular bazel install procedure or the releases [3],
> there are also shell-scripts installed with the old names that call
> the new tool.
>
> Longer term (like in half a year), I think it is good to phase them
> out, but there will be a warning message by these tools beforehand.

Starting from now, if the _old_ names of the binaries are invoked,
there is a warning message
emitted, pointing to the new name.

No functional change: invoking the tools with their old names will
continue to work for now.
https://github.com/google/verible/commit/876c18b0d6f2dd6d476e3f728315260b90b01a5c

Cheers,
Henner.
Reply all
Reply to author
Forward
0 new messages