Rename tools prefix with verible-.

The tool names used to be overly generic ('verilog_lint'), so
add the verible prefix to disambiguate them from other tools.
Also use dashes instead of underscores because they look prettier :)

Since tools are intended to possibly support more languages in
the future, we continue with also including 'verilog' in it.
(Decision was to keep the language name in the tool rather than
have a flag choose the language.)

Names are now verible-verilog-lint, verible-verilog-format, ...

For backward compatibility: the old names are still present
for now: there are short shell-scripts with the old name
that invoke the new tools for a transition period
(initially silently, later they might start to write
a warning message to stderr before being decommissioned
after some time).

Fixes: #169
PiperOrigin-RevId: 315524811

.github/travis/github-pages-setup.sh

@@ -48,9 +48,9 @@ See the [README file for further information.](README.md)
 
 ## Tools
 
- * [verilog_lint Info](verilog_lint.md)
- * [verilog_format Info](verilog_format.md)
- * [verilog_syntax Info](verilog_syntax.md)
+ * [verible-verilog-lint Info](verilog_lint.md)
+ * [verible-verilog-format Info](verilog_format.md)
+ * [verible-verilog-syntax Info](verilog_syntax.md)
 
 ## Information
 
@@ -77,27 +77,27 @@ wget https://raw.githubusercontent.com/IQAndreas/markdown-licenses/master/apache
 
 # Generate lint rules documentation
 # --------------------------------
