diff options
Diffstat (limited to 'doc/misc/vhdl-mode.texi')
| -rw-r--r-- | doc/misc/vhdl-mode.texi | 64 |
1 files changed, 32 insertions, 32 deletions
diff --git a/doc/misc/vhdl-mode.texi b/doc/misc/vhdl-mode.texi index 05036c44014..7d451c71bd4 100644 --- a/doc/misc/vhdl-mode.texi +++ b/doc/misc/vhdl-mode.texi @@ -10,7 +10,7 @@ @copying This file documents VHDL Mode, an Emacs mode for editing VHDL code. -Copyright @copyright{} 1995--2008, 2010, 2012, 2015--2017 Free Software +Copyright @copyright{} 1995--2008, 2010, 2012, 2015--2022 Free Software Foundation, Inc. @quotation @@ -100,7 +100,7 @@ How to customize the indentation engine. The major version number was incremented to 3 with the addition of many new features for editing VHDL code to the new indentation engine, which was introduced in major version 2. To find the minor revision -number of this release, use @kbd{M-x vhdl-version RET}. +number of this release, use @kbd{M-x vhdl-version @key{RET}}. A special word of thanks goes to Rod Whitby, who wrote the VHDL Mode indentation engine, and to Barry Warsaw, who wrote @@ -119,7 +119,7 @@ makes everything highly self-explaining. @cindex Getting Connected To get started, simply visit a @file{.vhd} file in Emacs; or type -@kbd{M-x vhdl-mode RET}. +@kbd{M-x vhdl-mode @key{RET}}. @node New Indentation Engine @chapter New Indentation Engine @@ -147,7 +147,7 @@ your personal coding style. @cindex Syntactic Analysis @vindex vhdl-offsets-alist -@vindex offsets-alist (vhdl-) +@vindex offsets-alist @r{(vhdl-)} @cindex relative buffer position @cindex syntactic symbol @cindex syntactic component @@ -186,7 +186,7 @@ in this and future examples don't actually appear in the buffer.}: @kindex C-c C-x @findex vhdl-show-syntactic-information -@findex show-syntactic-information (vhdl-) +@findex show-syntactic-information @r{(vhdl-)} We can use the command @kbd{C-c C-x} (@code{vhdl-show-syntactic-information}) to simply report what the syntactic analysis is for the current line. Running this command on @@ -241,9 +241,9 @@ components. Also notice that the first component, @cindex Indentation Calculation @vindex vhdl-offsets-alist -@vindex offsets-alist (vhdl-) +@vindex offsets-alist @r{(vhdl-)} Indentation for the current line is calculated using the syntactic -component list derived in step 1 above (see @ref{Syntactic +component list derived in step 1 above (@pxref{Syntactic Analysis}). Each component contributes to the final total indentation of the line in two ways. @@ -301,12 +301,12 @@ indentation, it's helpful to understand the general indentation model being used. @vindex vhdl-echo-syntactic-information-p -@vindex echo-syntactic-information-p (vhdl-) -@cindex TAB +@vindex echo-syntactic-information-p @r{(vhdl-)} +@cindex @key{TAB} To help you configure VHDL Mode, you can set the variable @code{vhdl-echo-syntactic-information-p} to non-@code{nil} so that the syntactic component list and calculated offset will always be echoed in -the minibuffer when you hit @kbd{TAB}. +the minibuffer when you hit @kbd{@key{TAB}}. @ignore @@ -322,7 +322,7 @@ the minibuffer when you hit @kbd{TAB}. @chapter Customizing Indentation @cindex Customizing Indentation -@cindex vhdl-set-offset +@cindex @code{vhdl-set-offset} @cindex set-offset (vhdl-) The @code{vhdl-offsets-alist} variable is where you customize all your indentations. You simply need to decide what additional offset you want @@ -334,7 +334,7 @@ pre-defined styles will suit your needs, but if not, this section will describe how to set up basic editing configurations. @xref{Styles}, for an explanation of how to set up named styles. -@cindex vhdl-basic-offset +@cindex @code{vhdl-basic-offset} @cindex basic-offset (vhdl-) As mentioned previously, the variable @code{vhdl-offsets-alist} is an association list between syntactic symbols and the offsets to be applied @@ -428,7 +428,7 @@ line. Hitting @kbd{C-c C-x} on line 3 yields: @end example @findex vhdl-set-offset -@findex set-offset (vhdl-) +@findex set-offset @r{(vhdl-)} @kindex C-c O @noindent So we know that to change the offset of the first signal assignment, we need to @@ -447,7 +447,7 @@ basic indent with the syntactic symbol @code{statement-block-intro} in the @code{vhdl-offsets-alist} variable. @findex vhdl-indent-defun -@findex indent-defun (vhdl-) +@findex indent-defun @r{(vhdl-)} To check your changes quickly, just enter @kbd{M-x vhdl-indent-defun} to reindent the entire function. The example should now look like: @example @@ -546,9 +546,9 @@ already built-in. These include: @end itemize @findex vhdl-set-style -@findex set-style (vhdl-) +@findex set-style @r{(vhdl-)} If you'd like to experiment with these built-in styles you can simply -type @kbd{M-x vhdl-set-style RET} in a VHDL Mode buffer. +type @kbd{M-x vhdl-set-style @key{RET}} in a VHDL Mode buffer. You will be prompted for one of the above styles (with completion). Enter one of the styles and hit @kbd{RET}. Note however that setting a @@ -583,9 +583,9 @@ files. You would add this: @cindex Adding Styles @vindex vhdl-style-alist -@vindex style-alist (vhdl-) +@vindex style-alist @r{(vhdl-)} @findex vhdl-add-style -@findex add-style (vhdl-) +@findex add-style @r{(vhdl-)} If none of the built-in styles is appropriate, you'll probably want to add a new style definition. Styles are kept in the @code{vhdl-style-alist} variable, but you probably won't want to modify this variable directly. @@ -615,9 +615,9 @@ block. VHDL Mode provides two variables that make it easier for you to customize your style on a per-file basis. @vindex vhdl-file-style -@vindex file-style (vhdl-) +@vindex file-style @r{(vhdl-)} @vindex vhdl-file-offsets -@vindex file-offsets (vhdl-) +@vindex file-offsets @r{(vhdl-)} The variable @code{vhdl-file-style} can be set to a style name string as described in @ref{Built-in Styles}. When the file is visited, @@ -625,9 +625,9 @@ VHDL Mode will automatically set the file's style to this style using @code{vhdl-set-style}. @vindex vhdl-offsets-alist -@vindex offsets-alist (vhdl-) +@vindex offsets-alist @r{(vhdl-)} @findex vhdl-set-offset -@findex set-offset (vhdl-) +@findex set-offset @r{(vhdl-)} Another variable, @code{vhdl-file-offsets}, takes an association list similar to what is allowed in @code{vhdl-offsets-alist}. When the file is visited, VHDL Mode will automatically institute these offsets using @@ -642,9 +642,9 @@ before file offset settings (i.e., @code{vhdl-file-offsets}). @cindex Advanced Customizations @vindex vhdl-style-alist -@vindex style-alist (vhdl-) +@vindex style-alist @r{(vhdl-)} @vindex vhdl-basic-offset -@vindex basic-offset (vhdl-) +@vindex basic-offset @r{(vhdl-)} For most users, VHDL Mode will support their coding styles with very little need for customizations. Usually, one of the standard styles defined in @code{vhdl-style-alist} will do the trick. Sometimes, @@ -668,7 +668,7 @@ not handled by the mode directly. @cindex custom indentation functions One of the most common ways to customize VHDL Mode is by writing @dfn{custom indentation functions} and associating them with specific -syntactic symbols (see @ref{Syntactic Symbols}). VHDL Mode itself +syntactic symbols (@pxref{Syntactic Symbols}). VHDL Mode itself uses custom indentation functions to provide more sophisticated indentation, for example when lining up selected signal assignments: @example @@ -732,9 +732,9 @@ operator on the first line of the statement. Here is the lisp code @end example @noindent Custom indent functions take a single argument, which is a syntactic -component cons cell (see @ref{Syntactic Analysis}). The +component cons cell (@pxref{Syntactic Analysis}). The function returns an integer offset value that will be added to the -running total indentation for the lne. Note that what actually gets +running total indentation for the line. Note that what actually gets returned is the difference between the column that the signal assignment operator is on, and the column of the buffer relative position passed in the function's argument. Remember that VHDL Mode automatically @@ -743,7 +743,7 @@ don't want that value added into the final total twice. @cindex statement-cont syntactic symbol @findex vhdl-lineup-statement-cont -@findex lineup-statement-cont (vhdl-) +@findex lineup-statement-cont @r{(vhdl-)} Now, to associate the function @code{vhdl-lineup-statement-cont} with the @code{statement-cont} syntactic symbol, we can add something like the following to our @code{vhdl-mode-hook}: @@ -765,7 +765,7 @@ vhdl-indent-defun}): @end example @vindex vhdl-offsets-alist -@vindex offsets-alist (vhdl-) +@vindex offsets-alist @r{(vhdl-)} Custom indentation functions can be as simple or as complex as you like, and any syntactic symbol that appears in @code{vhdl-offsets-alist} can have a custom indentation function associated with it. Note however that @@ -777,7 +777,7 @@ VHDL Mode. @cindex Other Special Indentations @vindex vhdl-special-indent-hook -@vindex special-indent-hook (vhdl-) +@vindex special-indent-hook @r{(vhdl-)} One other variable is available for you to customize VHDL Mode: @code{vhdl-special-indent-hook}. This is a standard hook variable that is called after every line is indented by VHDL Mode. You can use @@ -928,7 +928,7 @@ If you want to customize indentation, here you go: (setq tab-width 8 ;; this will make sure spaces are used instead of tabs indent-tabs-mode nil) - ;; keybindings for VHDL are put in vhdl-mode-map + ;; key bindings for VHDL are put in vhdl-mode-map (define-key vhdl-mode-map "\C-m" 'newline-and-indent) ) @@ -956,7 +956,7 @@ The index menu does not work on my XEmacs installation (don't know why). @kindex C-c C-b @findex vhdl-submit-bug-report -@findex submit-bug-report (vhdl-) +@findex submit-bug-report @r{(vhdl-)} @cindex beta testers mailing list @cindex announcement mailing list To report bugs, use the @kbd{C-c C-b} (@code{vhdl-submit-bug-report}) |