1VRENAME(1) User Contributed Perl Documentation VRENAME(1)
2
6 vrename - change signal names across many Verilog files
7
9 vrename <filename_or_directory>...
10
12 Vrename will allow a signal to be changed across all levels of the
13 design hierarchy, or to create a cross reference of signal names. (It
14 actually includes module names, macros, and other definitions, so those
15 can be changed too.)
16 Vpm uses a three step process. First, use
18 vrename --list [<file.v>...] [<directory>....]
20 This reads the specified files, or all files below the specified
22 directory, and creates a signals.vrename file.
23 Now, edit the signals.vrename file manually to specify the new signal
25 names. Then, use
26 vrename --change [<file.v>...] [<directory>....]
28
30 vrename takes the following arguments:
31 --help
33 Displays this message and program version and exits.
34 --version
36 Displays program version and exits.
37 --change
39 Take the signals file signals.vrename in the current directory and
40 change the signals in the design as specified by the signals file.
41 Either --list or --change must be specified.
42 --changefile {file}
44 Use the given filename instead of "signals.vrename".
45 --changelang
47 Include in the signals.vrename file the template needed to change
48 the language standard for the file. For the first run, use "--list
49 --changelang" and --language to specify the file's original
50 language, then rerun with the "--change" option. The files will
51 get escaped identifiers for the most recent Verilog standard. For
52 example with --language 1364-2005, "do" will become "\do ".
53 --crypt
55 With --list, randomize the signal renames. With --change, compress
56 spaces and comments and apply those renames listed in the file
57 (presumably created with vrename --list --crypt).
58 The comment /*ENCRYPT_ME*/ must be included in all files that need
60 to be encrypted, or use the --cryptall flag. If a signal should
61 not be encrypted, it can simply be set in the signals.vrename list
62 to be changed to itself. After encrypting, you may want to save
63 the signals.vrename file so you have a key for decoding, and also
64 so that it may be used for the next encryption run. When used in
65 this way for the next encryption run, only new signals will get new
66 encryptions, all other encryptions will be encrypted the same.
67 --cryptall
69 As with --crypt, but put cryptic names into signals.vrename even if
70 the file does not include ENCRYPT_ME. Generally you will then need
71 to edit the signals.vrename file manually to exclude any top level
72 signals that should be preserved.
73 --keywords
75 Include keywords in the renaming list. Default is to ignore
76 keywords, as changing a keyword will probably result in unrunnable
77 code, however, occasionally it may be necessary to rename signals
78 which happen to match the name of keywords recently added to the
79 language (such as 'bit').
80 --language
82 <1364-1995|1364-2001|1364-2005|1800-2005|1800-2009|1800-2012|1800-2017>
83 Set the language standard for the files. This determines which
84 tokens are signals versus keywords, such as the ever-common "do"
85 (data-out signal, versus a do-while loop keyword).
86 --list
88 Create a list of signals in the design and write to
89 signals.vrename. Either --list or --change must be specified.
90 --nowrite
92 Don't write the actual changes, just report the files that would be
93 changed.
94 --o {dir}
96 Use the given directory for output instead of the current
97 directory.
98 --read
100 Read the changes list, allows --list to append to the changes
101 already read.
102 --xref
104 Include a cross reference of where the signals are used. --list
105 must also be specified.
106
108 Verilog-Perl is part of the <http://www.veripool.org/> free Verilog EDA
109 software tool suite. The latest version is available from CPAN and
110 from <http://www.veripool.org/verilog-perl>.
111 Copyright 2000-2018 by Wilson Snyder. This package is free software;
113 you can redistribute it and/or modify it under the terms of either the
114 GNU Lesser General Public License Version 3 or the Perl Artistic
115 License Version 2.0.
116
118 Wilson Snyder <wsnyder@wsnyder.org>
119
121 Verilog-Perl, Verilog::Parser
122perl v5.28.0 2018-10-28 VRENAME(1)