-bazel-bin/verilog/tools/lint/verilog_lint -generate_markdown > $PAGES_DIR/lint.md
+bazel-bin/verilog/tools/lint/verible-verilog-lint -generate_markdown > $PAGES_DIR/lint.md
 cat >> $PAGES_DIR/lint.md <<EOF
 
 ## Version
 
 Generated on $GIT_DATE from [$GIT_VERSION](https://github.com/$REPO_SLUG/commit/$GIT_HASH)
 EOF
 
-# Generate docs for verilog_syntax
+# Generate docs for verible-verilog-syntax
 # --------------------------------
 SYNTAX_DOC=$PAGES_DIR/verilog_syntax.md
 cat > $SYNTAX_DOC <<EOF
-# \`verilog_syntax\`
+# \`verible-verilog-syntax\`
 
 Tool for looking at the syntax of Verilog and SystemVerilog code. Part of the
 verible tool suite.
 
 ## Command line arguments
 \`\`\`
 EOF
-bazel-bin/verilog/tools/syntax/verilog_syntax -helpfull >> $SYNTAX_DOC
+bazel-bin/verilog/tools/syntax/verible-verilog-syntax -helpfull >> $SYNTAX_DOC
 cat >> $SYNTAX_DOC <<EOF
 \`\`\`
 
@@ -107,11 +107,11 @@ Generated on $GIT_DATE from [$GIT_VERSION](https://github.com/$REPO_SLUG/commit/
 EOF
 
 
-# Generate docs for verilog_lint
+# Generate docs for verible-verilog-lint
 # --------------------------------
 LINT_DOC=$PAGES_DIR/verilog_lint.md
 cat > $LINT_DOC <<EOF
-# \`verilog_lint\`
+# \`verible-verilog-lint\`
 
 Tool for formatting Verilog and SystemVerilog code. Part of the verible tool
 suite.
@@ -120,34 +120,34 @@ suite.
 
 \`\`\`
 EOF
-bazel-bin/verilog/tools/lint/verilog_lint -helpfull >> $LINT_DOC
+bazel-bin/verilog/tools/lint/verible-verilog-lint -helpfull >> $LINT_DOC
 cat >> $LINT_DOC <<'EOF'
 ```
 
 ## Lint Rules
 
 EOF
-bazel-bin/verilog/tools/lint/verilog_lint -generate_markdown >> $LINT_DOC
+bazel-bin/verilog/tools/lint/verible-verilog-lint -generate_markdown >> $LINT_DOC
 cat >> $LINT_DOC <<EOF
 
 ## Version
 
 Generated on $GIT_DATE from [$GIT_VERSION](https://github.com/$REPO_SLUG/commit/$GIT_HASH)
 EOF
 
-# Generate docs for verilog_format
+# Generate docs for verible-verilog-format
 # --------------------------------
 FORMAT_DOC=$PAGES_DIR/verilog_format.md
 cat > $FORMAT_DOC <<EOF
-# \`verilog_format\`
+# \`verible-verilog-format\`
 
 Tool for formatting Verilog and SystemVerilog code. Part of the verible tool
 suite.
 
 ## Command line arguments
 \`\`\`
 EOF
-bazel-bin/verilog/tools/formatter/verilog_format -helpfull >> $FORMAT_DOC
+bazel-bin/verilog/tools/formatter/verible-verilog-format -helpfull >> $FORMAT_DOC
 cat >> $FORMAT_DOC <<EOF
 \`\`\`
 

BUILD

@@ -15,21 +15,28 @@ exports_files([
 installer(
     name = "install",
     data = [
-        "//verilog/tools/diff:verilog_diff",
-        "//verilog/tools/formatter:git_verilog_format",
-        "//verilog/tools/formatter:verilog_format",
-        "//verilog/tools/lint:verilog_lint",
-        "//verilog/tools/obfuscator:verilog_obfuscate",
-        "//verilog/tools/syntax:verilog_syntax",
+        "//verilog/tools/diff:verible-verilog-diff",
+        "//verilog/tools/formatter:git-verilog-format",
+        "//verilog/tools/formatter:verible-verilog-format",
+        "//verilog/tools/lint:verible-verilog-lint",
+        "//verilog/tools/obfuscator:verible-verilog-obfuscate",
+        "//verilog/tools/syntax:verible-verilog-syntax",
+
+        # Deprecated legacy names, available for a transition period
+        "//verilog/tools/diff:verilog_diff-deprecated",
+        "//verilog/tools/lint:verilog_lint-deprecated",
+        "//verilog/tools/syntax:verilog_syntax-deprecated",
+        "//verilog/tools/formatter:verilog_format-deprecated",
+        "//verilog/tools/obfuscator:verilog_obfuscate-deprecated",
     ],
 )
 
 genrule(
     name = "lint_doc",
     outs = ["documentation_verible_lint_rules.md"],
-    cmd = "$(location //verilog/tools/lint:verilog_lint) --generate_markdown " +
-          "> $(OUTS)",
+    cmd = "$(location //verilog/tools/lint:verible-verilog-lint) " +
+          "--generate_markdown > $(OUTS)",
     tools = [
-        "//verilog/tools/lint:verilog_lint",
+        "//verilog/tools/lint:verible-verilog-lint",
     ],
 )

README.md

@@ -30,8 +30,9 @@ bazel build -c opt //...
 ```
 
 You can access the generated artifacts under `bazel-bin/`. For instance the
-syntax checker will be at `bazel-bin/verilog/tools/syntax/verilog_syntax`
-(corresponding to the target name `//verilog/tools/syntax:verilog_syntax`).
+syntax checker will be at
+`bazel-bin/verilog/tools/syntax/verible-verilog-syntax` (corresponding to the
+target name `//verilog/tools/syntax:verible-verilog-syntax`).
 
 ### Installation
 
@@ -40,8 +41,9 @@ For simple installation, we provide regular [binary releases].
 If you prefer to install the binaries on your workstation yourself, use the
 `:install` target which you invoke with `bazel run`.
 
-The following builds and installs the `verilog_format`, `verilog_lint` and
-`verilog_syntax` binaries in the provided location:
+The following builds and installs the `verible-verilog-format`,
+`verible-verilog-lint` and `verible-verilog-syntax` binaries in the provided
+location:
 
 ```bash
 # In your home directory
@@ -91,10 +93,10 @@ preprocessing, and context-based lexical disambiguation (with arbitrary
 lookahead) where required by the language.
 
 The parser can be tested as a standalone program,
-`//verilog/tools/syntax:verilog_syntax`.
+`//verilog/tools/syntax:verible-verilog-syntax`.
 
 ```
-verilog_syntax: usage: verilog_syntax [options] <file> [<file>...]
+verible-verilog-syntax: usage: verible-verilog-syntax [options] <file> [<file>...]
 
   Flags from verilog/tools/syntax/verilog_syntax.cc:
     -printrawtokens (Prints all lexed tokens, including filtered ones.);
@@ -138,9 +140,9 @@ Available parser selection modes include:
 #### Token Stream
 
 The lexer partitions a text buffer into a sequence of tokens with annotations
-(token stream). `verilog_syntax --printtokens` shows the tokens that feeds into
-the parser, and `--printrawtokens` to shows all tokens including whitespaces,
-comments, and attributes.
+(token stream). `verible-verilog-syntax --printtokens` shows the tokens that
+feeds into the parser, and `--printrawtokens` to shows all tokens including
+whitespaces, comments, and attributes.
 
 For example, the following code:
 
@@ -197,7 +199,7 @@ lossless with respect to the original input text.
 #### Concrete Syntax Tree
 
 The parser produces a concrete syntax tree (CST), which can be diagnosed with
-`verilog_syntax --printtree`.
+`verible-verilog-syntax --printtree`.
 
 For example, the following code (same as above):
 
@@ -207,7 +209,7 @@ module foo(input a, b, output z);
 endmodule : foo
 ```
 
-produces this CST (rendered by `verilog_syntax --printtree`):
+produces this CST (rendered by `verible-verilog-syntax --printtree`):
 
 ```
 Parse Tree:
@@ -296,10 +298,10 @@ bazel build :lint_doc
 bazel-bin/documentation_verible_lint_rules.md
 ```
 
-The linter tool is available as `//verilog/tools/lint:verilog_lint`.
+The linter tool is available as `//verilog/tools/lint:verible-verilog-lint`.
 
 ```
-verilog_lint: usage: verilog_lint [options] <file> [<file>...]
+verible-verilog-lint: usage: verible-verilog-lint [options] <file> [<file>...]
 
   Flags from verilog/analysis/verilog_linter.cc:
     --rules (Comma-separated of lint rules to enable. No prefix or a '+' prefix
@@ -338,7 +340,7 @@ the [`line-length`][lint-rule-list_line-length] rule (80 characters length) and
 disables the [`no-tabs`][lint-rule-list_no-tabs] rule.
 
 ```
-verilog_lint --rules=enum-name-style,+line-length=length:80,-no-tabs ...
+verible-verilog-lint --rules=enum-name-style,+line-length=length:80,-no-tabs ...
 ```
 
 Additionally, the `--rules_config` flag can be used to read configuration stored
@@ -408,10 +410,11 @@ with a particular style. The main goal is to relieve humans of having to
 manually manage whitespace, wrapping, and indentation, and to provide a tool
 that can be integrated into any editor to enable editor-independent consistency.
 
-The formatter tool is available as `//verilog/tools/formatter:verilog_format`.
+The formatter tool is available as
+`//verilog/tools/formatter:verible-verilog-format`.
 
 ```
-verilog_format: usage: verilog_format [options] <file>
+verible-verilog-format: usage: verible-verilog-format [options] <file>
 To pipe from stdin, use '-' as <file>.
 
   Flags from verilog/tools/formatter/verilog_format.cc:
@@ -478,29 +481,29 @@ formatting), the following tools are provided to assist.
 
 ##### Git users
 
-`git-verilog_format.sh` (installed along with `verilog_format`) can be run from
-within any subdirectory of a Git project. It automatically detects new and
-changed lines, and generates the `--lines` flag for each modified file in your
-workspace.
+`git-verible-verilog-format.sh` (installed along with `verible-verilog-format`)
+can be run from within any subdirectory of a Git project. It automatically
+detects new and changed lines, and generates the `--lines` flag for each
+modified file in your workspace.
 
 From `--help`:
 
 ```
-git-verilog_format.sh:
-Performs incremental file formatting (verilog_format) based on current diffs.
+git-verible-verilog-format.sh:
+Performs incremental file formatting (verible-verilog-format) based on current diffs.
 New files explicitly git-add-ed by the user are wholly formatted.
 
 Actions:
   1) Runs 'git add -u' to stage currently modified files to the index.
      To format new files (wholly), 'git add' those before calling this script.
   2) Runs 'git diff -u --cached' to generate a unified diff.
   3) Diff is scanned to determine added or modified lines in each file.
