Mercurial > emacs
diff lisp/progmodes/verilog-mode.el @ 91941:125866467ba5
(customize): Fix typo in error message.
(verilog-mode, verilog-mode-indent, verilog-mode-actions, verilog-mode-auto,
verilog-indent-level-module, verilog-minimum-comment-distance,
verilog-library-flags, verilog-library-directories, verilog-library-files,
verilog-auto-reset-widths, verilog-imenu-generic-expression,
verilog-xemacs-menu, verilog-set-compile-command, verilog-set-compile-command,
verilog-mode-syntax-table, verilog-mode, verilog-get-expr,
verilog-strip-comments, verilog-one-line, verilog-lint-off, verilog-batch-auto,
verilog-batch-delete-auto, verilog-batch-inject-auto, verilog-batch-indent,
verilog-continued-line, verilog-type-keywords, verilog-read-sub-decls-sig,
verilog-read-sub-decls-line, verilog-read-inst-pins, verilog-read-arg-pins,
verilog-read-auto-template, verilog-read-signals, verilog-getopt-file,
verilog-add-list-unique, verilog-symbol-detick, verilog-modi-filename,
verilog-auto-star, verilog-auto-inst, verilog-auto-wire, verilog-enum-ascii,
verilog-sk-begin, verilog-sk-fork, verilog-sk-datadef,
verilog-colorize-include-files-buffer, verilog-mode-version,
verilog-mode-release-date, verilog-mode-release-emacs, verilog-linter,
verilog-coverage, verilog-simulator, verilog-compiler,
verilog-auto-sense-defines-constant, verilog-company, verilog-project,
verilog-mark-defun, verilog-submit-bug-report): Fix typos in docstrings.
(verilog-set-auto-endcomments, verilog-calculate-indent, verilog-inject-auto,
verilog-auto-arg, verilog-auto-inout-module): Reflow docstrings.
(verilog-tab-always-indent, verilog-highlight-p1800-keywords,
verilog-auto-star-save, verilog-auto-inst-vector, verilog-mode-hook,
electric-verilog-forward-sexp, verilog-in-case-region-p,
verilog-in-struct-region-p, verilog-in-generate-region-p, verilog-leap-to-head,
verilog-current-indent-level, verilog-case-indent-level, verilog-cpp-keywords,
verilog-defun-keywords, verilog-block-keywords, verilog-tf-keywords,
verilog-case-keywords, verilog-separator-keywords, verilog-completion,
verilog-signals-not-in, verilog-symbol-detick-text,
verilog-modi-cache-preserve-tick, verilog-modi-cache-preserve-buffer,
verilog-forward-close-paren, verilog-backward-open-paren,
verilog-backward-open-bracket): Doc fixes.
| author | Juanma Barranquero <lekktu@gmail.com> |
|---|---|
| date | Mon, 18 Feb 2008 15:39:33 +0000 |
| parents | 5c60e04e322f |
| children | 2e44cd9cc88a |
line wrap: on
line diff
--- a/lisp/progmodes/verilog-mode.el Mon Feb 18 15:36:39 2008 +0000 +++ b/lisp/progmodes/verilog-mode.el Mon Feb 18 15:39:33 2008 +0000 @@ -70,7 +70,7 @@ ;; <http://www.verilog.com/emacs_install.html> ;; The short list of installation instructions are: To set up -;; automatic verilog mode, put this file in your load path, and put +;; automatic Verilog mode, put this file in your load path, and put ;; the following in code (please un comment it first!) in your ;; .emacs, or in your site's site-load.el @@ -108,7 +108,7 @@ ;; ;;; History: -;; +;; ;; See commit history at http://www.veripool.com/verilog-mode.html ;; (This section is required to appease checkdoc.) @@ -116,11 +116,11 @@ ;; This variable will always hold the version number of the mode (defconst verilog-mode-version "383" - "Version of this verilog mode.") + "Version of this Verilog mode.") (defconst verilog-mode-release-date "2008-01-07-GNU" - "Release date of this verilog mode.") + "Release date of this Verilog mode.") (defconst verilog-mode-release-emacs t - "If non-nil, this version of verilog mode was released with Emacs itself.") + "If non-nil, this version of Verilog mode was released with Emacs itself.") (defun verilog-version () "Inform caller of the version of this file." @@ -203,7 +203,7 @@ (defmacro defgroup (&rest args) nil) (defmacro customize (&rest args) (message - "Sorry, Customize is not available with this version of emacs")) + "Sorry, Customize is not available with this version of Emacs")) (defmacro defcustom (var value doc &rest args) `(defvar ,var ,value ,doc)) ) @@ -282,7 +282,7 @@ (or (equal value t) (equal value nil))) (defgroup verilog-mode nil - "Facilitates easy editing of Verilog source text" + "Facilitates easy editing of Verilog source text." :group 'languages) ; (defgroup verilog-mode-fonts nil @@ -291,20 +291,20 @@ ; :group 'verilog-mode) (defgroup verilog-mode-indent nil - "Customize indentation and highlighting of verilog source text" + "Customize indentation and highlighting of Verilog source text." :group 'verilog-mode) (defgroup verilog-mode-actions nil - "Customize actions on verilog source text" + "Customize actions on Verilog source text." :group 'verilog-mode) (defgroup verilog-mode-auto nil - "Customize AUTO actions when expanding verilog source text" + "Customize AUTO actions when expanding Verilog source text." :group 'verilog-mode) (defcustom verilog-linter "echo 'No verilog-linter set, see \"M-x describe-variable verilog-linter\"'" - "*Unix program and arguments to call to run a lint checker on verilog source. + "*Unix program and arguments to call to run a lint checker on Verilog source. Depending on the `verilog-set-compile-command', this may be invoked when you type \\[compile]. When the compile completes, \\[next-error] will take you to the next lint error." @@ -314,7 +314,7 @@ (defcustom verilog-coverage "echo 'No verilog-coverage set, see \"M-x describe-variable verilog-coverage\"'" - "*Program and arguments to use to annotate for coverage verilog source. + "*Program and arguments to use to annotate for coverage Verilog source. Depending on the `verilog-set-compile-command', this may be invoked when you type \\[compile]. When the compile completes, \\[next-error] will take you to the next lint error." @@ -324,7 +324,7 @@ (defcustom verilog-simulator "echo 'No verilog-simulator set, see \"M-x describe-variable verilog-simulator\"'" - "*Program and arguments to use to interpret verilog source. + "*Program and arguments to use to interpret Verilog source. Depending on the `verilog-set-compile-command', this may be invoked when you type \\[compile]. When the compile completes, \\[next-error] will take you to the next lint error." @@ -334,7 +334,7 @@ (defcustom verilog-compiler "echo 'No verilog-compiler set, see \"M-x describe-variable verilog-compiler\"'" - "*Program and arguments to use to compile verilog source. + "*Program and arguments to use to compile Verilog source. Depending on the `verilog-set-compile-command', this may be invoked when you type \\[compile]. When the compile completes, \\[next-error] will take you to the next lint error." @@ -370,7 +370,7 @@ (put 'verilog-indent-level 'safe-local-variable 'integerp) (defcustom verilog-indent-level-module 3 - "*Indentation of Module level Verilog statements. (eg always, initial) + "*Indentation of Module level Verilog statements (eg always, initial). Set to 0 to get initial and always statements lined up on the left side of your screen." :group 'verilog-mode-indent @@ -451,7 +451,7 @@ (defcustom verilog-tab-always-indent t "*True means TAB should always re-indent the current line. -Nil means TAB will only reindent when at the beginning of the line." +A nil value means TAB will only reindent when at the beginning of the line." :group 'verilog-mode-indent :type 'boolean) (put 'verilog-tab-always-indent 'safe-local-variable 'verilog-booleanp) @@ -480,7 +480,7 @@ (defcustom verilog-minimum-comment-distance 10 "*Minimum distance (in lines) between begin and end required before a comment. Setting this variable to zero results in every end acquiring a comment; the -default avoids too many redundant comments in tight quarters" +default avoids too many redundant comments in tight quarters." :group 'verilog-mode-indent :type 'integer) (put 'verilog-minimum-comment-distance 'safe-local-variable 'integerp) @@ -530,9 +530,9 @@ "*True means highlight words newly reserved by IEEE-1800. These will appear in `verilog-font-lock-p1800-face' in order to gently suggest changing where these words are used as variables to something else. -Nil means highlight these words as appropriate for the SystemVerilog +A nil value means highlight these words as appropriate for the SystemVerilog IEEE-1800 standard. Note that changing this will require restarting Emacs -to see the effect as font color choices are cached by Emacs" +to see the effect as font color choices are cached by Emacs." :group 'verilog-mode-indent :type 'boolean) (put 'verilog-highlight-p1800-keywords 'safe-local-variable 'verilog-booleanp) @@ -577,8 +577,8 @@ (defcustom verilog-auto-star-save nil "*Non-nil indicates to save to disk SystemVerilog .* instance expansions. -Nil indicates direct connections will be removed before saving. Only -meaningful to those created due to `verilog-auto-star-expand' being set. +A nil value indicates direct connections will be removed before saving. +Only meaningful to those created due to `verilog-auto-star-expand' being set. Instead of setting this, you may want to use /*AUTOINST*/, which will always be saved." @@ -624,7 +624,7 @@ ; Leda ("In file \\([^ \t]+\\)[ \t]+line[ \t]+\\([0-9]+\\):\n[^\n]*\n[^\n]*\n\\[\\(Warning\\|Error\\|Failure\\)\\][^\n]*" 1 2) ) -; "*List of regexps for verilog compilers, like verilint. See compilation-error-regexp-alist for the formatting." +; "*List of regexps for Verilog compilers, like verilint. See compilation-error-regexp-alist for the formatting." ) (defvar verilog-error-font-lock-keywords @@ -697,7 +697,7 @@ // End: Verilog-mode attempts to detect changes to this local variable, but they -are only insured to be correct when the file is first visited. Thus if you +are only insured to be correct when the file is first visited. Thus if you have problems, use \\[find-alternate-file] RET to have these take effect. See also the variables mentioned above." @@ -719,7 +719,7 @@ // End: Verilog-mode attempts to detect changes to this local variable, but they -are only insured to be correct when the file is first visited. Thus if you +are only insured to be correct when the file is first visited. Thus if you have problems, use \\[find-alternate-file] RET to have these take effect. See also `verilog-library-flags', `verilog-library-files' @@ -742,7 +742,7 @@ // End: Verilog-mode attempts to detect changes to this local variable, but they -are only insured to be correct when the file is first visited. Thus if you +are only insured to be correct when the file is first visited. Thus if you have problems, use \\[find-alternate-file] RET to have these take effect. See also `verilog-library-flags', `verilog-library-directories'." @@ -777,7 +777,7 @@ "*If true, AUTOSENSE should assume all defines represent constants. When true, the defines will not be included in sensitivity lists. To maintain compatibility with other sites, this should be set at the bottom -of each verilog file that requires it, rather than being set globally." +of each Verilog file that requires it, rather than being set globally." :group 'verilog-mode-auto :type 'boolean) (put 'verilog-auto-sense-defines-constant 'safe-local-variable 'verilog-booleanp) @@ -787,7 +787,7 @@ This is then used to set the width of the zero (32'h0 for example). This is required by some lint tools that aren't smart enough to ignore widths of the constant zero. This may result in ugly code when parameters determine -the MSB or LSB of a signal inside a AUTORESET." +the MSB or LSB of a signal inside an AUTORESET." :type 'boolean :group 'verilog-mode-auto) (put 'verilog-auto-reset-widths 'safe-local-variable 'verilog-booleanp) @@ -802,8 +802,8 @@ "*If true, when creating default ports with AUTOINST, use bus subscripts. If nil, skip the subscript when it matches the entire bus as declared in the module (AUTOWIRE signals always are subscripted, you must manually -declare the wire to have the subscripts removed.) Nil may speed up some -simulators, but is less general and harder to read, so avoid." +declare the wire to have the subscripts removed.) Setting this to nil may +speed up some simulators, but is less general and harder to read, so avoid." :group 'verilog-mode-auto :type 'boolean) (put 'verilog-auto-inst-vector 'safe-local-variable 'verilog-booleanp) @@ -856,7 +856,7 @@ (put 'verilog-typedef-regexp 'safe-local-variable 'stringp) (defcustom verilog-mode-hook 'verilog-set-compile-command - "*Hook (List of functions) run after verilog mode is loaded." + "*Hook run after Verilog mode is loaded." :type 'hook :group 'verilog-mode) @@ -893,7 +893,7 @@ (defvar verilog-imenu-generic-expression '((nil "^\\s-*\\(\\(m\\(odule\\|acromodule\\)\\)\\|primitive\\)\\s-+\\([a-zA-Z0-9_.:]+\\)" 4) ("*Vars*" "^\\s-*\\(reg\\|wire\\)\\s-+\\(\\|\\[[^]]+\\]\\s-+\\)\\([A-Za-z0-9_]+\\)" 3)) - "Imenu expression for Verilog-mode. See `imenu-generic-expression'.") + "Imenu expression for Verilog mode. See `imenu-generic-expression'.") ;; ;; provide a verilog-header function. @@ -905,12 +905,12 @@ format (e.g. 09/17/1997) is not supported.") (defvar verilog-company nil - "*Default name of Company for verilog header. + "*Default name of Company for Verilog header. If set will become buffer local.") (make-variable-buffer-local 'verilog-company) (defvar verilog-project nil - "*Default name of Project for verilog header. + "*Default name of Project for Verilog header. If set will become buffer local.") (make-variable-buffer-local 'verilog-project) @@ -993,14 +993,14 @@ ) ("Move" ,(if (featurep 'xemacs) - (progn + (progn ["Beginning of function" verilog-beg-of-defun t] ["End of function" verilog-end-of-defun t] ["Mark function" verilog-mark-defun t]) ["Beginning of function" beginning-of-defun t] ["End of function" end-of-defun t] ["Mark function" mark-defun t]) - + ["Goto function/module" verilog-goto-defun t] ["Move to beginning of block" electric-verilog-backward-sexp t] ["Move to end of block" electric-verilog-forward-sexp t] @@ -1059,7 +1059,7 @@ ["Customize Verilog Mode..." verilog-customize t] ["Customize Verilog Fonts & Colors" verilog-font-customize t] ) - "Emacs menu for VERILOG mode." + "Emacs menu for Verilog mode." ) (defvar verilog-statement-menu '("Statements" @@ -1200,7 +1200,7 @@ ;; compilation program (defun verilog-set-compile-command () - "Function to compute shell command to compile verilog. + "Function to compute shell command to compile Verilog. This reads `verilog-tool' and sets `compile-command'. This specifies the program that executes when you type \\[compile] or @@ -1221,8 +1221,8 @@ value of `verilog-tool'; in the later, the path to the current buffer is substituted for the %s. -Where __FILE__ appears in the string, the buffer-file-name of the current -buffer, without the directory portion, will be substituted." +Where __FILE__ appears in the string, the `buffer-file-name' of the +current buffer, without the directory portion, will be substituted." (interactive) (cond ((or (file-exists-p "makefile") ;If there is a makefile, use it @@ -1752,7 +1752,7 @@ (modify-syntax-entry ?* ". 23" table) (modify-syntax-entry ?\n "> b" table)) table) - "Syntax table used in `verilog-mode' buffers.") + "Syntax table used in Verilog mode buffers.") (defvar verilog-font-lock-keywords nil "Default highlighting for Verilog mode.") @@ -1991,7 +1991,7 @@ (verilog-backward-sexp)) (defun electric-verilog-forward-sexp () - "Move backward over a sexp." + "Move forward over a sexp." (interactive) ;; before that see if we are in a comment (verilog-forward-sexp)) @@ -2211,9 +2211,10 @@ Set to 0 to get them list right under containing block. `verilog-indent-level-behavioral' (default 3) Indentation of first begin in a task or function block - Set to 0 to get such code to lined up underneath the task or function keyword + Set to 0 to get such code to lined up underneath the task or + function keyword. `verilog-indent-level-directive' (default 1) - Indentation of `ifdef/`endif blocks + Indentation of `ifdef/`endif blocks. `verilog-cexp-indent' (default 1) Indentation of Verilog statements broken across lines i.e.: if (a) @@ -2224,13 +2225,13 @@ Non-nil means automatically newline after semicolons and the punctuation mark after an end. `verilog-auto-indent-on-newline' (default t) - Non-nil means automatically indent line after newline + Non-nil means automatically indent line after newline. `verilog-tab-always-indent' (default t) Non-nil means TAB in Verilog mode should always reindent the current line, regardless of where in the line point is when the TAB command is used. `verilog-indent-begin-after-if' (default t) Non-nil means to indent begin statements following a preceding - if, else, while, for and repeat statements, if any. otherwise, + if, else, while, for and repeat statements, if any. Otherwise, the begin is lined up with the preceding token. If t, you get: if (a) begin // amount of indent based on `verilog-cexp-indent' @@ -2365,7 +2366,7 @@ (add-hook 'font-lock-after-fontify-buffer-hook 'verilog-colorize-include-files-buffer t t) ; not in emacs 20 (add-hook 'after-change-functions 'verilog-colorize-include-files t t) - ;; Tell imenu how to handle verilog. + ;; Tell imenu how to handle Verilog. (make-local-variable 'imenu-generic-expression) (setq imenu-generic-expression verilog-imenu-generic-expression) ;; hideshow support @@ -2637,7 +2638,7 @@ (verilog-insert-1 "%3.3d" max)) (defun verilog-mark-defun () - "Mark the current verilog function (or procedure). + "Mark the current Verilog function (or procedure). This puts the mark at the end, and point at the beginning." (interactive) (when (featurep 'xemacs) @@ -2870,8 +2871,8 @@ pos))) (defun verilog-in-case-region-p () - "Return TRUE if in a case region; -more specifically, point @ in the line foo : @ begin" + "Return true if in a case region. +More specifically, point @ in the line foo : @ begin" (interactive) (save-excursion (if (and @@ -2896,10 +2897,9 @@ (t (throw 'found (= nest 0))))))) nil))) - (defun verilog-in-struct-region-p () - "Return TRUE if in a struct region; -more specifically, in a list after a struct|union keyword" + "Return true if in a struct region. +More specifically, in a list after a struct|union keyword." (interactive) (save-excursion (let* ((state (parse-partial-sexp (point-min) (point))) @@ -2910,8 +2910,8 @@ (looking-at "\\<typedef\\>?\\s-*\\<struct\\|union\\>")))))) (defun verilog-in-generate-region-p () - "Return TRUE if in a generate region; -more specifically, after a generate and before an endgenerate" + "Return true if in a generate region. +More specifically, after a generate and before an endgenerate." (interactive) (let ((lim (save-excursion (verilog-beg-of-defun) (point))) (nest 1)) @@ -3035,7 +3035,8 @@ Insert `// case: 7 ' or `// NAME ' on this line if appropriate. Insert `// case expr ' if this line ends a case block. Insert `// ifdef FOO ' if this line ends code conditional on FOO. -Insert `// NAME ' if this line ends a function, task, module, primitive or interface named NAME." +Insert `// NAME ' if this line ends a function, task, module, +primitive or interface named NAME." (save-excursion (cond (; Comment close preprocessor directives @@ -3380,7 +3381,7 @@ )))))))))) (defun verilog-get-expr() - "Grab expression at point, e.g, case ( a | b & (c ^d))" + "Grab expression at point, e.g, case ( a | b & (c ^d))." (let* ((b (progn (verilog-forward-syntactic-ws) (skip-chars-forward " \t") @@ -3495,7 +3496,7 @@ ))))) (defun verilog-strip-comments () - "Strip all comments from the verilog code." + "Strip all comments from the Verilog code." (interactive) (goto-char (point-min)) (while (re-search-forward "//" nil t) @@ -3516,7 +3517,7 @@ (delete-region bpt (point)))))) (defun verilog-one-line () - "Convert structural verilog instances to occupy one line." + "Convert structural Verilog instances to occupy one line." (interactive) (goto-char (point-min)) (while (re-search-forward "\\([^;]\\)[ \t]*\n[ \t]*" nil t) @@ -3541,7 +3542,7 @@ becomes a comment for the appropriate tool. The first word of the `compile-command' or `verilog-linter' -variables are used to determine which product is being used. +variables is used to determine which product is being used. See \\[verilog-surelint-off] and \\[verilog-verilint-off]." (interactive) @@ -3691,7 +3692,7 @@ (defun verilog-batch-auto () "For use with --batch, perform automatic expansions as a stand-alone tool. -This sets up the appropriate Verilog-Mode environment, updates automatics +This sets up the appropriate Verilog mode environment, updates automatics with \\[verilog-auto] on all command-line files, and saves the buffers. For proper results, multiple filenames need to be passed on the command line in bottom-up order." @@ -3701,7 +3702,7 @@ (defun verilog-batch-delete-auto () "For use with --batch, perform automatic deletion as a stand-alone tool. -This sets up the appropriate Verilog-Mode environment, deletes automatics +This sets up the appropriate Verilog mode environment, deletes automatics with \\[verilog-delete-auto] on all command-line files, and saves the buffers." (unless noninteractive (error "Use verilog-batch-delete-auto only with --batch")) ;; Otherwise we'd mess up buffer modes @@ -3709,7 +3710,7 @@ (defun verilog-batch-inject-auto () "For use with --batch, perform automatic injection as a stand-alone tool. -This sets up the appropriate Verilog-Mode environment, injects new automatics +This sets up the appropriate Verilog mode environment, injects new automatics with \\[verilog-inject-auto] on all command-line files, and saves the buffers. For proper results, multiple filenames need to be passed on the command line in bottom-up order." @@ -3719,7 +3720,7 @@ (defun verilog-batch-indent () "For use with --batch, reindent an a entire file as a stand-alone tool. -This sets up the appropriate Verilog-Mode environment, calls +This sets up the appropriate Verilog mode environment, calls \\[verilog-indent-buffer] on all command-line files, and saves the buffers." (unless noninteractive (error "Use verilog-batch-indent only with --batch")) ;; Otherwise we'd mess up buffer modes @@ -3762,8 +3763,8 @@ (defun verilog-calculate-indent () "Calculate the indent of the current Verilog line. Examine previous lines. Once a line is found that is definitive as to the -type of the current line, return that lines' indent level and its -type. Return a list of two elements: (INDENT-TYPE INDENT-LEVEL)." +type of the current line, return that lines' indent level and its type. +Return a list of two elements: (INDENT-TYPE INDENT-LEVEL)." (save-excursion (let* ((starting_position (point)) (par 0) @@ -4015,8 +4016,8 @@ (setq nest 0)))))) (defun verilog-leap-to-head () - "Move point to the head of this block; jump from end to matching begin, -from endcase to matching case, and so on." + "Move point to the head of this block. +Jump from end to matching begin, from endcase to matching case, and so on." (let ((reg nil) snest (nest 1)) @@ -4095,7 +4096,7 @@ (defun verilog-continued-line () "Return true if this is a continued line. -Set point to where line starts" +Set point to where line starts." (let ((continued 't)) (if (eq 0 (forward-line -1)) (progn @@ -4594,7 +4595,7 @@ )) (defun verilog-current-indent-level () - "Return the indent-level the current statement has." + "Return the indent-level of the current statement." (save-excursion (let (par-pos) (beginning-of-line) @@ -4607,7 +4608,7 @@ (current-column)))) (defun verilog-case-indent-level () - "Return the indent-level the current statement has. + "Return the indent-level of the current statement. Do not count named blocks or case-statements." (save-excursion (skip-chars-forward " \t") @@ -5035,15 +5036,15 @@ "triand" "trior" "trireg" "wand" "wire" "wor" "xnor" "xor" ) "*Keywords for types used when completing a word in a declaration or parmlist. -\(eg. integer, real, reg...)") +\(Eg. integer, real, reg...)") (defvar verilog-cpp-keywords '("module" "macromodule" "primitive" "timescale" "define" "ifdef" "ifndef" "else" "endif") "*Keywords to complete when at first word of a line in declarative scope. -\(eg. initial, always, begin, assign.) +\(Eg. initial, always, begin, assign.) The procedures and variables defined within the Verilog program -will be completed runtime and should not be added to this list.") +will be completed at runtime and should not be added to this list.") (defvar verilog-defun-keywords (append @@ -5055,9 +5056,9 @@ ) verilog-type-keywords) "*Keywords to complete when at first word of a line in declarative scope. -\(eg. initial, always, begin, assign.) +\(Eg. initial, always, begin, assign.) The procedures and variables defined within the Verilog program -will be completed runtime and should not be added to this list.") +will be completed at runtime and should not be added to this list.") (defvar verilog-block-keywords '( @@ -5066,30 +5067,30 @@ "for" "fork" "if" "join" "join_any" "join_none" "repeat" "return" "while") "*Keywords to complete when at first word of a line in behavioral scope. -\(eg. begin, if, then, else, for, fork.) +\(Eg. begin, if, then, else, for, fork.) The procedures and variables defined within the Verilog program -will be completed runtime and should not be added to this list.") +will be completed at runtime and should not be added to this list.") (defvar verilog-tf-keywords '("begin" "break" "fork" "join" "join_any" "join_none" "case" "end" "endtask" "endfunction" "if" "else" "for" "while" "repeat") "*Keywords to complete when at first word of a line in a task or function. -\(eg. begin, if, then, else, for, fork.) +\(Eg. begin, if, then, else, for, fork.) The procedures and variables defined within the Verilog program -will be completed runtime and should not be added to this list.") +will be completed at runtime and should not be added to this list.") (defvar verilog-case-keywords '("begin" "fork" "join" "join_any" "join_none" "case" "end" "endcase" "if" "else" "for" "repeat") "*Keywords to complete when at first word of a line in case scope. -\(eg. begin, if, then, else, for, fork.) +\(Eg. begin, if, then, else, for, fork.) The procedures and variables defined within the Verilog program -will be completed runtime and should not be added to this list.") +will be completed at runtime and should not be added to this list.") (defvar verilog-separator-keywords '("else" "then" "begin") "*Keywords to complete when NOT standing at the first word of a statement. -\(eg. else, then.) -Variables and function names defined within the -Verilog program are completed runtime and should not be added to this list.") +\(Eg. else, then.) +Variables and function names defined within the Verilog program +will be completed at runtime and should not be added to this list.") (defun verilog-string-diff (str1 str2) "Return index of first letter where STR1 and STR2 differs." @@ -5197,11 +5198,11 @@ "Function passed to `completing-read', `try-completion' or `all-completions'. Called to get completion on VERILOG-STR. If VERILOG-PRED is non-nil, it must be a function to be called for every match to check if this should -really be a match. If VERILOG-FLAG is t, the function returns a list of all -possible completions. If VERILOG-FLAG is nil it returns a string, the -longest possible completion, or t if STR is an exact match. If VERILOG-FLAG -is 'lambda, the function returns t if STR is an exact match, nil -otherwise." +really be a match. If VERILOG-FLAG is t, the function returns a list of +all possible completions. If VERILOG-FLAG is nil it returns a string, +the longest possible completion, or t if VERILOG-STR is an exact match. +If VERILOG-FLAG is 'lambda, the function returns t if VERILOG-STR is an +exact match, nil otherwise." (save-excursion (let ((verilog-all nil)) ;; Set buffer to use for searching labels. This should be set @@ -5708,8 +5709,8 @@ (nth 3 sigs)) (defun verilog-signals-not-in (in-list not-list) - "Return list of signals in IN-LIST that aren't also in NOT-LIST, -and also remove any duplicates in IN-LIST. + "Return list of signals in IN-LIST that aren't also in NOT-LIST. +Also remove any duplicates in IN-LIST. Signals must be in standard (base vector) form." (let (out-list) (while in-list @@ -6100,7 +6101,7 @@ (defun verilog-read-sub-decls-sig (submodi comment port sig vec multidim) - "For verilog-read-sub-decls-line, add a signal." + "For `verilog-read-sub-decls-line', add a signal." (let (portdata) (when sig (setq port (verilog-symbol-detick-denumber port)) @@ -6132,7 +6133,7 @@ ))))) (defun verilog-read-sub-decls-line (submodi comment) - "For read-sub-decls, read lines of port defs until none match anymore. + "For `verilog-read-sub-decls', read lines of port defs until none match anymore. Return the list of signals found, using submodi to look up each port." (let (done port sig vec multidim) (save-excursion @@ -6253,7 +6254,7 @@ (verilog-signals-combine-bus (nreverse sigs-in)))))) (defun verilog-read-inst-pins () - "Return a array of [ pins ] for the current instantiation at point. + "Return an array of [ pins ] for the current instantiation at point. For example if declare A A (.B(SIG)) then B will be included in the list." (save-excursion (let ((end-mod-point (point)) ;; presume at /*AUTOINST*/ point @@ -6268,7 +6269,7 @@ (vector pins)))) (defun verilog-read-arg-pins () - "Return a array of [ pins ] for the current argument declaration at point." + "Return an array of [ pins ] for the current argument declaration at point." (save-excursion (let ((end-mod-point (point)) ;; presume at /*AUTOARG*/ point pins pin) @@ -6497,7 +6498,7 @@ (defun verilog-read-auto-template (module) "Look for a auto_template for the instantiation of the given MODULE. If found returns the signal name connections. Return REGEXP and -list of ( (signal_name connection_name)... )" +list of ( (signal_name connection_name)... )." (save-excursion ;; Find beginning (let ((tpl-regexp "\\([0-9]+\\)") @@ -6713,7 +6714,7 @@ (defun verilog-read-signals (&optional start end) "Return a simple list of all possible signals in the file. Bounded by optional region from START to END. Overly aggressive but fast. -Some macros and such are also found and included. For dinotrace.el" +Some macros and such are also found and included. For dinotrace.el." (let (sigs-all keywd) (progn;save-excursion (goto-char (or start (point-min))) @@ -6808,7 +6809,7 @@ ;;(verilog-getopt (list "+libext+.a+.b" "+incdir+foodir" "+define+a+aval" "-f" "otherf" "-v" "library" "-y" "dir")) (defun verilog-getopt-file (filename) - "Read verilog options from the specified FILENAME." + "Read Verilog options from the specified FILENAME." (save-excursion (let ((fns (verilog-library-filenames filename (buffer-file-name))) (orig-buffer (current-buffer)) @@ -6845,7 +6846,7 @@ (defun verilog-add-list-unique (varref object) "Append to VARREF list the given OBJECT, -unless it is already a member of the variable's list" +unless it is already a member of the variable's list." (unless (member object (symbol-value varref)) (set varref (append (symbol-value varref) (list object)))) varref) @@ -6881,7 +6882,7 @@ (string-match "^[0-9 \t]+'s?[hdxbo][0-9a-fA-F_xz? \t]*$" symbol))) (defun verilog-symbol-detick (symbol wing-it) - "Return a expanded SYMBOL name without any defines. + "Return an expanded SYMBOL name without any defines. If the variable vh-{symbol} is defined, return that value. If undefined, and WING-IT, return just SYMBOL without the tick, else nil." (while (and symbol (string-match "^`" symbol)) @@ -6916,7 +6917,7 @@ symbol)) (defun verilog-symbol-detick-text (text) - "Return TEXT with any without any known defines. + "Return TEXT without any known defines. If the variable vh-{symbol} is defined, substitute that value." (let ((ok t) symbol val) (while (and ok (string-match "`\\([a-zA-Z0-9_]+\\)" text)) @@ -7021,10 +7022,10 @@ (defvar verilog-modi-cache-preserve-tick nil "Modification tick after which the cache is still considered valid. -Use verilog-preserve-cache's to set") +Use `verilog-preserve-cache' to set it.") (defvar verilog-modi-cache-preserve-buffer nil "Modification tick after which the cache is still considered valid. -Use verilog-preserve-cache's to set") +Use `verilog-preserve-cache' to set it.") (defun verilog-modi-current () "Return the modi structure for the module currently at point." @@ -7088,7 +7089,7 @@ (aref modi 2)) (defun verilog-modi-filename (modi) - "Filename of MODI, or name of buffer if its never been saved." + "Filename of MODI, or name of buffer if it's never been saved." (if (bufferp (verilog-modi-file-or-buffer modi)) (or (buffer-file-name (verilog-modi-file-or-buffer modi)) (buffer-name (verilog-modi-file-or-buffer modi))) @@ -7100,7 +7101,7 @@ (set-buffer (if (bufferp (verilog-modi-file-or-buffer modi)) (verilog-modi-file-or-buffer modi) (find-file-noselect (verilog-modi-file-or-buffer modi)))) - (or (equal major-mode `verilog-mode) ;; Put into verilog mode to get syntax + (or (equal major-mode `verilog-mode) ;; Put into Verilog mode to get syntax (verilog-mode)) (goto-char (verilog-modi-point modi))) @@ -7399,8 +7400,8 @@ (forward-line 1)))) (defun verilog-forward-close-paren () - "Find the close parenthesis that match the current point, -ignore other close parenthesis with matching open parens" + "Find the close parenthesis that match the current point. +Ignore other close parenthesis with matching open parens." (let ((parens 1)) (while (> parens 0) (unless (verilog-re-search-forward-quick "[()]" nil t) @@ -7411,8 +7412,8 @@ (setq parens (1- parens))))))) (defun verilog-backward-open-paren () - "Find the open parenthesis that match the current point, -ignore other open parenthesis with matching close parens" + "Find the open parenthesis that match the current point. +Ignore other open parenthesis with matching close parens." (let ((parens 1)) (while (> parens 0) (unless (verilog-re-search-backward-quick "[()]" nil t) @@ -7423,8 +7424,8 @@ (setq parens (1- parens))))))) (defun verilog-backward-open-bracket () - "Find the open bracket that match the current point, -ignore other open bracket with matching close bracket" + "Find the open bracket that match the current point. +Ignore other open bracket with matching close bracket." (let ((parens 1)) (while (> parens 0) (unless (verilog-re-search-backward-quick "[][]" nil t) @@ -7539,8 +7540,8 @@ Any always @ blocks with sensitivity lists that match computed lists will be replaced with /*AS*/ comments. -Any cells will get /*AUTOINST*/ added to the end of the pin list. Pins with -have identical names will be deleted. +Any cells will get /*AUTOINST*/ added to the end of the pin list. +Pins with have identical names will be deleted. Argument lists will not be deleted, /*AUTOARG*/ will only be inserted to support adding new ports. You may wish to delete older ports yourself. @@ -7754,9 +7755,9 @@ Any ports declared between the ( and /*AUTOARG*/ are presumed to be predeclared and are not redeclared by AUTOARG. AUTOARG will make a -conservative guess on adding a comma for the first signal, if you have any -ifdefs or complicated expressions before the AUTOARG you will need to -choose the comma yourself. +conservative guess on adding a comma for the first signal, if you have +any ifdefs or complicated expressions before the AUTOARG you will need +to choose the comma yourself. Avoid declaring ports manually, as it makes code harder to maintain." (save-excursion @@ -7886,7 +7887,7 @@ "Expand SystemVerilog .* pins, as part of \\[verilog-auto]. If `verilog-auto-star-expand' is set, .* pins are treated if they were -AUTOINST statements, otherwise they are ignored. For safety, Verilog-Mode +AUTOINST statements, otherwise they are ignored. For safety, Verilog mode will also ignore any .* that are not last in your pin list (this prevents it from deleting pins following the .* when it expands the AUTOINST.) @@ -7922,7 +7923,7 @@ Typedefs must match `verilog-typedef-regexp', which is disabled by default. - SystemVerilog multidimmensional input/output has only experimental support. + SystemVerilog multidimensional input/output has only experimental support. For example, first take the submodule inst.v: @@ -7957,9 +7958,9 @@ Exceptions: Unless you are instantiating a module multiple times, or the module is - something trivial like a adder, DO NOT CHANGE SIGNAL NAMES ACROSS HIERARCHY. + something trivial like an adder, DO NOT CHANGE SIGNAL NAMES ACROSS HIERARCHY. It just makes for unmaintainable code. To sanitize signal names, try - vrename from http://www.veripool.com + vrename from http://www.veripool.com. When you need to violate this suggestion there are two ways to list exceptions, placing them before the AUTOINST, or using templates. @@ -7988,10 +7989,10 @@ ); */ - Templates go ABOVE the instantiation(s). When a instantiation is + Templates go ABOVE the instantiation(s). When an instantiation is expanded `verilog-mode' simply searches up for the closest template. Thus you can have multiple templates for the same module, just alternate - between the template for a instantiation and the instantiation itself. + between the template for an instantiation and the instantiation itself. The module name must be the same as the name of the module in the instantiation name, and the code \"AUTO_TEMPLATE\" must be in these exact @@ -8097,7 +8098,7 @@ .pci_req\\([0-9]+\\)_l (pci_req_jtag_[\\1]), - will apply a Emacs style regular expression search for any port beginning + will apply an Emacs style regular expression search for any port beginning in pci_req followed by numbers and ending in _l and connecting that to the pci_req_jtag_[] net, with the bus subscript coming from what matches inside the first set of \\( \\). Thus pci_req2_l becomes pci_req_jtag_[2]. @@ -8126,13 +8127,13 @@ a leading backslash (\\\"). There are special variables defined that are useful in these Lisp functions: - vl-name Name portion of the input/output port - vl-bits Bus bits portion of the input/output port ('[2:0]') - vl-width Width of the input/output port ('3' for [2:0]) + vl-name Name portion of the input/output port. + vl-bits Bus bits portion of the input/output port ('[2:0]'). + vl-width Width of the input/output port ('3' for [2:0]). May be a (...) expression if bits isn't a constant. vl-dir Direction of the pin input/output/inout. - vl-cell-type Module name/type of the cell ('psm_mas') - vl-cell-name Instance name of the cell ('ms2m') + vl-cell-type Module name/type of the cell ('psm_mas'). + vl-cell-name Instance name of the cell ('ms2m'). Normal Lisp variables may be used in expressions. See `verilog-read-defines' which can set vh-{definename} variables for use @@ -8145,7 +8146,7 @@ functions to be defined or variables to be changed between instantiations. Note that when using lisp expressions errors may occur when @ is not a - number, you may need to use the standard Emacs Lisp functions + number; you may need to use the standard Emacs Lisp functions `number-to-string' and `string-to-number'. After the evaluation is completed, @ substitution and [] substitution @@ -8450,9 +8451,9 @@ This does NOT work on memories or SystemVerilog .name connections, declare those yourself. - Verilog-mode will add \"Couldn't Merge\" comments to signals it cannot - determine how to bus together. This occurs when you have ports with - non-numeric or non-sequential bus subscripts. If Verilog-Mode + Verilog mode will add \"Couldn't Merge\" comments to signals it cannot + determine how to bus together. This occurs when you have ports with + non-numeric or non-sequential bus subscripts. If Verilog mode mis-guessed, you'll have to declare them yourself. An example (see `verilog-auto-inst' for what else is going on here): @@ -8748,8 +8749,8 @@ "Expand AUTOINOUTMODULE statements, as part of \\[verilog-auto]. Take input/output/inout statements from the specified module and insert into the current module. This is useful for making null templates and -shell modules which need to have identical I/O with another module. Any -I/O which are already defined in this module will not be redefined. +shell modules which need to have identical I/O with another module. +Any I/O which are already defined in this module will not be redefined. Limitations: If placed inside the parenthesis of a module declaration, it creates @@ -9157,7 +9158,7 @@ (verilog-insert-indent "// End of automatics\n"))))) (defun verilog-enum-ascii (signm elim-regexp) - "Convert a enum name SIGNM to a ascii string for insertion. + "Convert an enum name SIGNM to an ascii string for insertion. Remove user provided prefix ELIM-REGEXP." (or elim-regexp (setq elim-regexp "_ DONT MATCH IT_")) (let ((case-fold-search t)) @@ -9640,7 +9641,7 @@ > (- verilog-indent-level-behavioral) "endgenerate" \n > ) (define-skeleton verilog-sk-begin - "Insert begin end block. Uses the minibuffer to prompt for name" + "Insert begin end block. Uses the minibuffer to prompt for name." () > "begin" '(verilog-sk-prompt-name) \n > _ \n @@ -9648,7 +9649,7 @@ ) (define-skeleton verilog-sk-fork - "Insert an fork join block." + "Insert a fork join block." () > "fork\n" > "begin" \n @@ -9699,7 +9700,7 @@ > "end" (progn (electric-verilog-terminate-line) nil)) (define-skeleton verilog-sk-datadef - "Common routine to get data definition" + "Common routine to get data definition." () '(verilog-sk-prompt-width) | -1 ("name (RET to end):" str ", ") -2 ";" \n) @@ -9893,7 +9894,7 @@ (defun verilog-colorize-include-files-buffer () - "Colorize a include file." + "Colorize an include file." (interactive) ;; delete overlays (let ((overlays (overlays-in (point-min) (point-max)))) @@ -9906,14 +9907,14 @@ ;; remake overlays (verilog-colorize-include-files (point-min) (point-max) nil)) -;; ffap-at-mouse isn't useful for verilog mode. It uses library paths. +;; ffap-at-mouse isn't useful for Verilog mode. It uses library paths. ;; so define this function to do more or less the same as ffap-at-mouse ;; but first resolve filename... (defun verilog-load-file-at-mouse (event) "Load file under button 2 click's EVENT. Files are checked based on `verilog-library-directories'." (interactive "@e") - (save-excursion ;; implement a verilog specific ffap-at-mouse + (save-excursion ;; implement a Verilog specific ffap-at-mouse (mouse-set-point event) (beginning-of-line) (if (looking-at verilog-include-file-regexp) @@ -9928,14 +9929,14 @@ "File '%s' isn't readable, use shift-mouse2 to paste in this field" (match-string 1))))))) -;; ffap isn't useable for verilog mode. It uses library paths. +;; ffap isn't useable for Verilog mode. It uses library paths. ;; so define this function to do more or less the same as ffap ;; but first resolve filename... (defun verilog-load-file-at-point () "Load file under point. Files are checked based on `verilog-library-directories'." (interactive) - (save-excursion ;; implement a verilog specific ffap + (save-excursion ;; implement a Verilog specific ffap (beginning-of-line) (if (looking-at verilog-include-file-regexp) (if (and @@ -10031,7 +10032,7 @@ http://www.veripool.com/verilog-mode-faq.html. To reproduce the bug, start a fresh Emacs via " invocation-name " --no-init-file -no-site-file'. In a new buffer, in verilog mode, type +-no-init-file -no-site-file'. In a new buffer, in Verilog mode, type the code included below. Given those lines, I expected [[Fill in here]] to happen;