[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] trunk r116886: vhdl-mode.texi clean-up
|
From: |
Glenn Morris |
|
Subject: |
[Emacs-diffs] trunk r116886: vhdl-mode.texi clean-up |
|
Date: |
Thu, 27 Mar 2014 18:20:10 +0000 |
|
User-agent: |
Bazaar (2.6b2) |
------------------------------------------------------------
revno: 116886
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Thu 2014-03-27 14:20:08 -0400
message:
vhdl-mode.texi clean-up
* doc/misc/vhdl-mode.texi: General clean-up.
Set copyright to FSF (years based on vhdl-mode releases), add license.
Remove hand-written node pointers. Remove info re old Emacs versions.
Markup fixes.
(Getting Connected): Remove irrelevant info.
(Indentation Commands, Requirements): Remove empty/irrelevant nodes.
(Frequently Asked Questions): Electric indent is now enabled.
modified:
doc/misc/ChangeLog changelog-20091113204419-o5vbwnq5f7feedwu-6331
doc/misc/vhdl-mode.texi vhdlmode.texi-20140327181539-n91yk3127tukbc2z-1
=== modified file 'doc/misc/ChangeLog'
--- a/doc/misc/ChangeLog 2014-03-27 18:18:15 +0000
+++ b/doc/misc/ChangeLog 2014-03-27 18:20:08 +0000
@@ -1,3 +1,12 @@
+2014-03-27 Glenn Morris <address@hidden>
+
+ * vhdl-mode.texi: General clean-up. Set copyright to FSF, add license.
+ Remove hand-written node pointers. Remove info re old Emacs versions.
+ Markup fixes.
+ (Getting Connected): Remove irrelevant info.
+ (Indentation Commands, Requirements): Remove empty/irrelevant nodes.
+ (Frequently Asked Questions): Electric indent is now enabled.
+
2014-03-27 Reto Zimmermann <address@hidden>
Rod Whitby <address@hidden>
=== modified file 'doc/misc/vhdl-mode.texi'
--- a/doc/misc/vhdl-mode.texi 2014-03-27 18:18:15 +0000
+++ b/doc/misc/vhdl-mode.texi 2014-03-27 18:20:08 +0000
@@ -1,87 +1,60 @@
\input texinfo @c -*- texinfo -*-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden %**start of header (This is for running Texinfo on a region)
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
address@hidden vhdl-mode.info
address@hidden VHDL Mode Version 3 Documentation
address@hidden end
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden @setchapternewpage odd !! we don't want blank pages !!
address@hidden %**end of header (This is for running Texinfo on a region)
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden
address@hidden texinfo manual for @file{vhdl-mode.el} version 3
address@hidden manual version: 3.1
address@hidden adapted from the VHDL Mode texinfo manual version 2 by
address@hidden Rodney J. Whitby <address@hidden>
address@hidden adapted from the CC Mode texinfo manual by Barry A. Warsaw
address@hidden <address@hidden>
address@hidden
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden The following line inserts the copyright notice
address@hidden into the Info file.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
address@hidden
-Copyright @copyright{} 1997 - 2002 Reto Zimmermann <reto@@gnu.org>
-Copyright @copyright{} 1995 - 1997 Rodney J. Whitby
<software.vhdl-mode@@rwhitby.net>
address@hidden ifinfo
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden !!!The titlepage section does not appear in the Info file.!!!
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden ../../info/vhdl-mode
address@hidden VHDL Mode, an Emacs mode for editing VHDL code
+
address@hidden Adapted from the VHDL Mode texinfo manual version 2 by Rodney J.
Whitby.
address@hidden Adapted from the CC Mode texinfo manual by Barry A. Warsaw.
+
address@hidden
+This file documents VHDL Mode, an Emacs mode for editing VHDL code.
+
+Copyright @copyright{} 1995--2008, 2010, 2012, 2014 Free Software
+Foundation, Inc.
+
address@hidden
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
+and with the Back-Cover Texts as in (a) below. A copy of the license
+is included in the section entitled ``GNU Free Documentation License.''
+
+(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
+modify this GNU manual.''
address@hidden quotation
address@hidden copying
+
address@hidden Emacs editing modes
address@hidden
+* VHDL Mode: (vhdl-mode). Emacs mode for editing VHDL code.
address@hidden direntry
+
address@hidden
@titlepage
address@hidden 10
-
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden The title is printed in a large font.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
address@hidden @titlefont{VHDL Mode Version 3}
address@hidden 2
address@hidden A GNU Emacs mode for editing VHDL code.
address@hidden (manual revision: 3.1)
address@hidden 2
address@hidden Reto Zimmermann
address@hidden @code{Reto.Zimmermann@@iaeth.ch}
address@hidden Rod Whitby
address@hidden @code{rwhitby@@geocities.com}
-
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden The following two commands start the copyright page
address@hidden for the printed manual. This will not appear in the Info file.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden VHDL Mode
address@hidden 2
address@hidden A GNU Emacs mode for editing VHDL code.
address@hidden 2
address@hidden Reto Zimmermann
address@hidden @email{reto@@gnu.org}
address@hidden Rod Whitby
address@hidden @email{software.vhdl-mode@@rwhitby.net}
@page
@vskip 0pt plus 1filll
-Copyright @copyright{} 1997 Reto Zimmermann <Reto.Zimmermann@@iaeth.ch>
-Copyright @copyright{} 1995 - 1997 Rodney J. Whitby <rwhitby@@geocities.com>
address@hidden
@end titlepage
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden The Top node contains the master menu for the Info file.
address@hidden This appears only in the Info file, not the printed manual.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
address@hidden Top, Introduction, (dir), (dir)
address@hidden node-name, next, previous, up
-
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden
+
address@hidden
address@hidden Top
address@hidden VHDL Mode, an Emacs mode for editing VHDL code
+
address@hidden
address@hidden ifnottex
@menu
* Introduction::
@@ -89,29 +62,24 @@
* New Indentation Engine::
* Customizing Indentation::
* Syntactic Symbols::
-* Indentation Commands::
* Frequently Asked Questions::
* Getting the latest VHDL Mode release::
* Sample .emacs File::
-* Requirements::
-* Limitations and Known Bugs::
+* Limitations and Known Bugs::
* Mailing Lists and Submitting Bug Reports::
+* GNU Free Documentation License:: The license for this documentation.
* Concept Index::
* Command Index:: Command Index
* Key Index:: Key Index
* Variable Index:: Variable Index
@end menu
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
address@hidden Introduction, Getting Connected, Top, Top
address@hidden node-name, next, previous, up
address@hidden Introduction
@chapter Introduction
@cindex Introduction
-Welcome to VHDL Mode version 3. This is a GNU Emacs mode for editing
-files containing VHDL code.
+Welcome to VHDL Mode. This is a GNU Emacs mode for editing files
+containing VHDL code.
This manual will describe the following:
@@ -145,120 +113,17 @@
customization of most variables are available through the menu, which
makes everything highly self-explaining.
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
address@hidden Getting Connected, New Indentation Engine, Introduction, Top
address@hidden node-name, next, previous, up
address@hidden Getting Connected
@chapter Getting Connected
@cindex Getting Connected
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-VHDL Mode works well under GNU Emacs 20 and XEmacs 19.15 and higher.
-GNU Emacs 19 is not supported anymore since several new features of
-Emacs 20 are used in this VHDL Mode version (you can download VHDL
-Mode version 1.10 for Emacs 19).
-
address@hidden .emacs file
-The first thing you will want to do is put @file{vhdl-mode.el} somewhere
-on your @code{load-path} so Emacs can find it. Do a @kbd{C-h v
-load-path RET} to see all the directories Emacs looks at when loading a
-file. If none of these directories are appropriate, create a new
-directory and add it to your @code{load-path}:
-
address@hidden
address@hidden the shell]}
address@hidden
address@hidden
-
-% cd
-% mkdir mylisp
-% mv vhdl-mode.el mylisp
-% cd mylisp
-
address@hidden group
address@hidden example
-
address@hidden
address@hidden your .emacs file add]}
address@hidden
-
-(setq load-path (cons "~/mylisp" load-path))
-
address@hidden example
-
address@hidden byte compile
-Next you want to @dfn{byte compile} @file{vhdl-mode.el}. The mode uses a
-lot of macros so if you don't byte compile it, things will be unbearably
-slow. @emph{You can ignore all byte-compiler warnings!} They are the
-result of the supporting different versions of Emacs, and none of the
-warnings have any effect on operation. Let me say this again:
address@hidden really can ignore all byte-compiler warnings!}
-
-Here's what to do to byte-compile the file [in emacs]:
address@hidden
-
-M-x byte-compile-file RET ~/mylisp/vhdl-mode.el RET
-
address@hidden example
-
-Now add the following autoloads to your @file{.emacs} file so that
address@hidden gets loaded at the right time:
address@hidden
-
-(autoload 'vhdl-mode "vhdl-mode" "VHDL Editing Mode" t)
-
address@hidden example
-
-Alternatively, if you want to make sure VHDL Mode is loaded when
-Emacs starts up, you could use this line instead of the autoload above:
address@hidden
-
-(require 'vhdl-mode)
-
address@hidden example
-
-Next, you will want to set up Emacs so that it edits VHDL files in
-VHDL Mode. All users should add the following to their
address@hidden file. Note that this assumes you'll be editing @code{.vhd}
-and files as VHDL. YMMV:
address@hidden
address@hidden
-
-(setq auto-mode-alist
- (append
- '(("\\.vhd$" . vhdl-mode)
- ) auto-mode-alist))
-
address@hidden group
address@hidden example
-
-That's all you need -- I know, I know, it sounds like a lot @code{:-)},
-but after you've done all this, you should only need to quit and restart
-Emacs. The next time you visit a VHDL file you should be using
-VHDL Mode. You can check this easily by hitting @kbd{M-x
-vhdl-version RET} in the VHDL Mode buffer. You should see this
-message in the echo area:
address@hidden
-
-Using VHDL Mode version address@hidden
-
address@hidden example
-
address@hidden
-where @var{XX} will be some minor revision number.
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
address@hidden New Indentation Engine, Indentation Commands, Getting
Connected, Top
address@hidden node-name, next, previous, up
-
+To get started, simply visit a @file{.vhd} file in Emacs; or type
address@hidden vhdl-mode RET}.
+
address@hidden New Indentation Engine
@chapter New Indentation Engine
@cindex New Indentation Engine
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
VHDL Mode has a new indentation engine, providing a simplified, yet
flexible and general mechanism for customizing indentation. It breaks
indentation calculation into two steps. First for the line of code being
@@ -271,19 +136,14 @@
being used so that you will know how to customize VHDL Mode for
your personal coding style.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@menu
* Syntactic Analysis:: Step 1 -- Syntactic Analysis
* Indentation Calculation:: Step 2 -- Indentation Calculation
@end menu
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Syntactic Analysis, Indentation Calculation, , New Indentation
Engine
address@hidden node-name, next, previous, up
address@hidden Syntactic Analysis
@section Syntactic Analysis
@cindex Syntactic Analysis
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@vindex vhdl-offsets-alist
@vindex offsets-alist (vhdl-)
@@ -375,12 +235,9 @@
components. Also notice that the first component,
@samp{(comment-intro)} has no relative buffer position.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Indentation Calculation, , Syntactic Analysis, New Indentation
Engine
address@hidden node-name, next, previous, up
address@hidden Indentation Calculation
@section Indentation Calculation
@cindex Indentation Calculation
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@vindex vhdl-offsets-alist
@vindex offsets-alist (vhdl-)
@@ -451,23 +308,18 @@
the minibuffer when you hit @kbd{TAB}.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Indentation Commands, Customizing Indentation, New Indentation
Engine, Top
address@hidden node-name, next, previous, up
-
address@hidden
address@hidden Indentation Commands
@chapter Indentation Commands
@cindex Indentation Commands
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@strong{<TBD>}
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Customizing Indentation, Syntactic Symbols, Indentation
Commands, Top
address@hidden node-name, next, previous, up
-
address@hidden ignore
+
+
address@hidden Customizing Indentation
@chapter Customizing Indentation
@cindex Customizing Indentation
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@cindex vhdl-set-offset
@cindex set-offset (vhdl-)
@@ -478,7 +330,7 @@
interactively and from your mode hook. Also, you can set up
@emph{styles} of indentation. Most likely, you'll find one of the
pre-defined styles will suit your needs, but if not, this section will
-describe how to set up basic editing configurations. @xref{Styles} for
+describe how to set up basic editing configurations. @xref{Styles}, for
an explanation of how to set up named styles.
@cindex vhdl-basic-offset
@@ -532,13 +384,9 @@
* Advanced Customizations::
@end menu
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Interactive Customization, Permanent Customization, ,
Customizing Indentation
address@hidden node-name, next, previous, up
-
address@hidden Interactive Customization
@section Interactive Customization
@cindex Interactive Customization
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
As an example of how to customize indentation, let's change the
style of the example above from:
@@ -620,13 +468,9 @@
always start adjusting offsets for lines higher up in the file, then
re-indent and see if any following lines need further adjustments.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Permanent Customization, Styles, Interactive Customization,
Customizing Indentation
address@hidden node-name, next, previous, up
-
address@hidden Permanent Customization
@section Permanent Indentation
@cindex Permanent Indentation
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@vindex vhdl-mode-hook
@cindex hooks
@@ -639,11 +483,8 @@
file to make the changes described in the previous section
(@ref{Interactive Customization}) more permanent. See the Emacs
manuals for more information on customizing Emacs via hooks.
address@hidden .emacs File} for a more complete sample @file{.emacs} file.
address@hidden use of @code{add-hook} in this example only works for
-Emacs 19. Workarounds are available if you are using Emacs 18, but this
-just points out another reason for you to upgrade to Emacs 19!
address@hidden:-)}}
address@hidden .emacs File}, for a more complete sample @file{.emacs} file.
+
@example
@group
@@ -659,19 +500,15 @@
For complex customizations, you will probably want to set up a
@emph{style} that groups all your customizations under a single
-name. @xref{Styles} for details.
+name. @xref{Styles}.
The offset value can also be a function, and this is how power users
-gain enormous flexibility in customizing indentation. @xref{Advanced
-Customizations} for details.
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Styles, Advanced Customizations, Permanent Customization,
Customizing Indentation
address@hidden node-name, next, previous, up
-
+gain enormous flexibility in customizing indentation. @xref{Advanced
+Customizations}.
+
address@hidden Styles
@section Styles
@cindex Styles
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Most people only need to edit code formatted in just a few well-defined
and consistent styles. For example, their organization might impose a
@@ -692,13 +529,9 @@
@end menu
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Built-in Styles, Adding Styles, , Styles
address@hidden node-name, next, previous, up
-
address@hidden Built-in Styles
@subsection Built-in Styles
@cindex Built-in Styles
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
If you're lucky, one of VHDL Mode's built-in styles might be just
what you're looking for. Some of the most common VHDL styles are
@@ -714,20 +547,15 @@
@findex vhdl-set-style
@findex set-style (vhdl-)
If you'd like to experiment with these built-in styles you can simply
-type the following in a VHDL Mode buffer:
address@hidden
address@hidden
-
address@hidden vhdl-set-style RET}.
-
address@hidden group
address@hidden example
address@hidden
+type @kbd{M-x vhdl-set-style 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
style in this way does @emph{not} automatically re-indent your file.
address@hidden
For commands that you can use to view the effect of your changes, see
@ref{Indentation Commands}.
address@hidden ignore
Once you find a built-in style you like, you can make the change
permanent by adding a call to your @file{.emacs} file. Let's say for
@@ -749,13 +577,9 @@
@noindent
@xref{Permanent Customization}.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Adding Styles, File Styles, Built-in Styles, Styles
address@hidden node-name, next, previous, up
-
address@hidden Adding Styles
@subsection Adding Styles
@cindex Adding Styles
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@vindex vhdl-style-alist
@vindex style-alist (vhdl-)
@@ -777,13 +601,9 @@
The sample @file{.emacs} file provides a concrete example of how a new
style can be added and automatically set. @xref{Sample .emacs File}.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden File Styles, , Adding Styles, Styles
address@hidden node-name, next, previous, up
-
address@hidden File Styles
@subsection File Styles
@cindex File Styles
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@cindex local variables
The Emacs manual describes how you can customize certain variables on a
@@ -816,13 +636,9 @@
before file offset settings (i.e. @code{vhdl-file-offsets}).
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Advanced Customizations, , Styles, Customizing Indentation
address@hidden node-name, next, previous, up
-
address@hidden Advanced Customizations
@section Advanced Customizations
@cindex Advanced Customizations
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@vindex vhdl-style-alist
@vindex style-alist (vhdl-)
@@ -844,13 +660,9 @@
* Other Special Indentations::
@end menu
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Custom Indentation Functions, Other Special Indentations, ,
Advanced Customizations
address@hidden node-name, next, previous, up
-
address@hidden Custom Indentation Functions
@subsection Custom Indentation Functions
@cindex Custom Indentation Functions
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@cindex custom indentation functions
One of the most common ways to customize VHDL Mode is by writing
@@ -959,13 +771,9 @@
using many custom indentation functions may have a performance impact on
VHDL Mode.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Other Special Indentations, , Custom Indentation Functions,
Advanced Customizations
address@hidden node-name, next, previous, up
-
address@hidden Other Special Indentations
@subsection Other Special Indentations
@cindex Other Special Indentations
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@vindex vhdl-special-indent-hook
@vindex special-indent-hook (vhdl-)
@@ -979,13 +787,9 @@
functions.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Syntactic Symbols, Frequently Asked Questions, Customizing
Indentation, Top
address@hidden node-name, next, previous, up
-
address@hidden Syntactic Symbols
@chapter Syntactic Symbols
@cindex Syntactic Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@vindex vhdl-offsets-alist
The complete list of recognized syntactic symbols is described in the
@@ -1012,13 +816,9 @@
@strong{<TBD> include the name and a brief example of every syntactic
symbol currently recognized}
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Frequently Asked Questions, Getting the latest VHDL Mode
release, Syntactic Symbols, Top
address@hidden node-name, next, previous, up
-
address@hidden Frequently Asked Questions
@chapter Frequently Asked Questions
@cindex Frequently Asked Questions
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@kindex C-x h
@kindex ESC C-\
@@ -1057,24 +857,6 @@
C-q}.
@sp 2
address@hidden @emph{Why doesn't the @key{RET} key indent the line to
-where the new text should go after inserting the newline?}
-
address@hidden Emacs' convention is that @key{RET} just adds a newline,
-and that @key{LFD} adds a newline and indents it. You can make
address@hidden do this too by adding this to your
address@hidden (see the sample @file{.emacs} file
address@hidden .emacs File}):
address@hidden
-
-(define-key vhdl-mode-map "\C-m" 'newline-and-indent)
-
address@hidden example
-
-This is a very common question. @code{:-)} If you want this to be the
-default behavior, don't lobby me, lobby RMS!
address@hidden 2
-
@strong{Q.} @emph{I put @code{(vhdl-set-offset 'statement-cont 0)}
in my @file{.emacs} file but I get an error saying that
@code{vhdl-set-offset}'s function definition is void.}
@@ -1097,31 +879,23 @@
@end quotation
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Getting the latest VHDL Mode release, Sample .emacs File,
Frequently Asked Questions, Top
address@hidden node-name, next, previous, up
-
address@hidden Getting the latest VHDL Mode release
@chapter Getting the latest VHDL Mode release
@cindex Getting the latest VHDL Mode release
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
The best way to be sure you always have the latest VHDL Mode release
is to join the @code{vhdl-mode-announce} mailing list. If you are a
brave soul, and wish to participate in beta testing of new releases of
VHDL Mode, you may also join the @code{vhdl-mode-victims} mailing
-list. Send email to the maintainer <reto@@gnu.org> to join
+list. Send email to the maintainer @email{reto@@gnu.org} to join
either of these lists.
The official Emacs VHDL Mode Home Page can be found at
-<http://www.iis.ee.ethz.ch/~zimmi/emacs/vhdl-mode.html>.
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Sample .emacs File, Requirements, Getting the latest VHDL Mode
release, Top
address@hidden node-name, next, previous, up
-
address@hidden://www.iis.ee.ethz.ch/~zimmi/emacs/vhdl-mode.html}.
+
address@hidden Sample .emacs File
@chapter Sample @file{.emacs} file
@cindex Sample @file{.emacs} file
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Most customizations can be done using the `Customize' entry in the
VHDL Mode menu, which requires no editing of the .emacs file.
@@ -1157,43 +931,27 @@
(define-key vhdl-mode-map "\C-m" 'newline-and-indent)
)
-;; the following only works in Emacs 19
-;; Emacs 18ers can use (setq vhdl-mode-hook 'my-vhdl-mode-hook)
(add-hook 'vhdl-mode-hook 'my-vhdl-mode-hook)
@end example
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Requirements, Limitations and Known Bugs, Sample .emacs File,
Top
address@hidden node-name, next, previous, up
address@hidden Requirements
address@hidden Requirements
address@hidden * Requirements
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-All required files are distributed with GNU Emacs 20 and XEmacs 19.15.
-
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Limitations and Known Bugs, Mailing Lists and Submitting Bug
Reports, Requirements, Top
address@hidden node-name, next, previous, up
address@hidden Limitations and Known Bugs
@chapter Limitations and Known Bugs
@cindex Limitations and Known Bugs
address@hidden * Limitations and Known Bugs
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@itemize @bullet
@item
Re-indenting large regions or expressions can be slow.
address@hidden
@item
The index menu does not work on my XEmacs installation (don't know why).
address@hidden ignore
@end itemize
address@hidden Mailing Lists and Submitting Bug Reports, Concept Index,
Limitations and Known Bugs, Top
address@hidden node-name, next, previous, up
address@hidden Mailing Lists and Submitting Bug Reports
@chapter Mailing Lists and Submitting Bug Reports
@cindex Mailing Lists and Submitting Bug Reports
address@hidden * Mailing Lists and Submitting Bug Reports
@kindex C-c C-b
@findex vhdl-submit-bug-report
@@ -1208,35 +966,32 @@
expose the bug. Be especially sure to include any code that appears
@emph{before} your bug example.
-For other help or suggestions, send a message to <reto@@gnu.org>.
+For other help or suggestions, send a message to @email{reto@@gnu.org}.
-Send an add message to <reto@@gnu.org> to get on the
+Send an add message to @email{reto@@gnu.org} to get on the
@code{vhdl-mode-victims} beta testers list where beta releases of
VHDL Mode are posted. Note that you shouldn't expect beta
releases to be as stable as public releases.
There is also an announce only list where the latest public releases
of VHDL Mode are posted. Send an add message to
-<reto@@gnu.org> to be added to this list.
-
address@hidden
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Concept Index, Command Index, Mailing Lists and Submitting
Bug Reports, Top
address@hidden node-name, next, previous, up
address@hidden@@gnu.org} to be added to this list.
+
+
address@hidden GNU Free Documentation License
address@hidden GNU Free Documentation License
address@hidden doclicense.texi
+
+
address@hidden Concept Index
@unnumbered Concept Index
address@hidden
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@printindex cp
address@hidden
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Command Index, Key Index, Concept Index, Top
address@hidden node-name, next, previous, up
address@hidden Command Index
@unnumbered Command Index
address@hidden
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
address@hidden
-
address@hidden ifinfo
+
Since all VHDL Mode commands are prepended with the string
@samp{vhdl-}, each appears under its @code{vhdl-<thing>} name and its
@code{<thing> (vhdl-)} name.
@@ -1246,24 +1001,15 @@
@printindex fn
address@hidden
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Key Index, Variable Index, Command Index, Top
address@hidden node-name, next, previous, up
address@hidden Key Index
@unnumbered Key Index
address@hidden
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@printindex ky
address@hidden
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Variable Index, , Key Index, Top
address@hidden node-name, next, previous, up
address@hidden Variable Index
@unnumbered Variable Index
address@hidden
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
address@hidden
-
address@hidden ifinfo
+
Since all VHDL Mode variables are prepended with the string
@samp{vhdl-}, each appears under its @code{vhdl-<thing>} name and its
@code{<thing> (vhdl-)} name.
@@ -1271,6 +1017,5 @@
@sp 2
@end iftex
@printindex vr
address@hidden
address@hidden
+
@bye
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] trunk r116886: vhdl-mode.texi clean-up,
Glenn Morris <=