-  4) Invokes 'verilog_format --inplace' on all touched or new Verilog files,
+  4) Invokes 'verible-verilog-format --inplace' on all touched or new Verilog files,
      but does not 'git add' so that the changes may be examined and tested.
      Formatting can be easily undone with:
        'git diff | git apply --reverse -'.
 
-usage: git-verilog_format.sh [script options] [-- [verilog_format options]]
+usage: git-verible-verilog-format.sh [script options] [-- [verilog_format options]]
   (no positional arguments)
   Run from anywhere inside a git project tree.
 
@@ -509,18 +512,18 @@ script options: (options with arguments can be: --flag=VALUE or --flag VALUE)
   --verbose | -v : execute verbosely
   --dry-run : stop before running formatter, and print formatting commands
   --formatter TOOL : path to verilog_format binary
-       [using: /usr/local/bin/verilog_format]
+       [using: /usr/local/bin/verible-verilog-format]
   -- : stops option processing, and forwards remaining args as flags to the
        underlying --formatter tool.
 ```
 
 ### Lexical Diff
 
-`verilog_diff` compares two input files for equivalence, where equivalence is
-determined by the `--mode` of operation.
+`verible-verilog-diff` compares two input files for equivalence, where
+equivalence is determined by the `--mode` of operation.
 
 ```
