VRENAME(1p)
NAME
vrename - change signal names across many Verilog files
SYNOPSIS
vrename <filename_or_directory>...
DESCRIPTION
Vrename will allow a signal to be changed across all levels of the
design hierarchy, or to create a cross reference of signal names. (It
actually includes module names, macros, and other definitions, so those
can be changed too.)
- Vpm uses a three step process. First, use
- vrename --list [<file.v>...] [<directory>....]
- This reads the specified files, or all files below the specified
directory, and creates a signals.vrename file. - Now, edit the signals.vrename file manually to specify the new signal
names. Then, use
vrename --change [<file.v>...] [<directory>....]
ARGUMENTS
vrename takes the following arguments:
- --help
- Displays this message and program version and exits.
- --version
- Displays program version and exits.
- --change
- Take the signals file signals.vrename in the current directory and change the signals in the design as specified by the signals file. Either --list or --change must be specified.
- --changefile {file}
- Use the given filename instead of "signals.vrename".
- --crypt
- With --list, randomize the signal renames. With --change, compress
spaces and comments and apply those renames listed in the file
(presumably created with vrename --list --crypt). - The comment /*ENCRYPT_ME*/ must be included in all files that need
to be encrypted, or use the --cryptall flag. If a signal should
not be encrypted, it can simply be set in the signals.vrename list to be changed to itself. After encrypting, you may want to save
the signals.vrename file so you have a key for decoding, and also
so that it may be used for the next encryption run. When used in
this way for the next encryption run, only new signals will get new encryptions, all other encryptions will be encrypted the same. - --cryptall
- As with --crypt, but put cryptic names into signals.vrename even if the file does not include ENCRYPT_ME. Generally you will then need to edit the signals.vrename file manually to exclude any top level signals that should be preserved.
- --keywords
- Include keywords in the renaming list. Default is to ignore
keywords, as changing a keyword will probably result in unrunnable code, however, occasionally it may be necessary to rename signals
which happen to match the name of keywords recently added to the
language (such as 'bit'). - --list
- Create a list of signals in the design and write to
signals.vrename. Either --list or --change must be specified. - --nowrite
- Don't write the actual changes, just report the files that would be changed.
- --o {dir}
- Use the given directory for output instead of the current
directory. - --read
- Read the changes list, allows --list to append to the changes
already read. - --xref
- Include a cross reference of where the signals are used. --list
must also be specified.
DISTRIBUTION
Verilog-Perl is part of the <http://www.veripool.org/> free Verilog EDA
software tool suite. The latest version is available from CPAN and
from <http://www.veripool.org/verilog-perl>.
Copyright 2000-2010 by Wilson Snyder. This package is free software;
you can redistribute it and/or modify it under the terms of either the
GNU Lesser General Public License Version 3 or the Perl Artistic
License Version 2.0.
AUTHORS
Wilson Snyder <wsnyder@wsnyder.org>
SEE ALSO
- Verilog-Perl, Verilog::Parser