-verilog_diff: usage: verilog_diff [options] file1 file2
+verible-verilog-diff: usage: verible-verilog-diff [options] file1 file2
 
   Flags from verilog/tools/diff/verilog_diff.cc:
     --mode (Defines difference functions.
@@ -539,17 +542,17 @@ Exit codes:
 
 ### Code Obfuscator
 
-`verilog_obfuscate` transforms Verilog code by replacing identifiers with
-obfuscated names of equal length, and preserving all other text, including
+`verible-verilog-obfuscate` transforms Verilog code by replacing identifiers
+with obfuscated names of equal length, and preserving all other text, including
 spaces. Output is written to stdout. The resulting file size is the same as the
 original.
 
 This is useful for preparing potentially sensitive test cases with tool vendors.
 
 ```
-verilog_obfuscate: usage: verilog_obfuscate [options] < original_file > output
+verible-verilog-obfuscate: usage: verible-verilog-obfuscate [options] < original_file > output
 
-verilog_obfuscate mangles Verilog code by changing identifiers.
+verible-verilog-obfuscate mangles Verilog code by changing identifiers.
 All whitespaces and identifier lengths are preserved.
 Output is written to stdout.
 

verilog/tools/diff/BUILD

@@ -4,7 +4,7 @@
 licenses(["notice"])
 
 cc_binary(
-    name = "verilog_diff",
+    name = "verible-verilog-diff",
     srcs = ["verilog_diff.cc"],
     visibility = ["//visibility:public"],
     deps = [
@@ -17,3 +17,15 @@ cc_binary(
         "@com_google_absl//absl/strings",
     ],
 )
+
+# For a limited time, we provide the old name to be compatible with the
+# old installation. At some point, this script will print a deprecation warning
+# and be removed entirely later.
+filegroup(
+    name = "verilog_diff-deprecated",
+    srcs = [
+        "verilog_diff",
+        ":verible-verilog-diff",
+    ],
+    visibility = ["//visibility:public"],
+)

verilog/tools/diff/verilog_diff

@@ -0,0 +1,20 @@
+#!/bin/sh
+# Copyright 2020 The Verible Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Adapter script to allow using the legacy name.
+#
+# Beware, this will go away, please change your scripts to call the new stable
+# name verible-verilog-diff instead.
+exec "$(dirname $(realpath $0))/verible-verilog-diff" "$@"