diff options
| author | Chong Yidong <cyd@gnu.org> | 2012-04-09 21:05:48 +0800 |
|---|---|---|
| committer | Chong Yidong <cyd@gnu.org> | 2012-04-09 21:05:48 +0800 |
| commit | fb7ada5f94a71d73bf6cfad5cc87fe7fb26125a5 (patch) | |
| tree | eba43d1fa2427a77f1f6b1468838426b33ea5973 /lisp/progmodes | |
| parent | a18ecafa99e7e7c3caa35ed68dd8a7b9b5d2b8e3 (diff) | |
| download | emacs-fb7ada5f94a71d73bf6cfad5cc87fe7fb26125a5.tar.gz | |
Remove * characters from the front of variable docstrings.
Diffstat (limited to 'lisp/progmodes')
42 files changed, 638 insertions, 638 deletions
diff --git a/lisp/progmodes/ada-mode.el b/lisp/progmodes/ada-mode.el index d8768dd5986..33ff4645a77 100644 --- a/lisp/progmodes/ada-mode.el +++ b/lisp/progmodes/ada-mode.el @@ -139,7 +139,7 @@ version-string))) (defvar ada-mode-hook nil - "*List of functions to call when Ada mode is invoked. + "List of functions to call when Ada mode is invoked. This hook is automatically executed after the `ada-mode' is fully loaded. This is a good place to add Ada environment specific bindings.") @@ -150,13 +150,13 @@ This is a good place to add Ada environment specific bindings.") :group 'languages) (defcustom ada-auto-case t - "*Non-nil means automatically change case of preceding word while typing. + "Non-nil means automatically change case of preceding word while typing. Casing is done according to `ada-case-keyword', `ada-case-identifier' and `ada-case-attribute'." :type 'boolean :group 'ada) (defcustom ada-broken-decl-indent 0 - "*Number of columns to indent a broken declaration. + "Number of columns to indent a broken declaration. An example is : declare @@ -165,7 +165,7 @@ An example is : :type 'integer :group 'ada) (defcustom ada-broken-indent 2 - "*Number of columns to indent the continuation of a broken line. + "Number of columns to indent the continuation of a broken line. An example is : My_Var : My_Type := (Field1 => @@ -173,7 +173,7 @@ An example is : :type 'integer :group 'ada) (defcustom ada-continuation-indent ada-broken-indent - "*Number of columns to indent the continuation of broken lines in parenthesis. + "Number of columns to indent the continuation of broken lines in parenthesis. An example is : Func (Param1, @@ -181,7 +181,7 @@ An example is : :type 'integer :group 'ada) (defcustom ada-case-attribute 'ada-capitalize-word - "*Function to call to adjust the case of Ada attributes. + "Function to call to adjust the case of Ada attributes. It may be `downcase-word', `upcase-word', `ada-loose-case-word', `ada-capitalize-word' or `ada-no-auto-case'." :type '(choice (const downcase-word) @@ -193,7 +193,7 @@ It may be `downcase-word', `upcase-word', `ada-loose-case-word', (defcustom ada-case-exception-file (list (convert-standard-filename' "~/.emacs_case_exceptions")) - "*List of special casing exceptions dictionaries for identifiers. + "List of special casing exceptions dictionaries for identifiers. The first file is the one where new exceptions will be saved by Emacs when you call `ada-create-case-exception'. @@ -207,7 +207,7 @@ by a comment." :group 'ada) (defcustom ada-case-keyword 'downcase-word - "*Function to call to adjust the case of an Ada keywords. + "Function to call to adjust the case of an Ada keywords. It may be `downcase-word', `upcase-word', `ada-loose-case-word' or `ada-capitalize-word'." :type '(choice (const downcase-word) @@ -218,7 +218,7 @@ It may be `downcase-word', `upcase-word', `ada-loose-case-word' or :group 'ada) (defcustom ada-case-identifier 'ada-loose-case-word - "*Function to call to adjust the case of an Ada identifier. + "Function to call to adjust the case of an Ada identifier. It may be `downcase-word', `upcase-word', `ada-loose-case-word' or `ada-capitalize-word'." :type '(choice (const downcase-word) @@ -229,7 +229,7 @@ It may be `downcase-word', `upcase-word', `ada-loose-case-word' or :group 'ada) (defcustom ada-clean-buffer-before-saving t - "*Non-nil means remove trailing spaces and untabify the buffer before saving." + "Non-nil means remove trailing spaces and untabify the buffer before saving." :type 'boolean :group 'ada) (make-obsolete-variable 'ada-clean-buffer-before-saving "use the `write-file-functions' hook." @@ -237,7 +237,7 @@ It may be `downcase-word', `upcase-word', `ada-loose-case-word' or (defcustom ada-indent 3 - "*Size of Ada indentation. + "Size of Ada indentation. An example is : procedure Foo is @@ -246,11 +246,11 @@ begin :type 'integer :group 'ada) (defcustom ada-indent-after-return t - "*Non-nil means automatically indent after RET or LFD." + "Non-nil means automatically indent after RET or LFD." :type 'boolean :group 'ada) (defcustom ada-indent-align-comments t - "*Non-nil means align comments on previous line comments, if any. + "Non-nil means align comments on previous line comments, if any. If nil, indentation is calculated as usual. Note that indentation is calculated only if `ada-indent-comment-as-code' is t. @@ -260,12 +260,12 @@ For instance: :type 'boolean :group 'ada) (defcustom ada-indent-comment-as-code t - "*Non-nil means indent comment lines as code. + "Non-nil means indent comment lines as code. A nil value means do not auto-indent comments." :type 'boolean :group 'ada) (defcustom ada-indent-handle-comment-special nil - "*Non-nil if comment lines should be handled specially inside parenthesis. + "Non-nil if comment lines should be handled specially inside parenthesis. By default, if the line that contains the open parenthesis has some text following it, then the following lines will be indented in the same column as this text. This will not be true if the first line is @@ -287,11 +287,11 @@ type A is :type 'boolean :group 'ada) (defcustom ada-indent-is-separate t - "*Non-nil means indent 'is separate' or 'is abstract' if on a single line." + "Non-nil means indent 'is separate' or 'is abstract' if on a single line." :type 'boolean :group 'ada) (defcustom ada-indent-record-rel-type 3 - "*Indentation for 'record' relative to 'type' or 'use'. + "Indentation for 'record' relative to 'type' or 'use'. An example is: type A is @@ -299,7 +299,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-indent-renames ada-broken-indent - "*Indentation for renames relative to the matching function statement. + "Indentation for renames relative to the matching function statement. If `ada-indent-return' is null or negative, the indentation is done relative to the open parenthesis (if there is no parenthesis, `ada-broken-indent' is used). @@ -310,7 +310,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-indent-return 0 - "*Indentation for 'return' relative to the matching 'function' statement. + "Indentation for 'return' relative to the matching 'function' statement. If `ada-indent-return' is null or negative, the indentation is done relative to the open parenthesis (if there is no parenthesis, `ada-broken-indent' is used). @@ -320,22 +320,22 @@ An example is: :type 'integer :group 'ada) (defcustom ada-indent-to-open-paren t - "*Non-nil means indent according to the innermost open parenthesis." + "Non-nil means indent according to the innermost open parenthesis." :type 'boolean :group 'ada) (defcustom ada-fill-comment-prefix "-- " - "*Text inserted in the first columns when filling a comment paragraph. + "Text inserted in the first columns when filling a comment paragraph. Note: if you modify this variable, you will have to invoke `ada-mode' again to take account of the new value." :type 'string :group 'ada) (defcustom ada-fill-comment-postfix " --" - "*Text inserted at the end of each line when filling a comment paragraph. + "Text inserted at the end of each line when filling a comment paragraph. Used by `ada-fill-comment-paragraph-postfix'." :type 'string :group 'ada) (defcustom ada-label-indent -4 - "*Number of columns to indent a label. + "Number of columns to indent a label. An example is: procedure Foo is @@ -346,15 +346,15 @@ This is also used for <<..>> labels" :type 'integer :group 'ada) (defcustom ada-language-version 'ada95 - "*Ada language version; one of `ada83', `ada95', `ada2005'." + "Ada language version; one of `ada83', `ada95', `ada2005'." :type '(choice (const ada83) (const ada95) (const ada2005)) :group 'ada) (defcustom ada-move-to-declaration nil - "*Non-nil means `ada-move-to-start' moves to the subprogram declaration, not to 'begin'." + "Non-nil means `ada-move-to-start' moves to the subprogram declaration, not to 'begin'." :type 'boolean :group 'ada) (defcustom ada-popup-key '[down-mouse-3] - "*Key used for binding the contextual menu. + "Key used for binding the contextual menu. If nil, no contextual menu is available." :type '(restricted-sexp :match-alternatives (stringp vectorp)) :group 'ada) @@ -364,7 +364,7 @@ If nil, no contextual menu is available." (split-string (or (getenv "ADA_INCLUDE_PATH") "") ":") '("/usr/adainclude" "/usr/local/adainclude" "/opt/gnu/adainclude")) - "*Default list of directories to search for Ada files. + "Default list of directories to search for Ada files. See the description for the `ff-search-directories' variable. This variable is the initial value of `ada-search-directories-internal'." :type '(repeat (choice :tag "Directory" @@ -379,7 +379,7 @@ and the standard runtime location, and the value of the user-defined `ada-search-directories'.") (defcustom ada-stmt-end-indent 0 - "*Number of columns to indent the end of a statement on a separate line. + "Number of columns to indent the end of a statement on a separate line. An example is: if A = B @@ -387,7 +387,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-tab-policy 'indent-auto - "*Control the behavior of the TAB key. + "Control the behavior of the TAB key. Must be one of : `indent-rigidly' : always adds `ada-indent' blanks at the beginning of the line. `indent-auto' : use indentation functions in this file. @@ -398,7 +398,7 @@ Must be one of : :group 'ada) (defcustom ada-use-indent ada-broken-indent - "*Indentation for the lines in a 'use' statement. + "Indentation for the lines in a 'use' statement. An example is: use Ada.Text_IO, @@ -406,7 +406,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-when-indent 3 - "*Indentation for 'when' relative to 'exception' or 'case'. + "Indentation for 'when' relative to 'exception' or 'case'. An example is: case A is @@ -414,7 +414,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-with-indent ada-broken-indent - "*Indentation for the lines in a 'with' statement. + "Indentation for the lines in a 'with' statement. An example is: with Ada.Text_IO, @@ -422,7 +422,7 @@ An example is: :type 'integer :group 'ada) (defcustom ada-which-compiler 'gnat - "*Name of the compiler to use. + "Name of the compiler to use. This will determine what features are made available through the Ada mode. The possible choices are: `gnat': Use Ada Core Technologies' GNAT compiler. Add some cross-referencing diff --git a/lisp/progmodes/ada-xref.el b/lisp/progmodes/ada-xref.el index 1e07ac4cf09..146cc703e1a 100644 --- a/lisp/progmodes/ada-xref.el +++ b/lisp/progmodes/ada-xref.el @@ -50,21 +50,21 @@ ;; ------ User variables (defcustom ada-xref-other-buffer t - "*If nil, always display the cross-references in the same buffer. + "If nil, always display the cross-references in the same buffer. Otherwise create either a new buffer or a new frame." :type 'boolean :group 'ada) (defcustom ada-xref-create-ali nil - "*If non-nil, run gcc whenever the cross-references are not up-to-date. + "If non-nil, run gcc whenever the cross-references are not up-to-date. If nil, the cross-reference mode never runs gcc." :type 'boolean :group 'ada) (defcustom ada-xref-confirm-compile nil - "*If non-nil, ask for confirmation before compiling or running the application." + "If non-nil, ask for confirmation before compiling or running the application." :type 'boolean :group 'ada) (defcustom ada-krunch-args "0" - "*Maximum number of characters for filenames created by `gnatkr'. + "Maximum number of characters for filenames created by `gnatkr'. Set to 0, if you don't use crunched filenames. This should be a string." :type 'string :group 'ada) @@ -76,7 +76,7 @@ is faster, available from Ada mode web site." :type 'string :group 'ada) (defcustom ada-gnatls-args '("-v") - "*Arguments to pass to `gnatls' to find location of the runtime. + "Arguments to pass to `gnatls' to find location of the runtime. Typical use is to pass `--RTS=soft-floats' on some systems that support it. You can also add `-I-' if you do not want the current directory to be included. @@ -125,7 +125,7 @@ The command `gnatfind' is used every time you choose the menu (defcustom ada-prj-default-check-cmd (concat "${cross_prefix}gnatmake -u -c -gnatc ${gnatmake_opt} ${full_current}" " -cargs ${comp_opt}") - "*Default command to be used to compile a single file. + "Default command to be used to compile a single file. Emacs will substitute the current filename for ${full_current}, or add the filename at the end. This is the same syntax as in the project file." :type 'string :group 'ada) @@ -133,35 +133,35 @@ the filename at the end. This is the same syntax as in the project file." (defcustom ada-prj-default-comp-cmd (concat "${cross_prefix}gnatmake -u -c ${gnatmake_opt} ${full_current} -cargs" " ${comp_opt}") - "*Default command to be used to compile a single file. + "Default command to be used to compile a single file. Emacs will substitute the current filename for ${full_current}, or add the filename at the end. This is the same syntax as in the project file." :type 'string :group 'ada) (defcustom ada-prj-default-debugger "${cross_prefix}gdb" - "*Default name of the debugger." + "Default name of the debugger." :type 'string :group 'ada) (defcustom ada-prj-default-make-cmd (concat "${cross_prefix}gnatmake -o ${main} ${main} ${gnatmake_opt} " "-cargs ${comp_opt} -bargs ${bind_opt} -largs ${link_opt}") - "*Default command to be used to compile the application. + "Default command to be used to compile the application. This is the same syntax as in the project file." :type 'string :group 'ada) (defcustom ada-prj-default-project-file "" - "*Name of the current project file. + "Name of the current project file. Emacs will not try to use the search algorithm to find the project file if this string is not empty. It is set whenever a project file is found." :type '(file :must-match t) :group 'ada) (defcustom ada-gnatstub-opts "-q -I${src_dir}" - "*Options to pass to `gnatsub' to generate the body of a package. + "Options to pass to `gnatsub' to generate the body of a package. This has the same syntax as in the project file (with variable substitution)." :type 'string :group 'ada) (defcustom ada-always-ask-project nil - "*If nil, use default values when no project file was found. + "If nil, use default values when no project file was found. Otherwise, ask the user for the name of the project file to use." :type 'boolean :group 'ada) @@ -169,12 +169,12 @@ Otherwise, ask the user for the name of the project file to use." "True if we are running on Windows.") (defcustom ada-tight-gvd-integration nil - "*If non-nil, a new Emacs frame will be swallowed in GVD when debugging. + "If non-nil, a new Emacs frame will be swallowed in GVD when debugging. If GVD is not the debugger used, nothing happens." :type 'boolean :group 'ada) (defcustom ada-xref-search-with-egrep t - "*If non-nil, use egrep to find the possible declarations for an entity. + "If non-nil, use egrep to find the possible declarations for an entity. This alternate method is used when the exact location was not found in the information provided by GNAT. However, it might be expensive if you have a lot of sources, since it will search in all the files in your project." diff --git a/lisp/progmodes/antlr-mode.el b/lisp/progmodes/antlr-mode.el index 9c9a8e09d49..345ca563906 100644 --- a/lisp/progmodes/antlr-mode.el +++ b/lisp/progmodes/antlr-mode.el @@ -269,7 +269,7 @@ greater than this number." (integer :tag "Hidden if longer than" :value 3))) (defcustom antlr-indent-comment 'tab - "*Non-nil, if the indentation should touch lines in block comments. + "Non-nil, if the indentation should touch lines in block comments. If nil, no continuation line of a block comment is changed. If t, they are changed according to `c-indentation-line'. When not nil and not t, they are only changed by \\[antlr-indent-command]." @@ -296,7 +296,7 @@ ANTLR's and Java's indentation styles. Used by `antlr-set-tabs'." (boolean :tag "Indent-tabs-mode")))) (defcustom antlr-indent-style "java" - "*If non-nil, cc-mode indentation style used for `antlr-mode'. + "If non-nil, cc-mode indentation style used for `antlr-mode'. See `c-set-style' and for details, where the most interesting part in `c-style-alist' is the value of `c-basic-offset'." :group 'antlr @@ -339,14 +339,14 @@ to the normal rules of `antlr-indent-line'." ;;;=========================================================================== (defcustom antlr-options-use-submenus t - "*Non-nil, if the major mode menu should include option submenus. + "Non-nil, if the major mode menu should include option submenus. If nil, the menu just includes a command to insert options. Otherwise, it includes four submenus to insert file/grammar/rule/subrule options." :group 'antlr :type 'boolean) (defcustom antlr-tool-version 20701 - "*The version number of the Antlr tool. + "The version number of the Antlr tool. The value is an integer of the form XYYZZ which stands for vX.YY.ZZ. This variable is used to warn about non-supported options and to supply version correct option values when using \\[antlr-insert-option]. @@ -358,7 +358,7 @@ can make this variable buffer-local." :type 'integer) (defcustom antlr-options-auto-colon t - "*Non-nil, if `:' is inserted with a rule or subrule options section. + "Non-nil, if `:' is inserted with a rule or subrule options section. A `:' is only inserted if this value is non-nil, if a rule or subrule option is inserted with \\[antlr-insert-option], if there was no rule or subrule options section before, and if a `:' is not already present @@ -378,7 +378,7 @@ is `language-as-string'. See also `antlr-read-value'." :type '(repeat (symbol :tag "Style symbol"))) (defcustom antlr-options-push-mark t - "*Non-nil, if inserting an option should set & push mark. + "Non-nil, if inserting an option should set & push mark. If nil, never set mark when inserting an option with command \\[antlr-insert-option]. If t, always set mark via `push-mark'. If a number, only set mark if point was outside the options area before and @@ -392,7 +392,7 @@ options area before." (sexp :tag "If outside options" :format "%t" :value outside))) (defcustom antlr-options-assign-string " = " - "*String containing `=' to use between option name and value. + "String containing `=' to use between option name and value. This string is only used if the option to insert did not exist before or if there was no `=' after it. In other words, the spacing around an existing `=' won't be changed when changing an option value." @@ -578,21 +578,21 @@ AS-STRING is non-nil and is either t or a symbol which is a member of ;;;=========================================================================== (defcustom antlr-tool-command "java antlr.Tool" - "*Command used in \\[antlr-run-tool] to run the Antlr tool. + "Command used in \\[antlr-run-tool] to run the Antlr tool. This variable should include all options passed to Antlr except the option \"-glib\" which is automatically suggested if necessary." :group 'antlr :type 'string) (defcustom antlr-ask-about-save t - "*If not nil, \\[antlr-run-tool] asks which buffers to save. + "If not nil, \\[antlr-run-tool] asks which buffers to save. Otherwise, it saves all modified buffers before running without asking." :group 'antlr :type 'boolean) (defcustom antlr-makefile-specification '("\n" ("GENS" "GENS%d" " \\\n\t") "$(ANTLR)") - "*Variable to specify the appearance of the generated makefile rules. + "Variable to specify the appearance of the generated makefile rules. This variable influences the output of \\[antlr-show-makefile-rules]. It looks like \(RULE-SEP GEN-VAR-SPEC COMMAND). @@ -650,7 +650,7 @@ See variable `antlr-file-formats-alist' for language dependent formats.") (defvar antlr-unknown-file-formats '("?%s?.g" "?%s?") - "*Formats which specify the names of unknown files. + "Formats which specify the names of unknown files. The value looks like \(SUPER-GRAMMAR-FILE-FORMAT SUPER-EVOCAB-FORMAT). SUPER-GRAMMAR-FORMAT is a format string, it specifies with substitution @@ -685,7 +685,7 @@ DIRECTORY is the name of the current directory.") ;;;=========================================================================== (defcustom antlr-imenu-name t ; (featurep 'xemacs) ; TODO: Emacs-21 bug? - "*Non-nil, if a \"Index\" menu should be added to the menubar. + "Non-nil, if a \"Index\" menu should be added to the menubar. If it is a string, it is used instead \"Index\". Requires package imenu." :group 'antlr @@ -774,7 +774,7 @@ imenu." ;;;=========================================================================== (defcustom antlr-font-lock-maximum-decoration 'inherit - "*The maximum decoration level for fontifying actions. + "The maximum decoration level for fontifying actions. Value `none' means, do not fontify actions, just normal grammar code according to `antlr-font-lock-additional-keywords'. Value `inherit' means, use value of `font-lock-maximum-decoration'. Any other value is diff --git a/lisp/progmodes/asm-mode.el b/lisp/progmodes/asm-mode.el index cfa977d9022..5e15371b406 100644 --- a/lisp/progmodes/asm-mode.el +++ b/lisp/progmodes/asm-mode.el @@ -53,7 +53,7 @@ :group 'languages) (defcustom asm-comment-char ?\; - "*The comment-start character assumed by Asm mode." + "The comment-start character assumed by Asm mode." :type 'character :group 'asm) diff --git a/lisp/progmodes/cfengine.el b/lisp/progmodes/cfengine.el index 4e9a10e3ceb..64e99fb1f3d 100644 --- a/lisp/progmodes/cfengine.el +++ b/lisp/progmodes/cfengine.el @@ -54,7 +54,7 @@ :group 'languages) (defcustom cfengine-indent 2 - "*Size of a CFEngine indentation step in columns." + "Size of a CFEngine indentation step in columns." :group 'cfengine :type 'integer) diff --git a/lisp/progmodes/cmacexp.el b/lisp/progmodes/cmacexp.el index 88c36e8c452..0feefd99715 100644 --- a/lisp/progmodes/cmacexp.el +++ b/lisp/progmodes/cmacexp.el @@ -106,12 +106,12 @@ (defcustom c-macro-shrink-window-flag nil - "*Non-nil means shrink the *Macroexpansion* window to fit its contents." + "Non-nil means shrink the *Macroexpansion* window to fit its contents." :type 'boolean :group 'c-macro) (defcustom c-macro-prompt-flag nil - "*Non-nil makes `c-macro-expand' prompt for preprocessor arguments." + "Non-nil makes `c-macro-expand' prompt for preprocessor arguments." :type 'boolean :group 'c-macro) @@ -141,7 +141,7 @@ option, or to set an equivalent one." :group 'c-macro) (defcustom c-macro-cppflags "" - "*Preprocessor flags used by `c-macro-expand'." + "Preprocessor flags used by `c-macro-expand'." :type 'string :group 'c-macro) diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index c1d8f9db23f..2608ba0b0c3 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -78,7 +78,7 @@ after `call-process' inserts the grep output into the buffer.") This is bound before running `compilation-filter-hook'.") (defvar compilation-first-column 1 - "*This is how compilers number the first column, usually 1 or 0. + "This is how compilers number the first column, usually 1 or 0. If this is buffer-local in the destination buffer, Emacs obeys that value, otherwise it uses the value in the *compilation* buffer. This enables a major-mode to specify its own value.") @@ -90,7 +90,7 @@ in the compilation output, and should return a transformed file name.") ;;;###autoload (defvar compilation-process-setup-function nil - "*Function to call to customize the compilation process. + "Function to call to customize the compilation process. This function is called immediately before the compilation process is started. It can be used to set any variables or functions that are used while processing the output of the compilation process.") @@ -633,7 +633,7 @@ This only affects platforms that support asynchronous processes (see (defvar compilation-locs ()) (defvar compilation-debug nil - "*Set this to t before creating a *compilation* buffer. + "Set this to t before creating a *compilation* buffer. Then every error line will have a debug text property with the matcher that fit this line and the match data. Use `describe-text-properties'.") @@ -739,7 +739,7 @@ Faces `compilation-error-face', `compilation-warning-face', ;; (make-variable-buffer-local 'compilation-buffer-modtime) (defvar compilation-skip-to-next-location t - "*If non-nil, skip multiple error messages for the same source location.") + "If non-nil, skip multiple error messages for the same source location.") (defcustom compilation-skip-threshold 1 "Compilation motion commands skip less important messages. diff --git a/lisp/progmodes/cpp.el b/lisp/progmodes/cpp.el index 8ecfe79de3b..1b36fe2800d 100644 --- a/lisp/progmodes/cpp.el +++ b/lisp/progmodes/cpp.el @@ -52,7 +52,7 @@ :prefix "cpp-") (defcustom cpp-config-file (convert-standard-filename ".cpp.el") - "*File name to save cpp configuration." + "File name to save cpp configuration." :type 'file :group 'cpp) @@ -61,17 +61,17 @@ :type '(choice (const invisible) (face))) (defcustom cpp-known-face 'invisible - "*Face used for known cpp symbols." + "Face used for known cpp symbols." :type 'cpp-face :group 'cpp) (defcustom cpp-unknown-face 'highlight - "*Face used for unknown cpp symbols." + "Face used for unknown cpp symbols." :type 'cpp-face :group 'cpp) (defcustom cpp-face-type 'light - "*Indicate what background face type you prefer. + "Indicate what background face type you prefer. Can be either light or dark for color screens, mono for monochrome screens, and none if you don't use a window system and don't have a color-capable display." @@ -80,12 +80,12 @@ a color-capable display." :group 'cpp) (defcustom cpp-known-writable t - "*Non-nil means you are allowed to modify the known conditionals." + "Non-nil means you are allowed to modify the known conditionals." :type 'boolean :group 'cpp) (defcustom cpp-unknown-writable t - "*Non-nil means you are allowed to modify the unknown conditionals." + "Non-nil means you are allowed to modify the unknown conditionals." :type 'boolean :group 'cpp) diff --git a/lisp/progmodes/cwarn.el b/lisp/progmodes/cwarn.el index 74ca5a6d76f..3e99f3c9176 100644 --- a/lisp/progmodes/cwarn.el +++ b/lisp/progmodes/cwarn.el @@ -120,7 +120,7 @@ :group 'faces) (defvar cwarn-mode nil - "*Non-nil when Cwarn mode is active. + "Non-nil when Cwarn mode is active. Never set this variable directly, use the command `cwarn-mode' instead.") diff --git a/lisp/progmodes/dcl-mode.el b/lisp/progmodes/dcl-mode.el index 166065131b2..af0ae9d1123 100644 --- a/lisp/progmodes/dcl-mode.el +++ b/lisp/progmodes/dcl-mode.el @@ -98,7 +98,7 @@ Presently this includes some syntax, .OP.erators, and \"f$\" lexicals.") :group 'languages) (defcustom dcl-basic-offset 4 - "*Number of columns to indent a block in DCL. + "Number of columns to indent a block in DCL. A block is the commands between THEN-ELSE-ENDIF and between the commands dcl-block-begin-regexp and dcl-block-end-regexp. @@ -109,7 +109,7 @@ dcl-calc-command-indent-function is set to a function." (defcustom dcl-continuation-offset 6 - "*Number of columns to indent a continuation line in DCL. + "Number of columns to indent a continuation line in DCL. A continuation line is a line that follows a line ending with `-'. The meaning of this variable may be changed if @@ -119,7 +119,7 @@ dcl-calc-cont-indent-function is set to a function." (defcustom dcl-margin-offset 8 - "*Indentation for the first command line in DCL. + "Indentation for the first command line in DCL. The first command line in a file or after a SUBROUTINE statement is indented this much. Other command lines are indented the same number of columns as the preceding command line. @@ -129,7 +129,7 @@ A command line is a line that starts with `$'." (defcustom dcl-margin-label-offset 2 - "*Number of columns to indent a margin label in DCL. + "Number of columns to indent a margin label in DCL. A margin label is a label that doesn't begin or end a block, i.e. it doesn't match dcl-block-begin-regexp or dcl-block-end-regexp." :type 'integer @@ -137,28 +137,28 @@ doesn't match dcl-block-begin-regexp or dcl-block-end-regexp." (defcustom dcl-comment-line-regexp "^\\$!" - "*Regexp describing the start of a comment line in DCL. + "Regexp describing the start of a comment line in DCL. Comment lines are not indented." :type 'regexp :group 'dcl) (defcustom dcl-block-begin-regexp "loop[0-9]*:" - "*Regexp describing a command that begins an indented block in DCL. + "Regexp describing a command that begins an indented block in DCL. Set to nil to only indent at THEN-ELSE-ENDIF." :type 'regexp :group 'dcl) (defcustom dcl-block-end-regexp "endloop[0-9]*:" - "*Regexp describing a command that ends an indented block in DCL. + "Regexp describing a command that ends an indented block in DCL. Set to nil to only indent at THEN-ELSE-ENDIF." :type 'regexp :group 'dcl) (defcustom dcl-calc-command-indent-function nil - "*Function to calculate indentation for a command line in DCL. + "Function to calculate indentation for a command line in DCL. If this variable is non-nil it is called as a function: \(func INDENT-TYPE CUR-INDENT EXTRA-INDENT LAST-POINT THIS-POINT) @@ -190,7 +190,7 @@ This package includes two functions suitable for this: (defcustom dcl-calc-cont-indent-function 'dcl-calc-cont-indent-relative - "*Function to calculate indentation for a continuation line. + "Function to calculate indentation for a continuation line. If this variable is non-nil it is called as a function: \(func CUR-INDENT EXTRA-INDENT) @@ -208,7 +208,7 @@ This package includes one function suitable for this: (defcustom dcl-tab-always-indent t - "*Controls the operation of the TAB key in DCL mode. + "Controls the operation of the TAB key in DCL mode. If t, pressing TAB always indents the current line. If nil, pressing TAB indents the current line if point is at the left margin. Data lines (i.e. lines not part of a command line or continuation line) are @@ -218,43 +218,43 @@ never indented." (defcustom dcl-electric-characters t - "*Non-nil means reindent immediately when a label, ELSE or ENDIF is inserted." + "Non-nil means reindent immediately when a label, ELSE or ENDIF is inserted." :type 'boolean :group 'dcl) (defcustom dcl-tempo-comma ", " - "*Text to insert when a comma is needed in a template, in DCL mode." + "Text to insert when a comma is needed in a template, in DCL mode." :type 'string :group 'dcl) (defcustom dcl-tempo-left-paren "(" - "*Text to insert when a left parenthesis is needed in a template in DCL." + "Text to insert when a left parenthesis is needed in a template in DCL." :type 'string :group 'dcl) (defcustom dcl-tempo-right-paren ")" - "*Text to insert when a right parenthesis is needed in a template in DCL." + "Text to insert when a right parenthesis is needed in a template in DCL." :type 'string :group 'dcl) ; I couldn't decide what looked best, so I'll let you decide... ; Remember, you can also customize this with imenu-submenu-name-format. (defcustom dcl-imenu-label-labels "Labels" - "*Imenu menu title for sub-listing with label names." + "Imenu menu title for sub-listing with label names." :type 'string :group 'dcl) (defcustom dcl-imenu-label-goto "GOTO" - "*Imenu menu title for sub-listing with GOTO statements." + "Imenu menu title for sub-listing with GOTO statements." :type 'string :group 'dcl) (defcustom dcl-imenu-label-gosub "GOSUB" - "*Imenu menu title for sub-listing with GOSUB statements." + "Imenu menu title for sub-listing with GOSUB statements." :type 'string :group 'dcl) (defcustom dcl-imenu-label-call "CALL" - "*Imenu menu title for sub-listing with CALL statements." + "Imenu menu title for sub-listing with CALL statements." :type 'string :group 'dcl) @@ -265,7 +265,7 @@ never indented." (,dcl-imenu-label-goto "\\s-GOTO[ \t]+\\([A-Za-z0-9_\$]+\\)" 1) (,dcl-imenu-label-gosub "\\s-GOSUB[ \t]+\\([A-Za-z0-9_\$]+\\)" 1) (,dcl-imenu-label-call "\\s-CALL[ \t]+\\([A-Za-z0-9_\$]+\\)" 1)) - "*Default imenu generic expression for DCL. + "Default imenu generic expression for DCL. The default includes SUBROUTINE labels in the main listing and sub-listings for other labels, CALL, GOTO and GOSUB statements. @@ -275,7 +275,7 @@ See `imenu-generic-expression' for details." (defcustom dcl-mode-hook nil - "*Hook called by `dcl-mode'." + "Hook called by `dcl-mode'." :type 'hook :group 'dcl) @@ -400,7 +400,7 @@ optionally followed by a comment, followed by a newline." (defcustom dcl-electric-reindent-regexps (list "endif" "else" dcl-label-r) - "*Regexps that can trigger an electric reindent. + "Regexps that can trigger an electric reindent. A list of regexps that will trigger a reindent if the last letter is defined as dcl-electric-character. diff --git a/lisp/progmodes/delphi.el b/lisp/progmodes/delphi.el index dd8d267683c..d533135c70d 100644 --- a/lisp/progmodes/delphi.el +++ b/lisp/progmodes/delphi.el @@ -74,7 +74,7 @@ "True if in debug mode.") (defcustom delphi-search-path "." - "*Directories to search when finding external units. + "Directories to search when finding external units. It is a list of directory strings. If only a single directory, it can be a single string instead of a list. If a directory ends in \"...\" then that directory is recursively searched." @@ -82,7 +82,7 @@ ends in \"...\" then that directory is recursively searched." :group 'delphi) (defcustom delphi-indent-level 3 - "*Indentation of Delphi statements with respect to containing block. + "Indentation of Delphi statements with respect to containing block. E.g. begin @@ -92,7 +92,7 @@ end;" :group 'delphi) (defcustom delphi-compound-block-indent 0 - "*Extra indentation for blocks in compound statements. E.g. + "Extra indentation for blocks in compound statements. E.g. // block indent = 0 vs // block indent = 2 if b then if b then @@ -105,7 +105,7 @@ end; else :group 'delphi) (defcustom delphi-case-label-indent delphi-indent-level - "*Extra indentation for case statement labels. E.g. + "Extra indentation for case statement labels. E.g. // case indent = 0 vs // case indent = 3 case value of case value of @@ -118,18 +118,18 @@ end; end;" :group 'delphi) (defcustom delphi-verbose t ; nil - "*If true then Delphi token processing progress is reported to the user." + "If true then Delphi token processing progress is reported to the user." :type 'boolean :group 'delphi) (defcustom delphi-tab-always-indents t - "*Non-nil means TAB in Delphi mode should always reindent the current line, + "Non-nil means TAB in Delphi mode should always reindent the current line, regardless of where in the line point is when the TAB command is used." :type 'boolean :group 'delphi) (defcustom delphi-newline-always-indents t - "*Non-nil means NEWLINE in Delphi mode should always reindent the current + "Non-nil means NEWLINE in Delphi mode should always reindent the current line, insert a blank line and move to the default indent column of the blank line. If nil, then no indentation occurs, and NEWLINE does the usual behavior. This is useful when one needs to do customized indentation that @@ -138,22 +138,22 @@ differs from the default." :group 'delphi) (defcustom delphi-comment-face 'font-lock-comment-face - "*Face used to color Delphi comments." + "Face used to color Delphi comments." :type 'face :group 'delphi) (defcustom delphi-string-face 'font-lock-string-face - "*Face used to color Delphi strings." + "Face used to color Delphi strings." :type 'face :group 'delphi) (defcustom delphi-keyword-face 'font-lock-keyword-face - "*Face used to color Delphi keywords." + "Face used to color Delphi keywords." :type 'face :group 'delphi) (defcustom delphi-other-face nil - "*Face used to color everything else." + "Face used to color everything else." :type '(choice (const :tag "None" nil) face) :group 'delphi) diff --git a/lisp/progmodes/ebnf2ps.el b/lisp/progmodes/ebnf2ps.el index 5d0bfad0366..05c9e160ceb 100644 --- a/lisp/progmodes/ebnf2ps.el +++ b/lisp/progmodes/ebnf2ps.el @@ -1276,14 +1276,14 @@ Elements of ALIST that are not conses are ignored." (defcustom ebnf-horizontal-orientation nil - "*Non-nil means productions are drawn horizontally." + "Non-nil means productions are drawn horizontally." :type 'boolean :version "20" :group 'ebnf-displacement) (defcustom ebnf-horizontal-max-height nil - "*Non-nil means to use maximum production height in horizontal orientation. + "Non-nil means to use maximum production height in horizontal orientation. It is only used when `ebnf-horizontal-orientation' is non-nil." :type 'boolean @@ -1292,7 +1292,7 @@ It is only used when `ebnf-horizontal-orientation' is non-nil." (defcustom ebnf-production-horizontal-space 0.0 ; use ebnf2ps default value - "*Specify horizontal space in points between productions. + "Specify horizontal space in points between productions. Value less or equal to zero forces ebnf2ps to set a proper default value." :type 'number @@ -1301,7 +1301,7 @@ Value less or equal to zero forces ebnf2ps to set a proper default value." (defcustom ebnf-production-vertical-space 0.0 ; use ebnf2ps default value - "*Specify vertical space in points between productions. + "Specify vertical space in points between productions. Value less or equal to zero forces ebnf2ps to set a proper default value." :type 'number @@ -1310,7 +1310,7 @@ Value less or equal to zero forces ebnf2ps to set a proper default value." (defcustom ebnf-justify-sequence 'center - "*Specify justification of terms in a sequence inside alternatives. + "Specify justification of terms in a sequence inside alternatives. Valid values are: @@ -1324,14 +1324,14 @@ Valid values are: (defcustom ebnf-special-show-delimiter t - "*Non-nil means special delimiter (character `?') is shown." + "Non-nil means special delimiter (character `?') is shown." :type 'boolean :version "20" :group 'ebnf-special) (defcustom ebnf-special-font '(7 Courier "Black" "Gray95" bold italic) - "*Specify special font. + "Specify special font. See documentation for `ebnf-production-font'." :type '(list :tag "Special Font" @@ -1353,7 +1353,7 @@ See documentation for `ebnf-production-font'." (defcustom ebnf-special-shape 'bevel - "*Specify special box shape. + "Specify special box shape. See documentation for `ebnf-non-terminal-shape'." :type '(radio :tag "Special Shape" @@ -1363,28 +1363,28 @@ See documentation for `ebnf-non-terminal-shape'." (defcustom ebnf-special-shadow nil - "*Non-nil means special box will have a shadow." + "Non-nil means special box will have a shadow." :type 'boolean :version "20" :group 'ebnf-special) (defcustom ebnf-special-border-width 0.5 - "*Specify border width for special box." + "Specify border width for special box." :type 'number :version "20" :group 'ebnf-special) (defcustom ebnf-special-border-color "Black" - "*Specify border color for special box." + "Specify border color for special box." :type 'string :version "20" :group 'ebnf-special) (defcustom ebnf-except-font '(7 Courier "Black" "Gray90" bold italic) - "*Specify except font. + "Specify except font. See documentation for `ebnf-production-font'." :type '(list :tag "Except Font" @@ -1406,7 +1406,7 @@ See documentation for `ebnf-production-font'." (defcustom ebnf-except-shape 'bevel - "*Specify except box shape. + "Specify except box shape. See documentation for `ebnf-non-terminal-shape'." :type '(radio :tag "Except Shape" @@ -1416,28 +1416,28 @@ See documentation for `ebnf-non-terminal-shape'." (defcustom ebnf-except-shadow nil - "*Non-nil means except box will have a shadow." + "Non-nil means except box will have a shadow." :type 'boolean :version "20" :group 'ebnf-except) (defcustom ebnf-except-border-width 0.25 - "*Specify border width for except box." + "Specify border width for except box." :type 'number :version "20" :group 'ebnf-except) (defcustom ebnf-except-border-color "Black" - "*Specify border color for except box." + "Specify border color for except box." :type 'string :version "20" :group 'ebnf-except) (defcustom ebnf-repeat-font '(7 Courier "Black" "Gray85" bold italic) - "*Specify repeat font. + "Specify repeat font. See documentation for `ebnf-production-font'." :type '(list :tag "Repeat Font" @@ -1459,7 +1459,7 @@ See documentation for `ebnf-production-font'." (defcustom ebnf-repeat-shape 'bevel - "*Specify repeat box shape. + "Specify repeat box shape. See documentation for `ebnf-non-terminal-shape'." :type '(radio :tag "Repeat Shape" @@ -1469,28 +1469,28 @@ See documentation for `ebnf-non-terminal-shape'." (defcustom ebnf-repeat-shadow nil - "*Non-nil means repeat box will have a shadow." + "Non-nil means repeat box will have a shadow." :type 'boolean :version "20" :group 'ebnf-repeat) (defcustom ebnf-repeat-border-width 0.0 - "*Specify border width for repeat box." + "Specify border width for repeat box." :type 'number :version "20" :group 'ebnf-repeat) (defcustom ebnf-repeat-border-color "Black" - "*Specify border color for repeat box." + "Specify border color for repeat box." :type 'string :version "20" :group 'ebnf-repeat) (defcustom ebnf-terminal-font '(7 Courier "Black" "White") - "*Specify terminal font. + "Specify terminal font. See documentation for `ebnf-production-font'." :type '(list :tag "Terminal Font" @@ -1512,7 +1512,7 @@ See documentation for `ebnf-production-font'." (defcustom ebnf-terminal-shape 'miter - "*Specify terminal box shape. + "Specify terminal box shape. See documentation for `ebnf-non-terminal-shape'." :type '(radio :tag "Terminal Shape" @@ -1522,35 +1522,35 @@ See documentation for `ebnf-non-terminal-shape'." (defcustom ebnf-terminal-shadow nil - "*Non-nil means terminal box will have a shadow." + "Non-nil means terminal box will have a shadow." :type 'boolean :version "20" :group 'ebnf-terminal) (defcustom ebnf-terminal-border-width 1.0 - "*Specify border width for terminal box." + "Specify border width for terminal box." :type 'number :version "20" :group 'ebnf-terminal) (defcustom ebnf-terminal-border-color "Black" - "*Specify border color for terminal box." + "Specify border color for terminal box." :type 'string :version "20" :group 'ebnf-terminal) (defcustom ebnf-production-name-p t - "*Non-nil means production name will be printed." + "Non-nil means production name will be printed." :type 'boolean :version "20" :group 'ebnf-production) (defcustom ebnf-sort-production nil - "*Specify how productions are sorted. + "Specify how productions are sorted. Valid values are: @@ -1566,7 +1566,7 @@ Valid values are: (defcustom ebnf-production-font '(10 Helvetica "Black" "White" bold) - "*Specify production header font. + "Specify production header font. It is a list with the following form: @@ -1609,7 +1609,7 @@ See `ps-font-info-database' for valid font name." (defcustom ebnf-non-terminal-font '(7 Helvetica "Black" "White") - "*Specify non-terminal font. + "Specify non-terminal font. See documentation for `ebnf-production-font'." :type '(list :tag "Non-Terminal Font" @@ -1631,7 +1631,7 @@ See documentation for `ebnf-production-font'." (defcustom ebnf-non-terminal-shape 'round - "*Specify non-terminal box shape. + "Specify non-terminal box shape. Valid values are: @@ -1655,28 +1655,28 @@ Any other value is treated as `miter'." (defcustom ebnf-non-terminal-shadow nil - "*Non-nil means non-terminal box will have a shadow." + "Non-nil means non-terminal box will have a shadow." :type 'boolean :version "20" :group 'ebnf-non-terminal) (defcustom ebnf-non-terminal-border-width 1.0 - "*Specify border width for non-terminal box." + "Specify border width for non-terminal box." :type 'number :version "20" :group 'ebnf-non-terminal) (defcustom ebnf-non-terminal-border-color "Black" - "*Specify border color for non-terminal box." + "Specify border color for non-terminal box." :type 'string :version "20" :group 'ebnf-non-terminal) (defcustom ebnf-arrow-shape 'hollow - "*Specify the arrow shape. + "Specify the arrow shape. Valid values are: @@ -1733,7 +1733,7 @@ Any other value is treated as `none'." (defcustom ebnf-chart-shape 'round - "*Specify chart flow shape. + "Specify chart flow shape. See documentation for `ebnf-non-terminal-shape'." :type '(radio :tag "Chart Flow Shape" @@ -1743,7 +1743,7 @@ See documentation for `ebnf-non-terminal-shape'." (defcustom ebnf-user-arrow nil - "*Specify a sexp for user arrow shape (a PostScript code). + "Specify a sexp for user arrow shape (a PostScript code). When evaluated, the sexp should return nil or a string containing PostScript code. PostScript code should draw a right arrow. @@ -1783,7 +1783,7 @@ symbol `user'." (defcustom ebnf-syntax 'ebnf - "*Specify syntax to be recognized. + "Specify syntax to be recognized. Valid values are: @@ -1827,7 +1827,7 @@ Any other value is treated as `ebnf'." (defcustom ebnf-lex-comment-char ?\; - "*Specify the line comment character. + "Specify the line comment character. It's used only when `ebnf-syntax' is `ebnf'." :type 'character @@ -1836,7 +1836,7 @@ It's used only when `ebnf-syntax' is `ebnf'." (defcustom ebnf-lex-eop-char ?. - "*Specify the end of production character. + "Specify the end of production character. It's used only when `ebnf-syntax' is `ebnf'." :type 'character @@ -1845,7 +1845,7 @@ It's used only when `ebnf-syntax' is `ebnf'." (defcustom ebnf-terminal-regexp nil - "*Specify how it's a terminal name. + "Specify how it's a terminal name. If it's nil, the terminal name must be enclosed by `\"'. If it's a string, it should be a regexp that it'll be used to determine a @@ -1859,7 +1859,7 @@ It's used only when `ebnf-syntax' is `ebnf'." (defcustom ebnf-case-fold-search nil - "*Non-nil means ignore case on matching. + "Non-nil means ignore case on matching. It's only used when `ebnf-terminal-regexp' is non-nil and when `ebnf-syntax' is `ebnf'." @@ -1869,7 +1869,7 @@ It's only used when `ebnf-terminal-regexp' is non-nil and when `ebnf-syntax' is (defcustom ebnf-iso-alternative-p nil - "*Non-nil means use alternative ISO EBNF. + "Non-nil means use alternative ISO EBNF. It's only used when `ebnf-syntax' is `iso-ebnf'. @@ -1888,7 +1888,7 @@ This variable affects the following symbol set: (defcustom ebnf-iso-normalize-p nil - "*Non-nil means normalize ISO EBNF syntax names. + "Non-nil means normalize ISO EBNF syntax names. Normalize a name means that several contiguous spaces inside name become a single space, so \"A B C\" is normalized to \"A B C\". @@ -1900,7 +1900,7 @@ It's only used when `ebnf-syntax' is `iso-ebnf'." (defcustom ebnf-file-suffix-regexp "\.[Bb][Nn][Ff]$" - "*Specify file name suffix that contains EBNF. + "Specify file name suffix that contains EBNF. See `ebnf-eps-directory' command." :type 'regexp @@ -1909,7 +1909,7 @@ See `ebnf-eps-directory' command." (defcustom ebnf-eps-prefix "ebnf--" - "*Specify EPS prefix file name. + "Specify EPS prefix file name. See `ebnf-eps-buffer' and `ebnf-eps-region' commands." :type 'string @@ -1918,7 +1918,7 @@ See `ebnf-eps-buffer' and `ebnf-eps-region' commands." (defcustom ebnf-eps-header-font '(11 Helvetica "Black" "White" bold) - "*Specify EPS header font. + "Specify EPS header font. See documentation for `ebnf-production-font'. @@ -1942,7 +1942,7 @@ See `ebnf-eps-buffer' and `ebnf-eps-region' commands." (defcustom ebnf-eps-header nil - "*Specify EPS header. + "Specify EPS header. The value should be a string, a symbol or nil. @@ -1978,7 +1978,7 @@ empty string, no header is generated until a non-empty header is specified or (defcustom ebnf-eps-footer-font '(7 Helvetica "Black" "White" bold) - "*Specify EPS footer font. + "Specify EPS footer font. See documentation for `ebnf-production-font'. @@ -2002,7 +2002,7 @@ See `ebnf-eps-buffer' and `ebnf-eps-region' commands." (defcustom ebnf-eps-footer nil - "*Specify EPS footer. + "Specify EPS footer. The value should be a string, a symbol or nil. @@ -2038,7 +2038,7 @@ empty string, no footer is generated until a non-empty footer is specified or (defcustom ebnf-entry-percentage 0.5 ; middle - "*Specify entry height on alternatives. + "Specify entry height on alternatives. It must be a float between 0.0 (top) and 1.0 (bottom)." :type 'number @@ -2047,7 +2047,7 @@ It must be a float between 0.0 (top) and 1.0 (bottom)." (defcustom ebnf-default-width 0.6 - "*Specify additional border width over default terminal, non-terminal or + "Specify additional border width over default terminal, non-terminal or special." :type 'number :version "20" @@ -2057,21 +2057,21 @@ special." ;; Printing color requires x-color-values. (defcustom ebnf-color-p (or (fboundp 'x-color-values) ; Emacs (fboundp 'color-instance-rgb-components)) ; XEmacs - "*Non-nil means use color." + "Non-nil means use color." :type 'boolean :version "20" :group 'ebnf2ps) (defcustom ebnf-line-width 1.0 - "*Specify flow line width." + "Specify flow line width." :type 'number :version "20" :group 'ebnf2ps) (defcustom ebnf-line-color "Black" - "*Specify flow line color." + "Specify flow line color." :type 'string :version "20" :group 'ebnf2ps) @@ -2081,7 +2081,7 @@ special." (if (eq ebnf-arrow-shape 'none) 0.0 (* (sqrt 5.0) 0.65 ebnf-line-width)) - "*Specify extra width for arrow shape drawing. + "Specify extra width for arrow shape drawing. The extra width is used to avoid that the arrowhead and the terminal border overlap. It depends on `ebnf-arrow-shape' and `ebnf-line-width'." @@ -2091,7 +2091,7 @@ overlap. It depends on `ebnf-arrow-shape' and `ebnf-line-width'." (defcustom ebnf-arrow-scale 1.0 - "*Specify the arrow scale. + "Specify the arrow scale. Values lower than 1.0, shrink the arrow. Values greater than 1.0, expand the arrow." @@ -2101,7 +2101,7 @@ Values greater than 1.0, expand the arrow." (defcustom ebnf-debug-ps nil - "*Non-nil means to generate PostScript debug procedures. + "Non-nil means to generate PostScript debug procedures. It is intended to help PostScript programmers in debugging." :type 'boolean @@ -2110,7 +2110,7 @@ It is intended to help PostScript programmers in debugging." (defcustom ebnf-use-float-format t - "*Non-nil means use `%f' float format. + "Non-nil means use `%f' float format. The advantage of using float format is that ebnf2ps generates a little short PostScript file. @@ -2126,14 +2126,14 @@ when executing ebnf2ps, set `ebnf-use-float-format' to nil." (defcustom ebnf-stop-on-error nil - "*Non-nil means signal error and stop. Otherwise, signal error and continue." + "Non-nil means signal error and stop. Otherwise, signal error and continue." :type 'boolean :version "20" :group 'ebnf2ps) (defcustom ebnf-yac-ignore-error-recovery nil - "*Non-nil means ignore error recovery. + "Non-nil means ignore error recovery. It's only used when `ebnf-syntax' is `yacc'." :type 'boolean @@ -2142,7 +2142,7 @@ It's only used when `ebnf-syntax' is `yacc'." (defcustom ebnf-ignore-empty-rule nil - "*Non-nil means ignore empty rules. + "Non-nil means ignore empty rules. It's interesting to set this variable if your Yacc/Bison grammar has a lot of middle action rule." @@ -2152,7 +2152,7 @@ middle action rule." (defcustom ebnf-optimize nil - "*Non-nil means optimize syntactic chart of rules. + "Non-nil means optimize syntactic chart of rules. The following optimizations are done: @@ -2179,7 +2179,7 @@ The above optimizations are specially useful when `ebnf-syntax' is `yacc'." (defcustom ebnf-log nil - "*Non-nil means generate log messages. + "Non-nil means generate log messages. The log messages are generated into the buffer *Ebnf2ps Log*. These messages are intended to help debugging ebnf2ps." diff --git a/lisp/progmodes/ebrowse.el b/lisp/progmodes/ebrowse.el index 4a07392c309..849ca4b7c9d 100644 --- a/lisp/progmodes/ebrowse.el +++ b/lisp/progmodes/ebrowse.el @@ -50,7 +50,7 @@ (defcustom ebrowse-search-path nil - "*List of directories to search for source files in a class tree. + "List of directories to search for source files in a class tree. Elements should be directory names; nil as an element means to try to find source files relative to the location of the BROWSE file loaded." :group 'ebrowse @@ -59,25 +59,25 @@ to find source files relative to the location of the BROWSE file loaded." (defcustom ebrowse-view/find-hook nil - "*Hooks run after finding or viewing a member or class." + "Hooks run after finding or viewing a member or class." :group 'ebrowse :type 'hook) (defcustom ebrowse-not-found-hook nil - "*Hooks run when finding or viewing a member or class was not successful." + "Hooks run when finding or viewing a member or class was not successful." :group 'ebrowse :type 'hook) (defcustom ebrowse-electric-list-mode-hook nil - "*Hook called by `ebrowse-electric-position-mode'." + "Hook called by `ebrowse-electric-position-mode'." :group 'ebrowse :type 'hook) (defcustom ebrowse-max-positions 50 - "*Number of markers saved on electric position stack." + "Number of markers saved on electric position stack." :group 'ebrowse :type 'integer) @@ -89,31 +89,31 @@ to find source files relative to the location of the BROWSE file loaded." (defcustom ebrowse-tree-mode-hook nil - "*Hook run in each new tree buffer." + "Hook run in each new tree buffer." :group 'ebrowse-tree :type 'hook) (defcustom ebrowse-tree-buffer-name "*Tree*" - "*The default name of class tree buffers." + "The default name of class tree buffers." :group 'ebrowse-tree :type 'string) (defcustom ebrowse--indentation 4 - "*The amount by which subclasses are indented in the tree." + "The amount by which subclasses are indented in the tree." :group 'ebrowse-tree :type 'integer) (defcustom ebrowse-source-file-column 40 - "*The column in which source file names are displayed in the tree." + "The column in which source file names are displayed in the tree." :group 'ebrowse-tree :type 'integer) (defcustom ebrowse-tree-left-margin 2 - "*Amount of space left at the left side of the tree display. + "Amount of space left at the left side of the tree display. This space is used to display markers." :group 'ebrowse-tree :type 'integer) @@ -126,25 +126,25 @@ This space is used to display markers." (defcustom ebrowse-default-declaration-column 25 - "*The column in which member declarations are displayed in member buffers." + "The column in which member declarations are displayed in member buffers." :group 'ebrowse-member :type 'integer) (defcustom ebrowse-default-column-width 25 - "*The width of the columns in member buffers (short display form)." + "The width of the columns in member buffers (short display form)." :group 'ebrowse-member :type 'integer) (defcustom ebrowse-member-buffer-name "*Members*" - "*The name of the buffer for member display." + "The name of the buffer for member display." :group 'ebrowse-member :type 'string) (defcustom ebrowse-member-mode-hook nil - "*Run in each new member buffer." + "Run in each new member buffer." :group 'ebrowse-member :type 'hook) @@ -158,7 +158,7 @@ This space is used to display markers." (defface ebrowse-tree-mark '((((min-colors 88)) (:foreground "red1")) (t (:foreground "red"))) - "*The face used for the mark character in the tree." + "The face used for the mark character in the tree." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-tree-mark-face 'ebrowse-tree-mark "22.1") @@ -166,21 +166,21 @@ This space is used to display markers." (defface ebrowse-root-class '((((min-colors 88)) (:weight bold :foreground "blue1")) (t (:weight bold :foreground "blue"))) - "*The face used for root classes in the tree." + "The face used for root classes in the tree." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-root-class-face 'ebrowse-root-class "22.1") (defface ebrowse-file-name '((t (:italic t))) - "*The face for filenames displayed in the tree." + "The face for filenames displayed in the tree." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-file-name-face 'ebrowse-file-name "22.1") (defface ebrowse-default '((t nil)) - "*Face for everything else in the tree not having other faces." + "Face for everything else in the tree not having other faces." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-default-face 'ebrowse-default "22.1") @@ -188,7 +188,7 @@ This space is used to display markers." (defface ebrowse-member-attribute '((((min-colors 88)) (:foreground "red1")) (t (:foreground "red"))) - "*Face used to display member attributes." + "Face used to display member attributes." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-member-attribute-face 'ebrowse-member-attribute "22.1") @@ -196,7 +196,7 @@ This space is used to display markers." (defface ebrowse-member-class '((t (:foreground "purple"))) - "*Face used to display the class title in member buffers." + "Face used to display the class title in member buffers." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-member-class-face 'ebrowse-member-class "22.1") @@ -205,7 +205,7 @@ This space is used to display markers." (defface ebrowse-progress '((((min-colors 88)) (:background "blue1")) (t (:background "blue"))) - "*Face for progress indicator." + "Face for progress indicator." :group 'ebrowse-faces) (define-obsolete-face-alias 'ebrowse-progress-face 'ebrowse-progress "22.1") @@ -4178,7 +4178,7 @@ NUMBER-OF-STATIC-VARIABLES:" ;; prefix `\C-c\C-m' to browse commands. (defvar ebrowse-global-map nil - "*Keymap for Ebrowse commands.") + "Keymap for Ebrowse commands.") (defvar ebrowse-global-prefix-key "\C-c\C-m" diff --git a/lisp/progmodes/etags.el b/lisp/progmodes/etags.el index 6bb86738df0..d8a561340d3 100644 --- a/lisp/progmodes/etags.el +++ b/lisp/progmodes/etags.el @@ -33,7 +33,7 @@ ;;;###autoload (defvar tags-file-name nil - "*File name of tags table. + "File name of tags table. To switch to a new tags table, setting this variable is sufficient. If you set this variable, do not also set `tags-table-list'. Use the `etags' program to make a tags table file.") @@ -46,7 +46,7 @@ Use the `etags' program to make a tags table file.") ;;;###autoload (defcustom tags-case-fold-search 'default - "*Whether tags operations should be case-sensitive. + "Whether tags operations should be case-sensitive. A value of t means case-insensitive, a value of nil means case-sensitive. Any other value means use the setting of `case-fold-search'." :group 'etags @@ -58,7 +58,7 @@ Any other value means use the setting of `case-fold-search'." ;;;###autoload ;; Use `visit-tags-table-buffer' to cycle through tags tables in this list. (defcustom tags-table-list nil - "*List of file names of tags tables to search. + "List of file names of tags tables to search. An element that is a directory means the file \"TAGS\" in that directory. To switch to a new list of tags tables, setting this variable is sufficient. If you set this variable, do not also set `tags-file-name'. @@ -69,7 +69,7 @@ Use the `etags' program to make a tags table file." ;;;###autoload (defcustom tags-compression-info-list (purecopy '("" ".Z" ".bz2" ".gz" ".xz" ".tgz")) - "*List of extensions tried by etags when jka-compr is used. + "List of extensions tried by etags when jka-compr is used. An empty string means search the non-compressed file. These extensions will be tried only if jka-compr was activated \(i.e. via customize of `auto-compression-mode' or by calling the function @@ -90,7 +90,7 @@ These extensions will be tried only if jka-compr was activated ;;;###autoload (defcustom tags-add-tables 'ask-user - "*Control whether to add a new tags table to the current list. + "Control whether to add a new tags table to the current list. t means do; nil means don't (always start a new list). Any other value means ask the user whether to add a new tags table to the current list (as opposed to starting a new list)." @@ -100,7 +100,7 @@ to the current list (as opposed to starting a new list)." (other :tag "Ask" ask-user))) (defcustom tags-revert-without-query nil - "*Non-nil means reread a TAGS table without querying, if it has changed." + "Non-nil means reread a TAGS table without querying, if it has changed." :group 'etags :type 'boolean) @@ -131,7 +131,7 @@ Each element is a list of strings which are file names.") ;;;###autoload (defcustom find-tag-hook nil - "*Hook to be run by \\[find-tag] after finding a tag. See `run-hooks'. + "Hook to be run by \\[find-tag] after finding a tag. See `run-hooks'. The value in the buffer in which \\[find-tag] is done is used, not the value in the buffer \\[find-tag] goes to." :group 'etags @@ -139,7 +139,7 @@ not the value in the buffer \\[find-tag] goes to." ;;;###autoload (defcustom find-tag-default-function nil - "*A function of no arguments used by \\[find-tag] to pick a default tag. + "A function of no arguments used by \\[find-tag] to pick a default tag. If nil, and the symbol that is the value of `major-mode' has a `find-tag-default-function' property (see `put'), that is used. Otherwise, `find-tag-default' is used." @@ -147,13 +147,13 @@ Otherwise, `find-tag-default' is used." :type '(choice (const nil) function)) (defcustom find-tag-marker-ring-length 16 - "*Length of marker rings `find-tag-marker-ring' and `tags-location-ring'." + "Length of marker rings `find-tag-marker-ring' and `tags-location-ring'." :group 'etags :type 'integer :version "20.3") (defcustom tags-tag-face 'default - "*Face for tags in the output of `tags-apropos'." + "Face for tags in the output of `tags-apropos'." :group 'etags :type 'face :version "21.1") @@ -1687,7 +1687,7 @@ Point should be just after a string that matches TAG." (re-search-backward re bol t))))) (defcustom tags-loop-revert-buffers nil - "*Non-nil means tags-scanning loops should offer to reread changed files. + "Non-nil means tags-scanning loops should offer to reread changed files. These loops normally read each file into Emacs, but when a file is already visited, they use the existing buffer. When this flag is non-nil, they offer to revert the existing buffer diff --git a/lisp/progmodes/executable.el b/lisp/progmodes/executable.el index c44f1d73501..e5142571972 100644 --- a/lisp/progmodes/executable.el +++ b/lisp/progmodes/executable.el @@ -57,7 +57,7 @@ ;; This used to default to `other', but that doesn't seem to have any ;; significance. fx 2000-02-11. (defcustom executable-insert t ; 'other - "*Non-nil means offer to add a magic number to a file. + "Non-nil means offer to add a magic number to a file. This takes effect when you switch to certain major modes, including Shell-script mode (`sh-mode'). When you type \\[executable-set-magic], it always offers to add or @@ -70,7 +70,7 @@ update the magic number." (defcustom executable-query 'function - "*If non-nil, ask user before changing an existing magic number. + "If non-nil, ask user before changing an existing magic number. When this is `function', only ask when called non-interactively." :type '(choice (const :tag "Don't Ask" nil) (const :tag "Ask when non-interactive" function) @@ -79,19 +79,19 @@ When this is `function', only ask when called non-interactively." (defcustom executable-magicless-file-regexp "/[Mm]akefile$\\|/\\.\\(z?profile\\|bash_profile\\|z?login\\|bash_login\\|z?logout\\|bash_logout\\|.+shrc\\|esrc\\|rcrc\\|[kz]shenv\\)$" - "*On files with this kind of name no magic is inserted or changed." + "On files with this kind of name no magic is inserted or changed." :type 'regexp :group 'executable) (defcustom executable-prefix "#! " - "*Interpreter magic number prefix inserted when there was no magic number." + "Interpreter magic number prefix inserted when there was no magic number." :type 'string :group 'executable) (defcustom executable-chmod 73 - "*After saving, if the file is not executable, set this mode. + "After saving, if the file is not executable, set this mode. This mode passed to `set-file-modes' is taken absolutely when negative, or relative to the files existing modes. Do nothing if this is nil. Typical values are 73 (+x) or -493 (rwxr-xr-x)." @@ -103,7 +103,7 @@ Typical values are 73 (+x) or -493 (rwxr-xr-x)." (defvar executable-command nil) (defcustom executable-self-display "tail" - "*Command you use with argument `+2' to make text files self-display. + "Command you use with argument `+2' to make text files self-display. Note that the like of `more' doesn't work too well under Emacs \\[shell]." :type 'string :group 'executable) @@ -111,7 +111,7 @@ Note that the like of `more' doesn't work too well under Emacs \\[shell]." (defvar executable-font-lock-keywords '(("\\`#!.*/\\([^ \t\n]+\\)" 1 font-lock-keyword-face t)) - "*Rules for highlighting executable scripts' magic number. + "Rules for highlighting executable scripts' magic number. This can be included in `font-lock-keywords' by modes that call `executable'.") diff --git a/lisp/progmodes/f90.el b/lisp/progmodes/f90.el index df6fdfd7cd9..1d2beedd191 100644 --- a/lisp/progmodes/f90.el +++ b/lisp/progmodes/f90.el @@ -651,7 +651,7 @@ logical\\|double[ \t]*precision\\|type[ \t]*(\\sw+)\\|none\\)[ \t]*" (defvar f90-font-lock-keywords f90-font-lock-keywords-2 - "*Default expressions to highlight in F90 mode. + "Default expressions to highlight in F90 mode. Can be overridden by the value of `font-lock-maximum-decoration'.") diff --git a/lisp/progmodes/glasses.el b/lisp/progmodes/glasses.el index b49739a94d5..7c131dd316c 100644 --- a/lisp/progmodes/glasses.el +++ b/lisp/progmodes/glasses.el @@ -78,7 +78,7 @@ string." (defcustom glasses-original-separator "_" - "*String to be displayed as `glasses-separator' in separator positions. + "String to be displayed as `glasses-separator' in separator positions. For instance, if you set it to \"_\" and set `glasses-separator' to \"-\", underscore separators are displayed as hyphens. If `glasses-original-separator' is an empty string, no such display change is diff --git a/lisp/progmodes/grep.el b/lisp/progmodes/grep.el index 54d678323f6..d41364547f2 100644 --- a/lisp/progmodes/grep.el +++ b/lisp/progmodes/grep.el @@ -61,7 +61,7 @@ SYMBOL should be one of `grep-command', `grep-template', ;;;###autoload (defcustom grep-window-height nil - "*Number of lines in a grep window. If nil, use `compilation-window-height'." + "Number of lines in a grep window. If nil, use `compilation-window-height'." :type '(choice (const :tag "Default" nil) integer) :version "22.1" @@ -104,7 +104,7 @@ To change the default value, use Customize or call the function :group 'grep) (defcustom grep-scroll-output nil - "*Non-nil to scroll the *grep* buffer window as output appears. + "Non-nil to scroll the *grep* buffer window as output appears. Setting it causes the grep commands to put point at the end of their output window so that the end of the output is always visible rather @@ -203,13 +203,13 @@ Customize or call the function `grep-apply-setting'." ("tex" . "*.tex") ("texi" . "*.texi") ("asm" . "*.[sS]")) - "*Alist of aliases for the FILES argument to `lgrep' and `rgrep'." + "Alist of aliases for the FILES argument to `lgrep' and `rgrep'." :type 'alist :group 'grep) (defcustom grep-find-ignored-directories vc-directory-exclusion-list - "*List of names of sub-directories which `rgrep' shall not recurse into. + "List of names of sub-directories which `rgrep' shall not recurse into. If an element is a cons cell, the car is called on the search directory to determine whether cdr should not be recursed into." :type '(choice (repeat :tag "Ignored directories" string) @@ -221,7 +221,7 @@ to determine whether cdr should not be recursed into." (unless (string-match-p "/\\'" s) (concat "*" s))) completion-ignored-extensions))) - "*List of file names which `rgrep' and `lgrep' shall exclude. + "List of file names which `rgrep' and `lgrep' shall exclude. If an element is a cons cell, the car is called on the search directory to determine whether cdr should not be excluded." :type '(choice (repeat :tag "Ignored file" string) @@ -229,7 +229,7 @@ to determine whether cdr should not be excluded." :group 'grep) (defcustom grep-error-screen-columns nil - "*If non-nil, column numbers in grep hits are screen columns. + "If non-nil, column numbers in grep hits are screen columns. See `compilation-error-screen-columns'" :type '(choice (const :tag "Default" nil) integer) diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index 121a023cd54..6b1f891b230 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -1046,7 +1046,7 @@ and source-file directory for your debugger." (defvar gud-dbx-history nil) (defcustom gud-dbx-directories nil - "*A list of directories that dbx should search for source code. + "A list of directories that dbx should search for source code. If nil, only source files in the program directory will be known to dbx. @@ -1358,7 +1358,7 @@ and source-file directory for your debugger." (defvar gud-xdb-history nil) (defcustom gud-xdb-directories nil - "*A list of directories that xdb should search for source code. + "A list of directories that xdb should search for source code. If nil, only source files in the program directory will be known to xdb. @@ -1811,7 +1811,7 @@ source file information.") ;; List of Java source file directories. (defvar gud-jdb-directories (list ".") - "*A list of directories that gud jdb should search for source code. + "A list of directories that gud jdb should search for source code. The file names should be absolute, or relative to the current directory. diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el index 26db60ddbc2..e2016e206a8 100644 --- a/lisp/progmodes/hideshow.el +++ b/lisp/progmodes/hideshow.el @@ -238,18 +238,18 @@ :group 'languages) (defcustom hs-hide-comments-when-hiding-all t - "*Hide the comments too when you do an `hs-hide-all'." + "Hide the comments too when you do an `hs-hide-all'." :type 'boolean :group 'hideshow) (defcustom hs-minor-mode-hook nil - "*Hook called when hideshow minor mode is activated or deactivated." + "Hook called when hideshow minor mode is activated or deactivated." :type 'hook :group 'hideshow :version "21.1") (defcustom hs-isearch-open 'code - "*What kind of hidden blocks to open when doing `isearch'. + "What kind of hidden blocks to open when doing `isearch'. One of the following symbols: code -- open only code blocks @@ -272,7 +272,7 @@ This has effect only if `search-invisible' is set to `open'." (bibtex-mode ("@\\S(*\\(\\s(\\)" 1)) (java-mode "{" "}" "/[*/]" nil nil) (js-mode "{" "}" "/[*/]" nil))) - "*Alist for initializing the hideshow variables for different modes. + "Alist for initializing the hideshow variables for different modes. Each element has the form (MODE START END COMMENT-START FORWARD-SEXP-FUNC ADJUST-BEG-FUNC). @@ -300,25 +300,25 @@ appropriate values. The regexps should not contain leading or trailing whitespace. Case does not matter.") (defvar hs-hide-all-non-comment-function nil - "*Function called if non-nil when doing `hs-hide-all' for non-comments.") + "Function called if non-nil when doing `hs-hide-all' for non-comments.") (defvar hs-allow-nesting nil - "*If non-nil, hiding remembers internal blocks. + "If non-nil, hiding remembers internal blocks. This means that when the outer block is shown again, any previously hidden internal blocks remain hidden.") (defvar hs-hide-hook nil - "*Hook called (with `run-hooks') at the end of commands to hide text. + "Hook called (with `run-hooks') at the end of commands to hide text. These commands include the toggling commands (when the result is to hide a block), `hs-hide-all', `hs-hide-block' and `hs-hide-level'.") (defvar hs-show-hook nil - "*Hook called (with `run-hooks') at the end of commands to show text. + "Hook called (with `run-hooks') at the end of commands to show text. These commands include the toggling commands (when the result is to show a block), `hs-show-all' and `hs-show-block'.") (defvar hs-set-up-overlay nil - "*Function called with one arg, OV, a newly initialized overlay. + "Function called with one arg, OV, a newly initialized overlay. Hideshow puts a unique overlay on each range of text to be hidden in the buffer. Here is a simple example of how to use this variable: diff --git a/lisp/progmodes/icon.el b/lisp/progmodes/icon.el index 35c29e10627..205b226160a 100644 --- a/lisp/progmodes/icon.el +++ b/lisp/progmodes/icon.el @@ -85,39 +85,39 @@ :group 'languages) (defcustom icon-indent-level 4 - "*Indentation of Icon statements with respect to containing block." + "Indentation of Icon statements with respect to containing block." :type 'integer :group 'icon) (defcustom icon-brace-imaginary-offset 0 - "*Imagined indentation of a Icon open brace that actually follows a statement." + "Imagined indentation of a Icon open brace that actually follows a statement." :type 'integer :group 'icon) (defcustom icon-brace-offset 0 - "*Extra indentation for braces, compared with other text in same context." + "Extra indentation for braces, compared with other text in same context." :type 'integer :group 'icon) (defcustom icon-continued-statement-offset 4 - "*Extra indent for Icon lines not starting new statements." + "Extra indent for Icon lines not starting new statements." :type 'integer :group 'icon) (defcustom icon-continued-brace-offset 0 - "*Extra indent for Icon substatements that start with open-braces. + "Extra indent for Icon substatements that start with open-braces. This is in addition to `icon-continued-statement-offset'." :type 'integer :group 'icon) (defcustom icon-auto-newline nil - "*Non-nil means automatically newline before and after braces Icon code. + "Non-nil means automatically newline before and after braces Icon code. This applies when braces are inserted." :type 'boolean :group 'icon) (defcustom icon-tab-always-indent t - "*Non-nil means TAB in Icon mode should always reindent the current line. + "Non-nil means TAB in Icon mode should always reindent the current line. It will then reindent, regardless of where in the line point is when the TAB command is used." :type 'boolean diff --git a/lisp/progmodes/idlw-help.el b/lisp/progmodes/idlw-help.el index f2f9fd30ed4..0cb8b7da4aa 100644 --- a/lisp/progmodes/idlw-help.el +++ b/lisp/progmodes/idlw-help.el @@ -115,7 +115,7 @@ must be explicitly set non-nil in order for the variable "Obsolete variable. See `idlwave-html-help-location'.") (defcustom idlwave-help-use-dedicated-frame t - "*Non-nil means, use a separate frame for Online Help if possible." + "Non-nil means, use a separate frame for Online Help if possible." :group 'idlwave-online-help :type 'boolean) @@ -164,12 +164,12 @@ probably a good idea to still call this function as a fallback." :type 'symbol) (defcustom idlwave-help-fontify-source-code nil - "*Non-nil means, fontify source code displayed as help like normal code." + "Non-nil means, fontify source code displayed as help like normal code." :group 'idlwave-online-help :type 'boolean) (defcustom idlwave-help-source-try-header t - "*Non-nil means, try to find help in routine header when displaying source. + "Non-nil means, try to find help in routine header when displaying source. Routines which are not documented in the system manual use their source as help text. When this variable is non-nil, we try to find a description of the help item in the first routine doclib header above the routine definition. @@ -180,14 +180,14 @@ definition is displayed instead." (defcustom idlwave-help-doclib-name "name" - "*A regexp for the heading word to search for in doclib headers + "A regexp for the heading word to search for in doclib headers which specifies the `name' section. Can be used for localization support." :group 'idlwave-online-help :type 'string) (defcustom idlwave-help-doclib-keyword "KEYWORD" - "*A regexp for the heading word to search for in doclib headers + "A regexp for the heading word to search for in doclib headers which specifies the `keywords' section. Can be used for localization support." :group 'idlwave-online-help diff --git a/lisp/progmodes/idlw-shell.el b/lisp/progmodes/idlw-shell.el index 55a085fbde0..d843de04913 100644 --- a/lisp/progmodes/idlw-shell.el +++ b/lisp/progmodes/idlw-shell.el @@ -106,7 +106,7 @@ :group 'idlwave) (defcustom idlwave-shell-prompt-pattern "^\r? ?IDL> " - "*Regexp to match IDL prompt at beginning of a line. + "Regexp to match IDL prompt at beginning of a line. For example, \"^\r?IDL> \" or \"^\r?WAVE> \". The \"^\r?\" is needed, to indicate the beginning of the line, with optional return character (which IDL seems to output randomly). @@ -118,7 +118,7 @@ This is a fine thing to set in your `.emacs' file." :type 'regexp) (defcustom idlwave-shell-process-name "idl" - "*Name to be associated with the IDL process. The buffer for the + "Name to be associated with the IDL process. The buffer for the process output is made by surrounding this name with `*'s." :group 'idlwave-shell-general-setup :type 'string) @@ -126,12 +126,12 @@ process output is made by surrounding this name with `*'s." ;; (defcustom idlwave-shell-automatic-start...) See idlwave.el (defcustom idlwave-shell-use-dedicated-window nil - "*Non-nil means, never replace the shell frame with another buffer." + "Non-nil means, never replace the shell frame with another buffer." :group 'idlwave-shell-general-setup :type 'boolean) (defcustom idlwave-shell-use-dedicated-frame nil - "*Non-nil means, IDLWAVE should use a special frame to display shell buffer." + "Non-nil means, IDLWAVE should use a special frame to display shell buffer." :group 'idlwave-shell-general-setup :type 'boolean) @@ -145,12 +145,12 @@ The default makes the frame splittable, so that completion works correctly." (cons symbol sexp))) (defcustom idlwave-shell-raise-frame t - "*Non-nil means, `idlwave-shell' raises the frame showing the shell window." + "Non-nil means, `idlwave-shell' raises the frame showing the shell window." :group 'idlwave-shell-general-setup :type 'boolean) (defcustom idlwave-shell-arrows-do-history t - "*Non-nil means UP and DOWN arrows move through command history. + "Non-nil means UP and DOWN arrows move through command history. This variable can have 3 values: nil Arrows just move the cursor t Arrows force the cursor back to the current command line and @@ -166,7 +166,7 @@ t Arrows force the cursor back to the current command line and ;; FIXME: add comint-input-ring-size? (defcustom idlwave-shell-use-toolbar t - "*Non-nil means, use the debugging toolbar in all IDL related buffers. + "Non-nil means, use the debugging toolbar in all IDL related buffers. Starting the shell will then add the toolbar to all idlwave-mode buffers. Exiting the shell will removed everywhere. Available on XEmacs and on Emacs 21.x or later. @@ -176,7 +176,7 @@ At any time you can toggle the display of the toolbar with :type 'boolean) (defcustom idlwave-shell-temp-pro-prefix "/tmp/idltemp" - "*The prefix for temporary IDL files used when compiling regions. + "The prefix for temporary IDL files used when compiling regions. It should be an absolute pathname. The full temporary file name is obtained by using `make-temp-file' so that the name will be unique among multiple Emacs processes." @@ -184,13 +184,13 @@ so that the name will be unique among multiple Emacs processes." :type 'string) (defvar idlwave-shell-fix-inserted-breaks nil - "*OBSOLETE VARIABLE, is no longer used. + "OBSOLETE VARIABLE, is no longer used. The documentation of this variable used to be: If non-nil then run `idlwave-shell-remove-breaks' to clean up IDL messages.") (defcustom idlwave-shell-prefix-key "\C-c\C-d" - "*The prefix key for the debugging map `idlwave-shell-mode-prefix-map'. + "The prefix key for the debugging map `idlwave-shell-mode-prefix-map'. This variable must already be set when idlwave-shell.el is loaded. Setting it in the mode-hook is too late." :group 'idlwave-shell-general-setup @@ -227,7 +227,7 @@ window, but is useful for stepping, etc." "Obsolete variable. See `idlwave-shell-debug-modifiers'.") (defcustom idlwave-shell-use-truename nil - "*Non-nil means, use `file-truename' when looking for buffers. + "Non-nil means, use `file-truename' when looking for buffers. If this variable is non-nil, Emacs will use the function `file-truename' to resolve symbolic links in the file paths printed by e.g., STOP commands. This means, unvisited files will be loaded under their truename. @@ -247,7 +247,7 @@ because these are used as separators by IDL." :type 'string) (defcustom idlwave-shell-mode-hook '() - "*Hook for customizing `idlwave-shell-mode'." + "Hook for customizing `idlwave-shell-mode'." :group 'idlwave-shell-general-setup :type 'hook) @@ -292,7 +292,7 @@ is non-nil." (defcustom idlwave-shell-show-commands '(run misc breakpoint) - "*A list of command types to show output from in the shell. + "A list of command types to show output from in the shell. Possibilities are 'run, 'debug, 'breakpoint, and 'misc. Unselected types are not displayed in the shell. The type 'everything causes all the copious shell traffic to be displayed." @@ -336,10 +336,10 @@ expression being examined." (string :tag "Command")))) (defvar idlwave-shell-print-expression-function nil - "*OBSOLETE VARIABLE, is no longer used.") + "OBSOLETE VARIABLE, is no longer used.") (defcustom idlwave-shell-separate-examine-output t - "*Non-nil means, put output of examine commands in their own buffer." + "Non-nil means, put output of examine commands in their own buffer." :group 'idlwave-shell-command-setup :type 'boolean) @@ -359,12 +359,12 @@ newly created." (cons variable sexp))) (defcustom idlwave-shell-query-for-class t - "*Non-nil means query the shell for object class on object completions." + "Non-nil means query the shell for object class on object completions." :group 'idlwave-shell-command-setup :type 'boolean) (defcustom idlwave-shell-use-input-mode-magic nil - "*Non-nil means, IDLWAVE should check for input mode spells in output. + "Non-nil means, IDLWAVE should check for input mode spells in output. The spells are strings printed by your IDL program and matched by the regular expressions in `idlwave-shell-input-mode-spells'. When these expressions match, IDLWAVE switches to character input mode and @@ -432,7 +432,7 @@ end" (regexp :tag "Line-mode regexp"))) (defcustom idlwave-shell-breakpoint-popup-menu t - "*If non-nil, provide a menu on mouse-3 on breakpoint lines, and + "If non-nil, provide a menu on mouse-3 on breakpoint lines, and popup help text on the line." :group 'idlwave-shell-command-setup :type 'boolean) @@ -449,7 +449,7 @@ popup help text on the line." :group 'idlwave) (defcustom idlwave-shell-mark-stop-line t - "*Non-nil means, mark the source code line where IDL is currently stopped. + "Non-nil means, mark the source code line where IDL is currently stopped. Value decides about the method which is used to mark the line. Valid values are: @@ -471,7 +471,7 @@ hides any code, so setting this to 'arrow on Emacs 21 sounds like a good idea." (const :tag "Face or arrow." t))) (defcustom idlwave-shell-overlay-arrow ">" - "*The overlay arrow to display at source lines where execution halts. + "The overlay arrow to display at source lines where execution halts. We use a single character by default, since the main block of IDL procedures often has no indentation. Where possible, IDLWAVE will use overlays to display the stop-lines. The arrow is only used on character-based terminals. @@ -480,14 +480,14 @@ See also `idlwave-shell-use-overlay-arrow'." :type 'string) (defcustom idlwave-shell-stop-line-face 'highlight - "*The face for `idlwave-shell-stop-line-overlay'. + "The face for `idlwave-shell-stop-line-overlay'. Allows you to choose the font, color and other properties for line where IDL is stopped. See also `idlwave-shell-mark-stop-line'." :group 'idlwave-shell-highlighting-and-faces :type 'symbol) (defcustom idlwave-shell-electric-stop-color "Violet" - "*The color for the default face or overlay arrow when stopped." + "The color for the default face or overlay arrow when stopped." :group 'idlwave-shell-highlighting-and-faces :type 'string) @@ -499,14 +499,14 @@ line where IDL is stopped. See also `idlwave-shell-mark-stop-line'." (condition-case nil (set-face-foreground 'idlwave-shell-electric-stop-line nil) (error nil))) - "*The face for `idlwave-shell-stop-line-overlay' when in electric debug mode. + "The face for `idlwave-shell-stop-line-overlay' when in electric debug mode. Allows you to choose the font, color and other properties for the line where IDL is stopped, when in Electric Debug Mode." :group 'idlwave-shell-highlighting-and-faces :type 'symbol) (defcustom idlwave-shell-mark-breakpoints t - "*Non-nil means, mark breakpoints in the source files. + "Non-nil means, mark breakpoints in the source files. Valid values are: nil Do not mark breakpoints. 'face Highlight line with `idlwave-shell-breakpoint-face'. @@ -524,7 +524,7 @@ t Glyph when possible, otherwise face (same effect as 'glyph)." "Obsolete variable. See `idlwave-shell-mark-breakpoints'.") (defcustom idlwave-shell-breakpoint-face 'idlwave-shell-bp - "*The face for breakpoint lines in the source code. + "The face for breakpoint lines in the source code. Allows you to choose the font, color and other properties for lines which have a breakpoint. See also `idlwave-shell-mark-breakpoints'." :group 'idlwave-shell-highlighting-and-faces @@ -542,7 +542,7 @@ lines which have a breakpoint. See also `idlwave-shell-mark-breakpoints'." (defcustom idlwave-shell-disabled-breakpoint-face 'idlwave-shell-disabled-bp - "*The face for disabled breakpoint lines in the source code. + "The face for disabled breakpoint lines in the source code. Allows you to choose the font, color and other properties for lines which have a breakpoint. See also `idlwave-shell-mark-breakpoints'." :group 'idlwave-shell-highlighting-and-faces @@ -560,14 +560,14 @@ lines which have a breakpoint. See also `idlwave-shell-mark-breakpoints'." (defcustom idlwave-shell-expression-face 'secondary-selection - "*The face for `idlwave-shell-expression-overlay'. + "The face for `idlwave-shell-expression-overlay'. Allows you to choose the font, color and other properties for the expression printed by IDL." :group 'idlwave-shell-highlighting-and-faces :type 'symbol) (defcustom idlwave-shell-output-face 'secondary-selection - "*The face for `idlwave-shell-output-overlay'. + "The face for `idlwave-shell-output-overlay'. Allows you to choose the font, color and other properties for the expression output by IDL." :group 'idlwave-shell-highlighting-and-faces @@ -784,7 +784,7 @@ with `*'s." "^% Skipped to:" "^% Stop encountered:" ) - "*A list of regular expressions matching IDL messages. + "A list of regular expressions matching IDL messages. These are the messages containing file and line information where IDL is currently stopped.") @@ -795,19 +795,19 @@ IDL is currently stopped.") (defconst idlwave-shell-trace-message-re "^% At " ;; First line of a trace message - "*A regular expression matching IDL trace messages. These are the + "A regular expression matching IDL trace messages. These are the messages containing file and line information of a current traceback.") (defconst idlwave-shell-step-messages '("^% Stepped to:" ) - "*A list of regular expressions matching stepped execution messages. + "A list of regular expressions matching stepped execution messages. These are IDL messages containing file and line information where IDL has currently stepped.") (defvar idlwave-shell-break-message "^% Breakpoint at:" - "*Regular expression matching an IDL breakpoint message line.") + "Regular expression matching an IDL breakpoint message line.") (defconst idlwave-shell-electric-debug-help " ==> IDLWAVE Electric Debug Mode Help <== @@ -1672,7 +1672,7 @@ number.") "\\([ \t]*\n[ \t]*[^ \t\n]+\\)*" ; continuation lines file name (6) "\\)" ; end line number group (5) ) - "*A regular expression to parse out the file name and line number. + "A regular expression to parse out the file name and line number. The 1st group should match the subroutine name. The 3rd group is the line number. The 5th group is the file name. diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index 31fe20698b9..74f37df9b2d 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -195,34 +195,34 @@ :group 'idlwave) (defcustom idlwave-main-block-indent 2 - "*Extra indentation for the main block of code. + "Extra indentation for the main block of code. That is the block between the FUNCTION/PRO statement and the END statement for that program unit." :group 'idlwave-code-formatting :type 'integer) (defcustom idlwave-block-indent 3 - "*Extra indentation applied to block lines. + "Extra indentation applied to block lines. If you change this, you probably also want to change `idlwave-end-offset'." :group 'idlwave-code-formatting :type 'integer) (defcustom idlwave-end-offset -3 - "*Extra indentation applied to block END lines. + "Extra indentation applied to block END lines. A value equal to negative `idlwave-block-indent' will make END lines line up with the block BEGIN lines." :group 'idlwave-code-formatting :type 'integer) (defcustom idlwave-continuation-indent 3 - "*Extra indentation applied to continuation lines. + "Extra indentation applied to continuation lines. This extra offset applies to the first of a set of continuation lines. The following lines receive the same indentation as the first." :group 'idlwave-code-formatting :type 'integer) (defcustom idlwave-max-extra-continuation-indent 40 - "*Maximum additional indentation for special continuation indent. + "Maximum additional indentation for special continuation indent. Several special indentations are tried to help line up continuation lines in routine calls or definitions, other statements with parentheses, or assignment statements. This variable specifies a @@ -236,7 +236,7 @@ this variable." :type 'integer) (defcustom idlwave-indent-to-open-paren t - "*Non-nil means, indent continuation lines to innermost open parenthesis. + "Non-nil means, indent continuation lines to innermost open parenthesis. This indentation occurs even if otherwise disallowed by `idlwave-max-extra-continuation-indent'. Matching parens and the interleaving args are lined up. Example: @@ -260,38 +260,38 @@ would yield: :type 'boolean) (defcustom idlwave-indent-parens-nested nil - "*Non-nil means, indent continuation lines with parens by nesting + "Non-nil means, indent continuation lines with parens by nesting lines at consecutively deeper levels." :group 'idlwave-code-formatting :type 'boolean) (defcustom idlwave-hanging-indent t - "*If set non-nil then comment paragraphs are indented under the + "If set non-nil then comment paragraphs are indented under the hanging indent given by `idlwave-hang-indent-regexp' match in the first line of the paragraph." :group 'idlwave-code-formatting :type 'boolean) (defcustom idlwave-hang-indent-regexp "- " - "*Regular expression matching the position of the hanging indent + "Regular expression matching the position of the hanging indent in the first line of a comment paragraph. The size of the indent extends to the end of the match for the regular expression." :group 'idlwave-code-formatting :type 'regexp) (defcustom idlwave-use-last-hang-indent nil - "*If non-nil then use last match on line for `idlwave-indent-regexp'." + "If non-nil then use last match on line for `idlwave-indent-regexp'." :group 'idlwave-code-formatting :type 'boolean) (defcustom idlwave-fill-comment-line-only t - "*If non-nil then auto fill will only operate on comment lines." + "If non-nil then auto fill will only operate on comment lines." :group 'idlwave-code-formatting :type 'boolean) (defcustom idlwave-auto-fill-split-string t - "*If non-nil then auto fill will split strings with the IDL `+' operator. + "If non-nil then auto fill will split strings with the IDL `+' operator. When the line end falls within a string, string concatenation with the '+' operator will be used to distribute a long string over lines. If nil and a string is split then a terminal beep and warning are issued. @@ -302,7 +302,7 @@ non-nil, since in this case code is not auto-filled." :type 'boolean) (defcustom idlwave-split-line-string t - "*If non-nil then `idlwave-split-line' will split strings with `+'. + "If non-nil then `idlwave-split-line' will split strings with `+'. When the splitting point of a line falls inside a string, split the string using the `+' string concatenation operator. If nil and a string is split then a terminal beep and warning are issued." @@ -310,14 +310,14 @@ split then a terminal beep and warning are issued." :type 'boolean) (defcustom idlwave-no-change-comment ";;;" - "*The indentation of a comment that starts with this regular + "The indentation of a comment that starts with this regular expression will not be changed. Note that the indentation of a comment at the beginning of a line is never changed." :group 'idlwave-code-formatting :type 'string) (defcustom idlwave-begin-line-comment nil - "*A comment anchored at the beginning of line. + "A comment anchored at the beginning of line. A comment matching this regular expression will not have its indentation changed. If nil the default is \"^;\", i.e., any line beginning with a \";\". Expressions for comments at the beginning of @@ -327,7 +327,7 @@ the line should begin with \"^\"." 'regexp)) (defcustom idlwave-code-comment ";;[^;]" - "*A comment that starts with this regular expression on a line by + "A comment that starts with this regular expression on a line by itself is indented as if it is a part of IDL code. As a result if the comment is not preceded by whitespace it is unchanged." :group 'idlwave-code-formatting @@ -343,7 +343,7 @@ the comment is not preceded by whitespace it is unchanged." :group 'idlwave) (defcustom idlwave-use-library-catalogs t - "*Non-nil means search the IDL path for library catalog files. + "Non-nil means search the IDL path for library catalog files. These files, named .idlwave_catalog, document routine information for individual directories and libraries of IDL .pro files. Many popular @@ -353,7 +353,7 @@ usually a good idea." :type 'boolean) (defcustom idlwave-init-rinfo-when-idle-after 10 - "*Seconds of idle time before routine info is automatically initialized. + "Seconds of idle time before routine info is automatically initialized. Initializing the routine info can take a long time, in particular if a large number of library catalogs are involved. When Emacs is idle for more than the number of seconds specified by this variable, it starts @@ -370,7 +370,7 @@ needed, and initialize then." :type 'number) (defcustom idlwave-scan-all-buffers-for-routine-info t - "*Non-nil means, scan buffers for IDL programs when updating info. + "Non-nil means, scan buffers for IDL programs when updating info. The scanning is done by the command `idlwave-update-routine-info'. The following values are allowed: @@ -384,7 +384,7 @@ current Scan only the current buffer, but no other buffers." (const :tag "Current buffer only" 'current))) (defcustom idlwave-query-shell-for-routine-info t - "*Non-nil means query the shell for info about compiled routines. + "Non-nil means query the shell for info about compiled routines. Querying the shell is useful to get information about compiled modules, and it is turned on by default. However, when you have a complete library scan, this is not necessary." @@ -393,7 +393,7 @@ scan, this is not necessary." (defcustom idlwave-auto-routine-info-updates '(find-file save-buffer kill-buffer compile-buffer) - "*Controls under what circumstances routine info is updated automatically. + "Controls under what circumstances routine info is updated automatically. Possible values: nil Never t All available @@ -413,7 +413,7 @@ t All available (const :tag "After a buffer was compiled successfully, update shell info" compile-buffer)))) (defcustom idlwave-rinfo-max-source-lines 5 - "*Maximum number of source files displayed in the Routine Info window. + "Maximum number of source files displayed in the Routine Info window. When an integer, it is the maximum number of source files displayed. A value of t means to show all source files." :group 'idlwave-routine-info @@ -448,7 +448,7 @@ value of `!DIR'. See also `idlwave-library-path'." ;; Configuration files (defcustom idlwave-config-directory (convert-standard-filename "~/.idlwave") - "*Directory for configuration files and user-library catalog." + "Directory for configuration files and user-library catalog." :group 'idlwave-routine-info :type 'file) @@ -457,7 +457,7 @@ value of `!DIR'. See also `idlwave-library-path'." (defvar idlwave-path-file "idlpath.el") (defvar idlwave-libinfo-file nil - "*Obsolete variable, no longer used.") + "Obsolete variable, no longer used.") (defcustom idlwave-special-lib-alist nil "Alist of regular expressions matching special library directories. @@ -538,7 +538,7 @@ After changing this variable, you need to either restart Emacs or press ,idlwave-tmp))) (defcustom idlwave-completion-force-default-case nil - "*Non-nil means, completion will always honor `idlwave-completion-case'. + "Non-nil means, completion will always honor `idlwave-completion-case'. When nil, only the completion of a mixed case or upper case string will honor the default settings in `idlwave-completion-case', while the completion of lower case strings will be completed entirely in @@ -547,7 +547,7 @@ lower case." :type 'boolean) (defcustom idlwave-complete-empty-string-as-lower-case nil - "*Non-nil means, the empty string is considered downcase for completion. + "Non-nil means, the empty string is considered downcase for completion. The case of what is already in the buffer determines the case of completions. When this variable is non-nil, the empty string is considered to be downcase. Completing on the empty string then offers downcase versions of the possible @@ -560,7 +560,7 @@ completions." `idlwave-completion-case'.") (defcustom idlwave-buffer-case-takes-precedence nil - "*Non-nil means, the case of tokens in buffers dominates over system stuff. + "Non-nil means, the case of tokens in buffers dominates over system stuff. To make this possible, we need to re-case everything each time we update the routine info from the buffers. This is slow. The default is to consider the case given in the system and library files @@ -569,7 +569,7 @@ first which makes updating much faster." :type 'boolean) (defcustom idlwave-highlight-help-links-in-completion t - "*Non-nil means, highlight completions for which system help is available. + "Non-nil means, highlight completions for which system help is available. Help can then be accessed with mouse-3. This option is only effective when the online help system is installed." :group 'idlwave-completion @@ -594,7 +594,7 @@ for which to assume this can be set here." (defcustom idlwave-completion-show-classes 1 - "*Number of classes to show when completing object methods and keywords. + "Number of classes to show when completing object methods and keywords. When completing methods or keywords for an object with unknown class, the *Completions* buffer will show the valid classes for each completion like this: @@ -613,7 +613,7 @@ negative integer, the `help-echo' property will be suppressed." (integer :tag "Number of classes shown" 1))) (defcustom idlwave-completion-fontify-classes t - "*Non-nil means, fontify the classes in completions buffer. + "Non-nil means, fontify the classes in completions buffer. This makes it easier to distinguish the completion items from the extra class info listed. See `idlwave-completion-show-classes'." :group 'idlwave-completion @@ -673,7 +673,7 @@ method, add an entry (\"INIT\" . t). The method name must be ALL-CAPS." (boolean :tag "Determine class for this method"))))) (defcustom idlwave-store-inquired-class t - "*Non-nil means, store class of a method call as text property on `->'. + "Non-nil means, store class of a method call as text property on `->'. IDLWAVE sometimes has to ask the user for the class associated with a particular object method call. This happens during the commands `idlwave-routine-info' and `idlwave-complete', depending upon the @@ -698,7 +698,7 @@ at point." :type 'boolean) (defcustom idlwave-class-arrow-face 'bold - "*Face to highlight object operator arrows `->' which carry a class property. + "Face to highlight object operator arrows `->' which carry a class property. When IDLWAVE stores a class name as text property on an object arrow \(see variable `idlwave-store-inquired-class', it highlights the arrow with this font in order to remind the user that this arrow is special." @@ -706,17 +706,17 @@ with this font in order to remind the user that this arrow is special." :type 'symbol) (defcustom idlwave-resize-routine-help-window t - "*Non-nil means, resize the Routine-info *Help* window to fit the content." + "Non-nil means, resize the Routine-info *Help* window to fit the content." :group 'idlwave-completion :type 'boolean) (defcustom idlwave-keyword-completion-adds-equal t - "*Non-nil means, completion automatically adds `=' after completed keywords." + "Non-nil means, completion automatically adds `=' after completed keywords." :group 'idlwave-completion :type 'boolean) (defcustom idlwave-function-completion-adds-paren t - "*Non-nil means, completion automatically adds `(' after completed function. + "Non-nil means, completion automatically adds `(' after completed function. nil means, don't add anything. A value of `2' means, also add the closing parenthesis and position cursor between the two." @@ -726,7 +726,7 @@ between the two." (const :tag "()" 2))) (defcustom idlwave-completion-restore-window-configuration t - "*Non-nil means, try to restore the window configuration after completion. + "Non-nil means, try to restore the window configuration after completion. When completion is not unique, Emacs displays a list of completions. This messes up your window configuration. With this variable set, IDLWAVE restores the old configuration after successful completion." @@ -741,13 +741,13 @@ The variables in this group govern this." :group 'idlwave) (defcustom idlwave-do-actions nil - "*Non-nil means performs actions when indenting. + "Non-nil means performs actions when indenting. The actions that can be performed are listed in `idlwave-indent-action-table'." :group 'idlwave-abbrev-and-indent-action :type 'boolean) (defcustom idlwave-abbrev-start-char "\\" - "*A single character string used to start abbreviations in abbrev mode. + "A single character string used to start abbreviations in abbrev mode. Possible characters to chose from: ~`\% or even '?'. '.' is not a good choice because it can make structure field names act like abbrevs in certain circumstances. @@ -759,7 +759,7 @@ is loaded." :type 'string) (defcustom idlwave-surround-by-blank nil - "*Non-nil means, enable `idlwave-surround'. + "Non-nil means, enable `idlwave-surround'. If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by `idlwave-surround'. See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'. @@ -774,7 +774,7 @@ Also see help for `idlwave-surround'." :type 'boolean) (defcustom idlwave-pad-keyword t - "*Non-nil means pad '=' in keywords (routine calls or defs) like assignment. + "Non-nil means pad '=' in keywords (routine calls or defs) like assignment. Whenever `idlwave-surround' is non-nil then this affects how '=' is padded for keywords and for variables. If t, pad the same as for assignments. If nil then spaces are removed. With any other value, @@ -786,22 +786,22 @@ spaces are left unchanged." (const :tag "Keep space near `='" 'keep))) (defcustom idlwave-show-block t - "*Non-nil means point blinks to block beginning for `idlwave-show-begin'." + "Non-nil means point blinks to block beginning for `idlwave-show-begin'." :group 'idlwave-abbrev-and-indent-action :type 'boolean) (defcustom idlwave-expand-generic-end nil - "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc." + "Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc." :group 'idlwave-abbrev-and-indent-action :type 'boolean) (defcustom idlwave-reindent-end t - "*Non-nil means re-indent line after END was typed." + "Non-nil means re-indent line after END was typed." :group 'idlwave-abbrev-and-indent-action :type 'boolean) (defcustom idlwave-abbrev-move t - "*Non-nil means the abbrev hook can move point. + "Non-nil means the abbrev hook can move point. Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev definitions, use the command `list-abbrevs', for abbrevs that move point. Moving point is useful, for example, to place point between @@ -812,7 +812,7 @@ See `idlwave-check-abbrev'." :type 'boolean) (defcustom idlwave-abbrev-change-case nil - "*Non-nil means all abbrevs will be forced to either upper or lower case. + "Non-nil means all abbrevs will be forced to either upper or lower case. If the value t, all expanded abbrevs will be upper case. If the value is 'down then abbrevs will be forced to lower case. If nil, the case will not change. @@ -822,7 +822,7 @@ upper case, regardless of this variable." :type 'boolean) (defcustom idlwave-reserved-word-upcase nil - "*Non-nil means, reserved words will be made upper case via abbrev expansion. + "Non-nil means, reserved words will be made upper case via abbrev expansion. If nil case of reserved words is controlled by `idlwave-abbrev-change-case'. Has effect only if in abbrev-mode." :group 'idlwave-abbrev-and-indent-action @@ -859,7 +859,7 @@ Has effect only if in abbrev-mode." ;; '(capitalize-word -1) t) (defvar idlwave-indent-action-table nil - "*Associated array containing action lists of search string (car), + "Associated array containing action lists of search string (car), and function as a cdr. This table is used by `idlwave-indent-line'. See documentation for `idlwave-do-action' for a complete description of the action lists. @@ -869,7 +869,7 @@ binding is not requested. See help on `idlwave-action-and-binding' for examples.") (defvar idlwave-indent-expand-table nil - "*Associated array containing action lists of search string (car), + "Associated array containing action lists of search string (car), and function as a cdr. The table is used by the `idlwave-indent-and-action' function. See documentation for `idlwave-do-action' for a complete description of the action lists. @@ -948,14 +948,14 @@ See help on `idlwave-action-and-binding' for examples.") ; ;- ") - "*A list (PATHNAME STRING) specifying the doc-header template to use for + "A list (PATHNAME STRING) specifying the doc-header template to use for summarizing a file. If PATHNAME is non-nil then this file will be included. Otherwise STRING is used. If nil, the file summary will be omitted. For example you might set PATHNAME to the path for the lib_template.pro file included in the IDL distribution.") (defcustom idlwave-header-to-beginning-of-file t - "*Non-nil means, the documentation header will always be at start of file. + "Non-nil means, the documentation header will always be at start of file. When nil, the header is positioned between the PRO/FUNCTION line of the current routine and the code, allowing several routine headers in a file." @@ -963,12 +963,12 @@ a file." :type 'boolean) (defcustom idlwave-timestamp-hook 'idlwave-default-insert-timestamp - "*The hook function used to update the timestamp of a function." + "The hook function used to update the timestamp of a function." :group 'idlwave-documentation :type 'function) (defcustom idlwave-doc-modifications-keyword "HISTORY" - "*The modifications keyword to use with the log documentation commands. + "The modifications keyword to use with the log documentation commands. A ':' is added to the keyword end. Inserted by doc-header and used to position logs by doc-modification. If nil it will not be inserted." @@ -976,12 +976,12 @@ If nil it will not be inserted." :type 'string) (defcustom idlwave-doclib-start "^;+\\+" - "*Regexp matching the start of a document library header." + "Regexp matching the start of a document library header." :group 'idlwave-documentation :type 'regexp) (defcustom idlwave-doclib-end "^;+-" - "*Regexp matching the end of a document library header." + "Regexp matching the end of a document library header." :group 'idlwave-documentation :type 'regexp) @@ -992,7 +992,7 @@ If nil it will not be inserted." :group 'idlwave) (defcustom idlwave-shell-explicit-file-name "idl" - "*If non-nil, this is the command to run IDL. + "If non-nil, this is the command to run IDL. Should be an absolute file path or path relative to the current environment execution search path. If you want to specify command line switches for the IDL program, use `idlwave-shell-command-line-options'. @@ -1003,7 +1003,7 @@ it without compromising backwards-compatibility." :type 'string) (defcustom idlwave-shell-command-line-options nil - "*A list of command line options for calling the IDL program. + "A list of command line options for calling the IDL program. Since IDL is executed directly without going through a shell like /bin/sh, this should be a list of strings like '(\"-rt=file\" \"-nw\") with a separate string for each argument. But you may also give a single string which @@ -1015,7 +1015,7 @@ split it for you." :group 'idlwave-external-programs) (defcustom idlwave-help-application "idlhelp" - "*The external application providing reference help for programming. + "The external application providing reference help for programming. Obsolete, if the IDL Assistant is being used for help." :group 'idlwave-external-programs :type 'string) @@ -1040,7 +1040,7 @@ are `control', `meta', `super', `hyper', `alt', and `shift'." (const shift))) (defcustom idlwave-shell-automatic-start nil - "*If non-nil attempt invoke `idlwave-shell' if not already running. + "If non-nil attempt invoke `idlwave-shell' if not already running. This is checked when an attempt to send a command to an IDL process is made." :group 'idlwave-shell-general-setup @@ -1054,7 +1054,7 @@ IDL process is made." :group 'idlwave) (defcustom idlwave-startup-message t - "*Non-nil displays a startup message when `idlwave-mode' is first called." + "Non-nil displays a startup message when `idlwave-mode' is first called." :group 'idlwave-misc :type 'boolean) diff --git a/lisp/progmodes/inf-lisp.el b/lisp/progmodes/inf-lisp.el index 73e167d1587..cd6c8869d9f 100644 --- a/lisp/progmodes/inf-lisp.el +++ b/lisp/progmodes/inf-lisp.el @@ -72,7 +72,7 @@ ;;;###autoload (defcustom inferior-lisp-filter-regexp (purecopy "\\`\\s *\\(:\\(\\w\\|\\s_\\)\\)?\\s *\\'") - "*What not to save on inferior Lisp's input history. + "What not to save on inferior Lisp's input history. Input matching this regexp is not saved on the input history in Inferior Lisp mode. Default is whitespace followed by 0 or 1 single-letter colon-keyword \(as in :a, :c, etc.)" @@ -139,13 +139,13 @@ mode. Default is whitespace followed by 0 or 1 single-letter colon-keyword ;;;###autoload (defcustom inferior-lisp-program (purecopy "lisp") - "*Program name for invoking an inferior Lisp in Inferior Lisp mode." + "Program name for invoking an inferior Lisp in Inferior Lisp mode." :type 'string :group 'inferior-lisp) ;;;###autoload (defcustom inferior-lisp-load-command (purecopy "(load \"%s\")\n") - "*Format-string for building a Lisp expression to load a file. + "Format-string for building a Lisp expression to load a file. This format string should use `%s' to substitute a file name and should result in a Lisp expression that will command the inferior Lisp to load that file. The default works acceptably on most Lisps. @@ -211,7 +211,7 @@ buffer with \\[set-variable].") ;;;###autoload (defvar inferior-lisp-mode-hook '() - "*Hook for customizing Inferior Lisp mode.") + "Hook for customizing Inferior Lisp mode.") (put 'inferior-lisp-mode 'mode-class 'special) @@ -453,7 +453,7 @@ This holds a cons cell of the form `(DIRECTORY . FILE)' describing the last `lisp-load-file' or `lisp-compile-file' command.") (defcustom lisp-source-modes '(lisp-mode) - "*Used to determine if a buffer contains Lisp source code. + "Used to determine if a buffer contains Lisp source code. If it's loaded into a buffer that is in one of these major modes, it's considered a Lisp source file by `lisp-load-file' and `lisp-compile-file'. Used by these commands to determine defaults." diff --git a/lisp/progmodes/m4-mode.el b/lisp/progmodes/m4-mode.el index b1884bd105b..20f91ce2d9e 100644 --- a/lisp/progmodes/m4-mode.el +++ b/lisp/progmodes/m4-mode.el @@ -80,7 +80,7 @@ "Default font-lock-keywords for `m4 mode'.") (defcustom m4-mode-hook nil - "*Hook called by `m4-mode'." + "Hook called by `m4-mode'." :type 'hook :group 'm4) diff --git a/lisp/progmodes/make-mode.el b/lisp/progmodes/make-mode.el index b4ca1ba665f..a173b11500e 100644 --- a/lisp/progmodes/make-mode.el +++ b/lisp/progmodes/make-mode.el @@ -129,18 +129,18 @@ :version "22.1") (defcustom makefile-browser-buffer-name "*Macros and Targets*" - "*Name of the macro- and target browser buffer." + "Name of the macro- and target browser buffer." :type 'string :group 'makefile) (defcustom makefile-target-colon ":" - "*String to append to all target names inserted by `makefile-insert-target'. + "String to append to all target names inserted by `makefile-insert-target'. \":\" or \"::\" are common values." :type 'string :group 'makefile) (defcustom makefile-macro-assign " = " - "*String to append to all macro names inserted by `makefile-insert-macro'. + "String to append to all macro names inserted by `makefile-insert-macro'. The normal value should be \" = \", since this is what standard make expects. However, newer makes such as dmake allow a larger variety of different macro assignments, so you @@ -149,69 +149,69 @@ might prefer to use \" += \" or \" := \" ." :group 'makefile) (defcustom makefile-electric-keys nil - "*If non-nil, Makefile mode should install electric keybindings. + "If non-nil, Makefile mode should install electric keybindings. Default is nil." :type 'boolean :group 'makefile) (defcustom makefile-use-curly-braces-for-macros-p nil - "*Controls the style of generated macro references. + "Controls the style of generated macro references. Non-nil means macro references should use curly braces, like `${this}'. nil means use parentheses, like `$(this)'." :type 'boolean :group 'makefile) (defcustom makefile-tab-after-target-colon t - "*If non-nil, insert a TAB after a target colon. + "If non-nil, insert a TAB after a target colon. Otherwise, a space is inserted. The default is t." :type 'boolean :group 'makefile) (defcustom makefile-browser-leftmost-column 10 - "*Number of blanks to the left of the browser selection mark." + "Number of blanks to the left of the browser selection mark." :type 'integer :group 'makefile) (defcustom makefile-browser-cursor-column 10 - "*Column the cursor goes to when it moves up or down in the Makefile browser." + "Column the cursor goes to when it moves up or down in the Makefile browser." :type 'integer :group 'makefile) (defcustom makefile-backslash-column 48 - "*Column in which `makefile-backslash-region' inserts backslashes." + "Column in which `makefile-backslash-region' inserts backslashes." :type 'integer :group 'makefile) (defcustom makefile-backslash-align t - "*If non-nil, `makefile-backslash-region' will align backslashes." + "If non-nil, `makefile-backslash-region' will align backslashes." :type 'boolean :group 'makefile) (defcustom makefile-browser-selected-mark "+ " - "*String used to mark selected entries in the Makefile browser." + "String used to mark selected entries in the Makefile browser." :type 'string :group 'makefile) (defcustom makefile-browser-unselected-mark " " - "*String used to mark unselected entries in the Makefile browser." + "String used to mark unselected entries in the Makefile browser." :type 'string :group 'makefile) (defcustom makefile-browser-auto-advance-after-selection-p t - "*If non-nil, cursor will move after item is selected in Makefile browser." + "If non-nil, cursor will move after item is selected in Makefile browser." :type 'boolean :group 'makefile) (defcustom makefile-pickup-everything-picks-up-filenames-p nil - "*If non-nil, `makefile-pickup-everything' picks up filenames as targets. + "If non-nil, `makefile-pickup-everything' picks up filenames as targets. This means it calls `makefile-pickup-filenames-as-targets'. Otherwise filenames are omitted." :type 'boolean :group 'makefile) (defcustom makefile-cleanup-continuations nil - "*If non-nil, automatically clean up continuation lines when saving. + "If non-nil, automatically clean up continuation lines when saving. A line is cleaned up by removing all whitespace following a trailing backslash. This is done silently. IMPORTANT: Please note that enabling this option causes Makefile mode @@ -220,7 +220,7 @@ to MODIFY A FILE WITHOUT YOUR CONFIRMATION when \"it seems necessary\"." :group 'makefile) (defcustom makefile-mode-hook nil - "*Normal hook run by `makefile-mode'." + "Normal hook run by `makefile-mode'." :type 'hook :group 'makefile) @@ -247,7 +247,7 @@ you enter a \".\" at the beginning of a line in `makefile-mode'." (defcustom makefile-runtime-macros-list '(("@") ("&") (">") ("<") ("*") ("^") ("+") ("?") ("%") ("$")) - "*List of macros that are resolved by make at runtime. + "List of macros that are resolved by make at runtime. If you insert a macro reference using `makefile-insert-macro-ref', the name of the macro is checked against this list. If it can be found its name will not be enclosed in { } or ( )." @@ -553,14 +553,14 @@ not be enclosed in { } or ( )." ;; ------------------------------------------------------------ (defcustom makefile-brave-make "make" - "*How to invoke make, for `makefile-query-targets'. + "How to invoke make, for `makefile-query-targets'. This should identify a `make' command that can handle the `-q' option." :type 'string :group 'makefile) (defcustom makefile-query-one-target-method-function 'makefile-query-by-make-minus-q - "*Function to call to determine whether a make target is up to date. + "Function to call to determine whether a make target is up to date. The function must satisfy this calling convention: * As its first argument, it must accept the name of the target to @@ -579,7 +579,7 @@ The function must satisfy this calling convention: 'makefile-query-one-target-method-function) (defcustom makefile-up-to-date-buffer-name "*Makefile Up-to-date overview*" - "*Name of the Up-to-date overview buffer." + "Name of the Up-to-date overview buffer." :type 'string :group 'makefile) diff --git a/lisp/progmodes/modula2.el b/lisp/progmodes/modula2.el index 0c43a3ed354..d634efebe5b 100644 --- a/lisp/progmodes/modula2.el +++ b/lisp/progmodes/modula2.el @@ -65,7 +65,7 @@ :group 'modula2) (defcustom m2-end-comment-column 75 - "*Column for aligning the end of a comment, in Modula-2." + "Column for aligning the end of a comment, in Modula-2." :type 'integer :group 'modula2) @@ -104,7 +104,7 @@ "Keymap used in Modula-2 mode.") (defcustom m2-indent 5 - "*This variable gives the indentation in Modula-2-Mode." + "This variable gives the indentation in Modula-2-Mode." :type 'integer :group 'modula2) (put 'm2-indent 'safe-local-variable diff --git a/lisp/progmodes/octave-inf.el b/lisp/progmodes/octave-inf.el index 2cae41889bd..f77e24e665a 100644 --- a/lisp/progmodes/octave-inf.el +++ b/lisp/progmodes/octave-inf.el @@ -79,7 +79,7 @@ mode, set this to (\"-q\" \"--traditional\")." "Syntax table in use in inferior-octave-mode buffers.") (defcustom inferior-octave-mode-hook nil - "*Hook to be run when Inferior Octave mode is started." + "Hook to be run when Inferior Octave mode is started." :type 'hook :group 'octave-inferior) diff --git a/lisp/progmodes/pascal.el b/lisp/progmodes/pascal.el index 95f1adec40e..8f7f313753c 100644 --- a/lisp/progmodes/pascal.el +++ b/lisp/progmodes/pascal.el @@ -183,42 +183,42 @@ (put 'pascal-mode 'font-lock-defaults '(pascal-font-lock-keywords nil t)) (defcustom pascal-indent-level 3 - "*Indentation of Pascal statements with respect to containing block." + "Indentation of Pascal statements with respect to containing block." :type 'integer :group 'pascal) (defcustom pascal-case-indent 2 - "*Indentation for case statements." + "Indentation for case statements." :type 'integer :group 'pascal) (defcustom pascal-auto-newline nil - "*Non-nil means automatically insert newlines in certain cases. + "Non-nil means automatically insert newlines in certain cases. These include after semicolons and after the punctuation mark after an `end'." :type 'boolean :group 'pascal) (defcustom pascal-indent-nested-functions t - "*Non-nil means nested functions are indented." + "Non-nil means nested functions are indented." :type 'boolean :group 'pascal) (defcustom pascal-tab-always-indent t - "*Non-nil means TAB in Pascal mode should always reindent the current line. + "Non-nil means TAB in Pascal mode should always reindent the current line. If this is nil, TAB inserts a tab if it is at the end of the line and follows non-whitespace text." :type 'boolean :group 'pascal) (defcustom pascal-auto-endcomments t - "*Non-nil means automatically insert comments after certain `end's. + "Non-nil means automatically insert comments after certain `end's. Specifically, this is done after the ends of cases statements and functions. The name of the function or case is included between the braces." :type 'boolean :group 'pascal) (defcustom pascal-auto-lineup '(all) - "*List of contexts where auto lineup of :'s or ='s should be done. + "List of contexts where auto lineup of :'s or ='s should be done. Elements can be of type: 'paramlist', 'declaration' or 'case', which will do auto lineup in parameterlist, declarations or case-statements respectively. The word 'all' will do all lineups. '(case paramlist) for @@ -232,7 +232,7 @@ will do all lineups." :group 'pascal) (defvar pascal-toggle-completions nil - "*Non-nil meant \\<pascal-mode-map>\\[pascal-complete-word] would try all possible completions one by one. + "Non-nil meant \\<pascal-mode-map>\\[pascal-complete-word] would try all possible completions one by one. Repeated use of \\[pascal-complete-word] would show you all of them. Normally, when there is more than one possible completion, it displays a list of all possible completions.") @@ -241,7 +241,7 @@ it displays a list of all possible completions.") (defcustom pascal-type-keywords '("array" "file" "packed" "char" "integer" "real" "string" "record") - "*Keywords for types used when completing a word in a declaration or parmlist. + "Keywords for types used when completing a word in a declaration or parmlist. These include integer, real, char, etc. The types defined within the Pascal program are handled in another way, and should not be added to this list." @@ -251,7 +251,7 @@ are handled in another way, and should not be added to this list." (defcustom pascal-start-keywords '("begin" "end" "function" "procedure" "repeat" "until" "while" "read" "readln" "reset" "rewrite" "write" "writeln") - "*Keywords to complete when standing at the first word of a statement. + "Keywords to complete when standing at the first word of a statement. These are keywords such as begin, repeat, until, readln. The procedures and variables defined within the Pascal program are handled in another way, and should not be added to this list." @@ -260,7 +260,7 @@ are handled in another way, and should not be added to this list." (defcustom pascal-separator-keywords '("downto" "else" "mod" "div" "then") - "*Keywords to complete when NOT standing at the first word of a statement. + "Keywords to complete when NOT standing at the first word of a statement. These are keywords such as downto, else, mod, then. Variables and function names defined within the Pascal program are handled in another way, and should not be added to this list." diff --git a/lisp/progmodes/perl-mode.el b/lisp/progmodes/perl-mode.el index 26c6e5a9f03..aab5f8f65a4 100644 --- a/lisp/progmodes/perl-mode.el +++ b/lisp/progmodes/perl-mode.el @@ -468,7 +468,7 @@ The expansion is entirely correct because it uses the C preprocessor." (t (funcall (default-value 'font-lock-syntactic-face-function) state)))) (defcustom perl-indent-level 4 - "*Indentation of Perl statements with respect to containing block." + "Indentation of Perl statements with respect to containing block." :type 'integer :group 'perl) @@ -485,28 +485,28 @@ The expansion is entirely correct because it uses the C preprocessor." ;;;###autoload(put 'perl-label-offset 'safe-local-variable 'integerp) (defcustom perl-continued-statement-offset 4 - "*Extra indent for lines not starting new statements." + "Extra indent for lines not starting new statements." :type 'integer :group 'perl) (defcustom perl-continued-brace-offset -4 - "*Extra indent for substatements that start with open-braces. + "Extra indent for substatements that start with open-braces. This is in addition to `perl-continued-statement-offset'." :type 'integer :group 'perl) (defcustom perl-brace-offset 0 - "*Extra indentation for braces, compared with other text in same context." + "Extra indentation for braces, compared with other text in same context." :type 'integer :group 'perl) (defcustom perl-brace-imaginary-offset 0 - "*Imagined indentation of an open brace that actually follows a statement." + "Imagined indentation of an open brace that actually follows a statement." :type 'integer :group 'perl) (defcustom perl-label-offset -2 - "*Offset of Perl label lines relative to usual indentation." + "Offset of Perl label lines relative to usual indentation." :type 'integer :group 'perl) (defcustom perl-indent-continued-arguments nil - "*If non-nil offset of argument lines relative to usual indentation. + "If non-nil offset of argument lines relative to usual indentation. If nil, continued arguments are aligned with the first argument." :type '(choice integer (const nil)) :group 'perl) @@ -521,7 +521,7 @@ nonwhite character on the line." ;; I changed the default to nil for consistency with general Emacs ;; conventions -- rms. (defcustom perl-tab-to-comment nil - "*Non-nil means TAB moves to eol or makes a comment in some cases. + "Non-nil means TAB moves to eol or makes a comment in some cases. For lines which don't need indenting, TAB either indents an existing comment, moves to end-of-line, or if at end-of-line already, create a new comment." @@ -529,7 +529,7 @@ create a new comment." :group 'perl) (defcustom perl-nochange ";?#\\|\f\\|\\s(\\|\\(\\w\\|\\s_\\)+:[^:]" - "*Lines starting with this regular expression are not auto-indented." + "Lines starting with this regular expression are not auto-indented." :type 'regexp :group 'perl) diff --git a/lisp/progmodes/prolog.el b/lisp/progmodes/prolog.el index a8ee6f4bff4..74c8c31b425 100644 --- a/lisp/progmodes/prolog.el +++ b/lisp/progmodes/prolog.el @@ -3621,12 +3621,12 @@ a new comment is created." (indent-for-comment))) (defun prolog-indent-predicate () - "*Indent the current predicate." + "Indent the current predicate." (interactive) (indent-region (prolog-pred-start) (prolog-pred-end) nil)) (defun prolog-indent-buffer () - "*Indent the entire buffer." + "Indent the entire buffer." (interactive) (indent-region (point-min) (point-max) nil)) diff --git a/lisp/progmodes/ps-mode.el b/lisp/progmodes/ps-mode.el index e85fa0476b0..bf52eff8f9a 100644 --- a/lisp/progmodes/ps-mode.el +++ b/lisp/progmodes/ps-mode.el @@ -60,17 +60,17 @@ ;; User variables. (defcustom ps-mode-auto-indent t - "*Should we use autoindent?" + "Should we use autoindent?" :group 'PostScript-edit :type 'boolean) (defcustom ps-mode-tab 4 - "*Number of spaces to use when indenting." + "Number of spaces to use when indenting." :group 'PostScript-edit :type 'integer) (defcustom ps-mode-paper-size '(595 842) - "*Default paper size. + "Default paper size. When inserting an EPSF template these values are used to set the boundingbox to include the whole page. @@ -117,12 +117,12 @@ When the figure is finished these values should be replaced." (lpr-command (if (memq system-type '(usg-unix-v hpux irix)) "lp" "lpr"))) (lpr-buffer))) - "*Lisp function to print current buffer as PostScript." + "Lisp function to print current buffer as PostScript." :group 'PostScript-edit :type 'function) (defcustom ps-run-prompt "\\(GS\\(<[0-9]+\\)?>\\)+" - "*Regexp to match prompt in interactive PostScript." + "Regexp to match prompt in interactive PostScript." :group 'PostScript-interaction :type 'regexp) @@ -139,7 +139,7 @@ When the figure is finished these values should be replaced." ("^\\(Current file position is\\) \\([0-9]+\\)" (1 font-lock-comment-face nil nil) (2 font-lock-warning-face nil nil)))) - "*Medium level highlighting of messages from the PostScript interpreter. + "Medium level highlighting of messages from the PostScript interpreter. See documentation on font-lock for details." :group 'PostScript-interaction @@ -155,17 +155,17 @@ See documentation on font-lock for details." (boolean :tag "Laxmatch" :value t)))))) (defcustom ps-run-x '("gs" "-r72" "-sPAPERSIZE=a4") - "*Command as list to run PostScript with graphic display." + "Command as list to run PostScript with graphic display." :group 'PostScript-interaction :type '(repeat string)) (defcustom ps-run-dumb '("gs" "-dNODISPLAY") - "*Command as list to run PostScript without graphic display." + "Command as list to run PostScript without graphic display." :group 'PostScript-interaction :type '(repeat string)) (defcustom ps-run-init nil - "*String of commands to send to PostScript to start interactive. + "String of commands to send to PostScript to start interactive. Example: \"executive\" @@ -174,13 +174,13 @@ You won't need to set this option for Ghostscript." :type '(choice (const nil) string)) (defcustom ps-run-error-line-numbers nil - "*What values are used by the PostScript interpreter in error messages?" + "What values are used by the PostScript interpreter in error messages?" :group 'PostScript-interaction :type '(choice (const :tag "line numbers" t) (const :tag "byte counts" nil))) (defcustom ps-run-tmp-dir nil - "*Name of directory to place temporary file. + "Name of directory to place temporary file. If nil, use `temporary-file-directory'." :group 'PostScript-interaction :type '(choice (const nil) directory)) diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el index 3ef872d26eb..f7566c31b41 100644 --- a/lisp/progmodes/python.el +++ b/lisp/progmodes/python.el @@ -494,7 +494,7 @@ statement." (defcustom python-pdbtrack-do-tracking-p t - "*Controls whether the pdbtrack feature is enabled or not. + "Controls whether the pdbtrack feature is enabled or not. When non-nil, pdbtrack is enabled in all comint-based buffers, e.g. shell interaction buffers and the *Python* buffer. @@ -509,7 +509,7 @@ having to restart the program." (make-variable-buffer-local 'python-pdbtrack-do-tracking-p) (defcustom python-pdbtrack-minor-mode-string " PDB" - "*Minor-mode sign to be displayed when pdbtrack is active." + "Minor-mode sign to be displayed when pdbtrack is active." :type 'string :group 'python) @@ -1288,7 +1288,7 @@ modified by the user. Additional arguments are added when the command is used by `run-python' et al.") (defvar python-buffer nil - "*The current Python process buffer. + "The current Python process buffer. Commands that send text from source buffers to Python processes have to choose a process to send to. This is determined by buffer-local diff --git a/lisp/progmodes/scheme.el b/lisp/progmodes/scheme.el index 82a4985015f..1fa75f239eb 100644 --- a/lisp/progmodes/scheme.el +++ b/lisp/progmodes/scheme.el @@ -229,7 +229,7 @@ Set this to nil if you normally use another dialect." (defcustom dsssl-sgml-declaration "<!DOCTYPE style-sheet PUBLIC \"-//James Clark//DTD DSSSL Style Sheet//EN\"> " - "*An SGML declaration for the DSSSL file. + "An SGML declaration for the DSSSL file. If it is defined as a string this will be inserted into an empty buffer which is in `dsssl-mode'. It is typically James Clark's style-sheet doctype, as required for Jade." @@ -251,7 +251,7 @@ See `run-hooks'." ;; This is shared by cmuscheme and xscheme. (defcustom scheme-program-name "scheme" - "*Program invoked by the `run-scheme' command." + "Program invoked by the `run-scheme' command." :type 'string :group 'scheme) diff --git a/lisp/progmodes/sh-script.el b/lisp/progmodes/sh-script.el index 48b19524b8c..f60ce185bc7 100644 --- a/lisp/progmodes/sh-script.el +++ b/lisp/progmodes/sh-script.el @@ -1410,7 +1410,7 @@ This list is used when switching between buffer-local and global values of variables, and for the commands using indentation styles.") (defvar sh-make-vars-local t - "*Controls whether indentation variables are local to the buffer. + "Controls whether indentation variables are local to the buffer. If non-nil, indentation variables are made local initially. If nil, you can later make the variables local by invoking command `sh-make-vars-local'. @@ -1876,7 +1876,7 @@ region, clear header." ;; Indentation stuff. (defun sh-must-support-indent () - "*Signal an error if the shell type for this buffer is not supported. + "Signal an error if the shell type for this buffer is not supported. Also, the buffer must be in Shell-script mode." (unless sh-indent-supported-here (error "This buffer's shell does not support indentation through Emacs"))) @@ -2885,7 +2885,7 @@ so that `occur-next' and `occur-prev' will work." ;; Is this really worth having? (defvar sh-learned-buffer-hook nil - "*An abnormal hook, called with an alist of learned variables.") + "An abnormal hook, called with an alist of learned variables.") ;; Example of how to use sh-learned-buffer-hook ;; ;; (defun what-i-learned (list) diff --git a/lisp/progmodes/simula.el b/lisp/progmodes/simula.el index 7536126e8f1..2adb34c7824 100644 --- a/lisp/progmodes/simula.el +++ b/lisp/progmodes/simula.el @@ -48,7 +48,7 @@ Otherwise TAB indents only when point is within the run of whitespace at the beginning of the line.") (defcustom simula-tab-always-indent simula-tab-always-indent-default - "*Non-nil means TAB in SIMULA mode should always reindent the current line. + "Non-nil means TAB in SIMULA mode should always reindent the current line. Otherwise TAB indents only when point is within the run of whitespace at the beginning of the line." :type 'boolean @@ -58,7 +58,7 @@ the run of whitespace at the beginning of the line." "Indentation of SIMULA statements with respect to containing block.") (defcustom simula-indent-level simula-indent-level-default - "*Indentation of SIMULA statements with respect to containing block." + "Indentation of SIMULA statements with respect to containing block." :type 'integer :group 'simula) @@ -67,7 +67,7 @@ the run of whitespace at the beginning of the line." "Extra indentation after DO, THEN, ELSE, WHEN and OTHERWISE.") (defcustom simula-substatement-offset simula-substatement-offset-default - "*Extra indentation after DO, THEN, ELSE, WHEN and OTHERWISE." + "Extra indentation after DO, THEN, ELSE, WHEN and OTHERWISE." :type 'integer :group 'simula) @@ -79,7 +79,7 @@ the previous line of the statement.") (defcustom simula-continued-statement-offset simula-continued-statement-offset-default - "*Extra indentation for lines not starting a statement or substatement. + "Extra indentation for lines not starting a statement or substatement. If value is a list, each line in a multipleline continued statement will have the car of the list extra indentation with respect to the previous line of the statement." @@ -90,7 +90,7 @@ the previous line of the statement." "Offset of SIMULA label lines relative to usual indentation.") (defcustom simula-label-offset simula-label-offset-default - "*Offset of SIMULA label lines relative to usual indentation." + "Offset of SIMULA label lines relative to usual indentation." :type 'integer :group 'simula) @@ -100,7 +100,7 @@ Value is a cons cell, the car is extra THEN indentation and the cdr extra ELSE indentation. IF after ELSE is indented as the starting IF.") (defcustom simula-if-indent simula-if-indent-default - "*Extra indentation of THEN and ELSE with respect to the starting IF. + "Extra indentation of THEN and ELSE with respect to the starting IF. Value is a cons cell, the car is extra THEN indentation and the cdr extra ELSE indentation. IF after ELSE is indented as the starting IF." :type '(cons integer integer) @@ -112,7 +112,7 @@ Value is a cons cell, the car is extra WHEN indentation and the cdr extra OTHERWISE indentation.") (defcustom simula-inspect-indent simula-inspect-indent-default - "*Extra indentation of WHEN and OTHERWISE with respect to the INSPECT. + "Extra indentation of WHEN and OTHERWISE with respect to the INSPECT. Value is a cons cell, the car is extra WHEN indentation and the cdr extra OTHERWISE indentation." :type '(cons integer integer) @@ -122,7 +122,7 @@ and the cdr extra OTHERWISE indentation." "Non-nil means `simula-indent-line' function may reindent previous line.") (defcustom simula-electric-indent simula-electric-indent-default - "*Non-nil means `simula-indent-line' function may reindent previous line." + "Non-nil means `simula-indent-line' function may reindent previous line." :type 'boolean :group 'simula) @@ -132,7 +132,7 @@ Value is one of the symbols `upcase', `downcase', `capitalize', \(as in) `abbrev-table' or nil if they should not be changed.") (defcustom simula-abbrev-keyword simula-abbrev-keyword-default - "*Specify how to convert case for SIMULA keywords. + "Specify how to convert case for SIMULA keywords. Value is one of the symbols `upcase', `downcase', `capitalize', \(as in) `abbrev-table' or nil if they should not be changed." :type '(choice (const upcase) (const downcase) (const capitalize)(const nil)) @@ -144,7 +144,7 @@ Value is one of the symbols `upcase', `downcase', `capitalize', \(as in) `abbrev-table', or nil if they should not be changed.") (defcustom simula-abbrev-stdproc simula-abbrev-stdproc-default - "*Specify how to convert case for standard SIMULA procedure and class names. + "Specify how to convert case for standard SIMULA procedure and class names. Value is one of the symbols `upcase', `downcase', `capitalize', \(as in) `abbrev-table', or nil if they should not be changed." :type '(choice (const upcase) (const downcase) (const capitalize) @@ -152,7 +152,7 @@ Value is one of the symbols `upcase', `downcase', `capitalize', :group 'simula) (defcustom simula-abbrev-file nil - "*File with extra abbrev definitions for use in SIMULA mode. + "File with extra abbrev definitions for use in SIMULA mode. These are used together with the standard abbrev definitions for SIMULA. Please note that the standard definitions are required for SIMULA mode to function correctly." diff --git a/lisp/progmodes/tcl.el b/lisp/progmodes/tcl.el index 0198b32ec9f..f1ab01fd07f 100644 --- a/lisp/progmodes/tcl.el +++ b/lisp/progmodes/tcl.el @@ -120,24 +120,24 @@ :group 'languages) (defcustom tcl-indent-level 4 - "*Indentation of Tcl statements with respect to containing block." + "Indentation of Tcl statements with respect to containing block." :type 'integer :group 'tcl) (put 'tcl-indent-level 'safe-local-variable 'integerp) (defcustom tcl-continued-indent-level 4 - "*Indentation of continuation line relative to first line of command." + "Indentation of continuation line relative to first line of command." :type 'integer :group 'tcl) (put 'tcl-continued-indent-level 'safe-local-variable 'integerp) (defcustom tcl-auto-newline nil - "*Non-nil means automatically newline before and after braces you insert." + "Non-nil means automatically newline before and after braces you insert." :type 'boolean :group 'tcl) (defcustom tcl-tab-always-indent tab-always-indent - "*Control effect of TAB key. + "Control effect of TAB key. If t (the default), always indent current line. If nil and point is not in the indentation area at the beginning of the line, a TAB is inserted. @@ -157,7 +157,7 @@ to take place: (defcustom tcl-electric-hash-style nil ;; 'smart - "*Style of electric hash insertion to use. + "Style of electric hash insertion to use. Possible values are `backslash', meaning that `\\' quoting should be done; `quote', meaning that `\"' quoting should be done; `smart', meaning that the choice between `backslash' and `quote' should be @@ -168,27 +168,27 @@ taken to mean `smart'. The default is nil." :group 'tcl) (defcustom tcl-help-directory-list nil - "*List of topmost directories containing TclX help files." + "List of topmost directories containing TclX help files." :type '(repeat directory) :group 'tcl) (defcustom tcl-use-smart-word-finder t - "*If not nil, use smart way to find current word, for Tcl help feature." + "If not nil, use smart way to find current word, for Tcl help feature." :type 'boolean :group 'tcl) (defcustom tcl-application "wish" - "*Name of Tcl program to run in inferior Tcl mode." + "Name of Tcl program to run in inferior Tcl mode." :type 'string :group 'tcl) (defcustom tcl-command-switches nil - "*List of switches to supply to the `tcl-application' program." + "List of switches to supply to the `tcl-application' program." :type '(repeat string) :group 'tcl) (defcustom tcl-prompt-regexp "^\\(% \\|\\)" - "*If not nil, a regexp that will match the prompt in the inferior process. + "If not nil, a regexp that will match the prompt in the inferior process. If nil, the prompt is the name of the application with \">\" appended. The default is \"^\\(% \\|\\)\", which will match the default primary @@ -197,7 +197,7 @@ and secondary prompts for tclsh and wish." :group 'tcl) (defcustom inferior-tcl-source-command "source %s\n" - "*Format-string for building a Tcl command to load a file. + "Format-string for building a Tcl command to load a file. This format string should use `%s' to substitute a file name and should result in a Tcl expression that will command the inferior Tcl to load that file. The filename will be appropriately @@ -301,7 +301,7 @@ quoted for Tcl." ["Tcl help" tcl-help-on-word tcl-help-directory-list])) (defvar inferior-tcl-buffer nil - "*The current inferior-tcl process buffer. + "The current inferior-tcl process buffer. MULTIPLE PROCESS SUPPORT =========================================================================== diff --git a/lisp/progmodes/vera-mode.el b/lisp/progmodes/vera-mode.el index 7f3f99f5cfb..6737bf229a0 100644 --- a/lisp/progmodes/vera-mode.el +++ b/lisp/progmodes/vera-mode.el @@ -90,12 +90,12 @@ :group 'languages) (defcustom vera-basic-offset 2 - "*Amount of basic offset used for indentation." + "Amount of basic offset used for indentation." :type 'integer :group 'vera) (defcustom vera-underscore-is-part-of-word nil - "*Non-nil means consider the underscore character `_' as part of word. + "Non-nil means consider the underscore character `_' as part of word. An identifier containing underscores is then treated as a single word in select and move operations. All parts of an identifier separated by underscore are treated as single words otherwise." @@ -103,7 +103,7 @@ are treated as single words otherwise." :group 'vera) (defcustom vera-intelligent-tab t - "*Non-nil means `TAB' does indentation, word completion and tab insertion. + "Non-nil means `TAB' does indentation, word completion and tab insertion. That is, if preceding character is part of a word then complete word, else if not at beginning of line then insert tab, else if last command was a `TAB' or `RET' then dedent one step, diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index 73e3cd9980f..c8ef8f0324c 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -419,7 +419,7 @@ Set `verilog-in-hooks' during this time, to assist AUTO caches." (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." @@ -429,7 +429,7 @@ you to the next lint error." (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." @@ -439,7 +439,7 @@ you to the next lint error." (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." @@ -449,7 +449,7 @@ you to the next lint error." (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." @@ -460,7 +460,7 @@ you to the next lint error." (defcustom verilog-preprocessor ;; Very few tools give preprocessed output, so we'll default to Verilog-Perl "vppreproc __FLAGS__ __FILE__" - "*Program and arguments to use to preprocess Verilog source. + "Program and arguments to use to preprocess Verilog source. This is invoked with `verilog-preprocess', and depending on the `verilog-set-compile-command', may also be invoked when you type \\[compile]. When the compile completes, \\[next-error] will @@ -480,7 +480,7 @@ Alternatively use the \"Choose Compilation Action\" menu. See `verilog-set-compile-command' for more information.") (defcustom verilog-highlight-translate-off nil - "*Non-nil means background-highlight code excluded from translation. + "Non-nil means background-highlight code excluded from translation. That is, all code between \"// synopsys translate_off\" and \"// synopsys translate_on\" is highlighted using a different background color \(face `verilog-font-lock-translate-off-face'). @@ -495,7 +495,7 @@ entry \"Fontify Buffer\"). XEmacs: turn off and on font locking." (put 'verilog-highlight-translate-off 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-lineup 'declarations - "*Type of statements to lineup across multiple lines. + "Type of statements to lineup across multiple lines. If 'all' is selected, then all line ups described below are done. If 'declaration', then just declarations are lined up with any @@ -526,13 +526,13 @@ are lineup only when \\[verilog-pretty-declarations] is typed." :group 'verilog-mode-indent ) (defcustom verilog-indent-level 3 - "*Indentation of Verilog statements with respect to containing block." + "Indentation of Verilog statements with respect to containing block." :group 'verilog-mode-indent :type 'integer) (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 @@ -540,14 +540,14 @@ your screen." (put 'verilog-indent-level-module 'safe-local-variable 'integerp) (defcustom verilog-indent-level-declaration 3 - "*Indentation of declarations with respect to containing block. + "Indentation of declarations with respect to containing block. Set to 0 to get them list right under containing block." :group 'verilog-mode-indent :type 'integer) (put 'verilog-indent-level-declaration 'safe-local-variable 'integerp) (defcustom verilog-indent-declaration-macros nil - "*How to treat macro expansions in a declaration. + "How to treat macro expansions in a declaration. If nil, indent as: input [31:0] a; input `CP; @@ -561,7 +561,7 @@ If non nil, treat as: (put 'verilog-indent-declaration-macros 'safe-local-variable 'verilog-booleanp) (defcustom verilog-indent-lists t - "*How to treat indenting items in a list. + "How to treat indenting items in a list. If t (the default), indent as: always @( posedge a or reset ) begin @@ -574,58 +574,58 @@ If nil, treat as: (put 'verilog-indent-lists 'safe-local-variable 'verilog-booleanp) (defcustom verilog-indent-level-behavioral 3 - "*Absolute indentation of first begin in a task or function block. + "Absolute indentation of first begin in a task or function block. Set to 0 to get such code to start at the left side of the screen." :group 'verilog-mode-indent :type 'integer) (put 'verilog-indent-level-behavioral 'safe-local-variable 'integerp) (defcustom verilog-indent-level-directive 1 - "*Indentation to add to each level of `ifdef declarations. + "Indentation to add to each level of `ifdef declarations. Set to 0 to have all directives start at the left side of the screen." :group 'verilog-mode-indent :type 'integer) (put 'verilog-indent-level-directive 'safe-local-variable 'integerp) (defcustom verilog-cexp-indent 2 - "*Indentation of Verilog statements split across lines." + "Indentation of Verilog statements split across lines." :group 'verilog-mode-indent :type 'integer) (put 'verilog-cexp-indent 'safe-local-variable 'integerp) (defcustom verilog-case-indent 2 - "*Indentation for case statements." + "Indentation for case statements." :group 'verilog-mode-indent :type 'integer) (put 'verilog-case-indent 'safe-local-variable 'integerp) (defcustom verilog-auto-newline t - "*True means automatically newline after semicolons." + "True means automatically newline after semicolons." :group 'verilog-mode-indent :type 'boolean) (put 'verilog-auto-newline 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-indent-on-newline t - "*True means automatically indent line after newline." + "True means automatically indent line after newline." :group 'verilog-mode-indent :type 'boolean) (put 'verilog-auto-indent-on-newline 'safe-local-variable 'verilog-booleanp) (defcustom verilog-tab-always-indent t - "*True means TAB should always re-indent the current line. + "True means TAB should always re-indent the current 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) (defcustom verilog-tab-to-comment nil - "*True means TAB moves to the right hand column in preparation for a comment." + "True means TAB moves to the right hand column in preparation for a comment." :group 'verilog-mode-actions :type 'boolean) (put 'verilog-tab-to-comment 'safe-local-variable 'verilog-booleanp) (defcustom verilog-indent-begin-after-if t - "*If true, indent begin statements following if, else, while, for and repeat. + "If true, indent begin statements following if, else, while, for and repeat. Otherwise, line them up." :group 'verilog-mode-indent :type 'boolean) @@ -633,14 +633,14 @@ Otherwise, line them up." (defcustom verilog-align-ifelse nil - "*If true, align `else' under matching `if'. + "If true, align `else' under matching `if'. Otherwise else is lined up with first character on line holding matching if." :group 'verilog-mode-indent :type 'boolean) (put 'verilog-align-ifelse 'safe-local-variable 'verilog-booleanp) (defcustom verilog-minimum-comment-distance 10 - "*Minimum distance (in lines) between begin and end required before a comment. + "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." :group 'verilog-mode-indent @@ -648,7 +648,7 @@ default avoids too many redundant comments in tight quarters." (put 'verilog-minimum-comment-distance 'safe-local-variable 'integerp) (defcustom verilog-highlight-p1800-keywords nil - "*True means highlight words newly reserved by IEEE-1800. + "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. A nil value means highlight these words as appropriate for the SystemVerilog @@ -659,7 +659,7 @@ to see the effect as font color choices are cached by Emacs." (put 'verilog-highlight-p1800-keywords 'safe-local-variable 'verilog-booleanp) (defcustom verilog-highlight-grouping-keywords nil - "*True means highlight grouping keywords 'begin' and 'end' more dramatically. + "True means highlight grouping keywords 'begin' and 'end' more dramatically. If false, these words are in the `font-lock-type-face'; if True then they are in `verilog-font-lock-ams-face'. Some find that special highlighting on these grouping constructs allow the structure of the code to be understood at a glance." @@ -668,7 +668,7 @@ grouping constructs allow the structure of the code to be understood at a glance (put 'verilog-highlight-grouping-keywords 'safe-local-variable 'verilog-booleanp) (defcustom verilog-highlight-modules nil - "*True means highlight module statements for `verilog-load-file-at-point'. + "True means highlight module statements for `verilog-load-file-at-point'. When true, mousing over module names will allow jumping to the module definition. If false, this is not supported. Setting this is experimental, and may lead to bad performance." @@ -677,7 +677,7 @@ this is experimental, and may lead to bad performance." (put 'verilog-highlight-modules 'safe-local-variable 'verilog-booleanp) (defcustom verilog-highlight-includes t - "*True means highlight module statements for `verilog-load-file-at-point'. + "True means highlight module statements for `verilog-load-file-at-point'. When true, mousing over include file names will allow jumping to the file referenced. If false, this is not supported." :group 'verilog-mode-indent @@ -685,7 +685,7 @@ file referenced. If false, this is not supported." (put 'verilog-highlight-includes 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-declare-nettype nil - "*Non-nil specifies the data type to use with `verilog-auto-input' etc. + "Non-nil specifies the data type to use with `verilog-auto-input' etc. Set this to \"wire\" if the Verilog code uses \"`default_nettype none\". Note using `default_nettype none isn't recommended practice; this mode is experimental." @@ -695,7 +695,7 @@ mode is experimental." (put 'verilog-auto-declare-nettype 'safe-local-variable `stringp) (defcustom verilog-auto-wire-type nil - "*Non-nil specifies the data type to use with `verilog-auto-wire' etc. + "Non-nil specifies the data type to use with `verilog-auto-wire' etc. Set this to \"logic\" for SystemVerilog code, or use `verilog-auto-logic'." :version "24.1" :group 'verilog-mode-actions @@ -703,21 +703,21 @@ Set this to \"logic\" for SystemVerilog code, or use `verilog-auto-logic'." (put 'verilog-auto-wire-type 'safe-local-variable `stringp) (defcustom verilog-auto-endcomments t - "*True means insert a comment /* ... */ after 'end's. + "True means insert a comment /* ... */ after 'end's. The name of the function or case will be set between the braces." :group 'verilog-mode-actions :type 'boolean) (put 'verilog-auto-endcomments 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-delete-trailing-whitespace nil - "*True means to `delete-trailing-whitespace' in `verilog-auto'." + "True means to `delete-trailing-whitespace' in `verilog-auto'." :version "24.1" :group 'verilog-mode-actions :type 'boolean) (put 'verilog-auto-delete-trailing-whitespace 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-ignore-concat nil - "*True means ignore signals in {...} concatenations for AUTOWIRE etc. + "True means ignore signals in {...} concatenations for AUTOWIRE etc. This will exclude signals referenced as pin connections in {...} from AUTOWIRE, AUTOOUTPUT and friends. This flag should be set for backward compatibility only and not set in new designs; it @@ -727,7 +727,7 @@ may be removed in future versions." (put 'verilog-auto-ignore-concat 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-read-includes nil - "*True means to automatically read includes before AUTOs. + "True means to automatically read includes before AUTOs. This will do a `verilog-read-defines' and `verilog-read-includes' before each AUTO expansion. This makes it easier to embed defines and includes, but can result in very slow reading times if there are many or large @@ -737,7 +737,7 @@ include files." (put 'verilog-auto-read-includes 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-save-policy nil - "*Non-nil indicates action to take when saving a Verilog buffer with AUTOs. + "Non-nil indicates action to take when saving a Verilog buffer with AUTOs. A value of `force' will always do a \\[verilog-auto] automatically if needed on every save. A value of `detect' will do \\[verilog-auto] automatically when it thinks necessary. A value of `ask' will query the @@ -750,7 +750,7 @@ sub-module's port list has changed." :type '(choice (const nil) (const ask) (const detect) (const force))) (defcustom verilog-auto-star-expand t - "*Non-nil indicates to expand a SystemVerilog .* instance ports. + "Non-nil indicates to expand a SystemVerilog .* instance ports. They will be expanded in the same way as if there was a AUTOINST in the instantiation. See also `verilog-auto-star' and `verilog-auto-star-save'." :group 'verilog-mode-actions @@ -758,7 +758,7 @@ instantiation. See also `verilog-auto-star' and `verilog-auto-star-save'." (put 'verilog-auto-star-expand 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-star-save nil - "*Non-nil indicates to save to disk SystemVerilog .* instance expansions. + "Non-nil indicates to save to disk SystemVerilog .* instance expansions. A nil value indicates direct connections will be removed before saving. Only meaningful to those created due to `verilog-auto-star-expand' being set. @@ -775,7 +775,7 @@ always be saved." "Text from file-local-variables during last evaluation.") (defvar verilog-diff-function 'verilog-diff-report - "*Function to run when `verilog-diff-auto' detects differences. + "Function to run when `verilog-diff-auto' detects differences. Function takes three arguments, the original buffer, the difference buffer, and the point in original buffer with the first difference.") @@ -869,11 +869,11 @@ See `compilation-error-regexp-alist-alist' for the formatting. For XEmacs.") ("^In file \\([^ \t]+\\)[ \t]+line[ \t]+\\([0-9]+\\):\n[^\n]*\n[^\n]*\n\\(Warning\\|Error\\|Failure\\)[^\n]*" 1 bold t) ("^In file \\([^ \t]+\\)[ \t]+line[ \t]+\\([0-9]+\\):\n[^\n]*\n[^\n]*\n\\(Warning\\|Error\\|Failure\\)[^\n]*" 2 bold t) ) - "*Keywords to also highlight in Verilog *compilation* buffers. + "Keywords to also highlight in Verilog *compilation* buffers. Only used in XEmacs; GNU Emacs uses `verilog-error-regexp-emacs-alist'.") (defcustom verilog-library-flags '("") - "*List of standard Verilog arguments to use for /*AUTOINST*/. + "List of standard Verilog arguments to use for /*AUTOINST*/. These arguments are used to find files for `verilog-auto', and match the flags accepted by a standard Verilog-XL simulator. @@ -904,7 +904,7 @@ See also the variables mentioned above." (put 'verilog-library-flags 'safe-local-variable 'listp) (defcustom verilog-library-directories '(".") - "*List of directories when looking for files for /*AUTOINST*/. + "List of directories when looking for files for /*AUTOINST*/. The directory may be relative to the current file, or absolute. Environment variables are also expanded in the directory names. Having at least the current directory is a good idea. @@ -927,7 +927,7 @@ and `verilog-library-extensions'." (put 'verilog-library-directories 'safe-local-variable 'listp) (defcustom verilog-library-files '() - "*List of files to search for modules. + "List of files to search for modules. AUTOINST will use this when it needs to resolve a module name. This is a complete path, usually to a technology file with many standard cells defined in it. @@ -949,14 +949,14 @@ See also `verilog-library-flags', `verilog-library-directories'." (put 'verilog-library-files 'safe-local-variable 'listp) (defcustom verilog-library-extensions '(".v" ".sv") - "*List of extensions to use when looking for files for /*AUTOINST*/. + "List of extensions to use when looking for files for /*AUTOINST*/. See also `verilog-library-flags', `verilog-library-directories'." :type '(repeat string) :group 'verilog-mode-auto) (put 'verilog-library-extensions 'safe-local-variable 'listp) (defcustom verilog-active-low-regexp nil - "*If set, treat signals matching this regexp as active low. + "If set, treat signals matching this regexp as active low. This is used for AUTORESET and AUTOTIEOFF. For proper behavior, you will probably also need `verilog-auto-reset-widths' set." :group 'verilog-mode-auto @@ -964,7 +964,7 @@ you will probably also need `verilog-auto-reset-widths' set." (put 'verilog-active-low-regexp 'safe-local-variable 'stringp) (defcustom verilog-auto-sense-include-inputs nil - "*If true, AUTOSENSE should include all inputs. + "If true, AUTOSENSE should include all inputs. If nil, only inputs that are NOT output signals in the same block are included." :group 'verilog-mode-auto @@ -972,7 +972,7 @@ included." (put 'verilog-auto-sense-include-inputs 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-sense-defines-constant nil - "*If true, AUTOSENSE should assume all defines represent constants. + "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." @@ -981,7 +981,7 @@ of each Verilog file that requires it, rather than being set globally." (put 'verilog-auto-sense-defines-constant 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-reset-blocking-in-non t - "*If true, AUTORESET will reset those signals which were + "If true, AUTORESET will reset those signals which were assigned with blocking assignments (=) even in a block with non-blocking assignments (<=). @@ -995,7 +995,7 @@ those temporaries reset. See example in `verilog-auto-reset'." (put 'verilog-auto-reset-blocking-in-non 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-reset-widths t - "*If true, AUTORESET should determine the width of signals. + "If true, AUTORESET should determine the width of signals. 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 @@ -1005,13 +1005,13 @@ the MSB or LSB of a signal inside an AUTORESET." (put 'verilog-auto-reset-widths 'safe-local-variable 'verilog-booleanp) (defcustom verilog-assignment-delay "" - "*Text used for delays in delayed assignments. Add a trailing space if set." + "Text used for delays in delayed assignments. Add a trailing space if set." :group 'verilog-mode-auto :type 'string) (put 'verilog-assignment-delay 'safe-local-variable 'stringp) (defcustom verilog-auto-arg-sort nil - "*If set, AUTOARG signal names will be sorted, not in declaration order. + "If set, AUTOARG signal names will be sorted, not in declaration order. Declaration order is advantageous with order based instantiations and is the default for backward compatibility. Sorted order reduces changes when declarations are moved around in a file, and @@ -1023,7 +1023,7 @@ See also `verilog-auto-inst-sort'." (put 'verilog-auto-arg-sort 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-inst-dot-name nil - "*If true, when creating ports with AUTOINST, use .name syntax. + "If true, when creating ports with AUTOINST, use .name syntax. This will use \".port\" instead of \".port(port)\" when possible. This is only legal in SystemVerilog files, and will confuse older simulators. Setting `verilog-auto-inst-vector' to nil may also @@ -1033,7 +1033,7 @@ be desirable to increase how often .name will be used." (put 'verilog-auto-inst-dot-name 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-inst-param-value nil - "*If set, AUTOINST will replace parameters with the parameter value. + "If set, AUTOINST will replace parameters with the parameter value. If nil, leave parameters as symbolic names. Parameters must be in Verilog 2001 format #(...), and if a parameter is not @@ -1070,7 +1070,7 @@ instead expand to: (put 'verilog-auto-inst-param-value 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-inst-sort nil - "*If set, AUTOINST signal names will be sorted, not in declaration order. + "If set, AUTOINST signal names will be sorted, not in declaration order. Also affects AUTOINSTPARAM. Declaration order is the default for backward compatibility, and as some teams prefer signals that are declared together to remain together. Sorted order reduces @@ -1083,7 +1083,7 @@ See also `verilog-auto-arg-sort'." (put 'verilog-auto-inst-sort 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-inst-vector t - "*If true, when creating default ports with AUTOINST, use bus subscripts. + "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.) Setting this to nil may @@ -1093,7 +1093,7 @@ speed up some simulators, but is less general and harder to read, so avoid." (put 'verilog-auto-inst-vector 'safe-local-variable 'verilog-booleanp) (defcustom verilog-auto-inst-template-numbers nil - "*If true, when creating templated ports with AUTOINST, add a comment. + "If true, when creating templated ports with AUTOINST, add a comment. If t, the comment will add the line number of the template that was used for that port declaration. This setting is suggested @@ -1110,34 +1110,34 @@ won't merge conflict." '(lambda (x) (memq x '(nil t lhs)))) (defcustom verilog-auto-inst-column 40 - "*Indent-to column number for net name part of AUTOINST created pin." + "Indent-to column number for net name part of AUTOINST created pin." :group 'verilog-mode-indent :type 'integer) (put 'verilog-auto-inst-column 'safe-local-variable 'integerp) (defcustom verilog-auto-input-ignore-regexp nil - "*If set, when creating AUTOINPUT list, ignore signals matching this regexp. + "If set, when creating AUTOINPUT list, ignore signals matching this regexp. See the \\[verilog-faq] for examples on using this." :group 'verilog-mode-auto :type 'string) (put 'verilog-auto-input-ignore-regexp 'safe-local-variable 'stringp) (defcustom verilog-auto-inout-ignore-regexp nil - "*If set, when creating AUTOINOUT list, ignore signals matching this regexp. + "If set, when creating AUTOINOUT list, ignore signals matching this regexp. See the \\[verilog-faq] for examples on using this." :group 'verilog-mode-auto :type 'string) (put 'verilog-auto-inout-ignore-regexp 'safe-local-variable 'stringp) (defcustom verilog-auto-output-ignore-regexp nil - "*If set, when creating AUTOOUTPUT list, ignore signals matching this regexp. + "If set, when creating AUTOOUTPUT list, ignore signals matching this regexp. See the \\[verilog-faq] for examples on using this." :group 'verilog-mode-auto :type 'string) (put 'verilog-auto-output-ignore-regexp 'safe-local-variable 'stringp) (defcustom verilog-auto-tieoff-declaration "wire" - "*Data type used for the declaration for AUTOTIEOFF. If \"wire\" then + "Data type used for the declaration for AUTOTIEOFF. If \"wire\" then create a wire, if \"assign\" create an assignment, else the data type for variable creation." :version "24.1" @@ -1146,58 +1146,58 @@ variable creation." (put 'verilog-auto-tieoff-declaration 'safe-local-variable 'stringp) (defcustom verilog-auto-tieoff-ignore-regexp nil - "*If set, when creating AUTOTIEOFF list, ignore signals matching this regexp. + "If set, when creating AUTOTIEOFF list, ignore signals matching this regexp. See the \\[verilog-faq] for examples on using this." :group 'verilog-mode-auto :type 'string) (put 'verilog-auto-tieoff-ignore-regexp 'safe-local-variable 'stringp) (defcustom verilog-auto-unused-ignore-regexp nil - "*If set, when creating AUTOUNUSED list, ignore signals matching this regexp. + "If set, when creating AUTOUNUSED list, ignore signals matching this regexp. See the \\[verilog-faq] for examples on using this." :group 'verilog-mode-auto :type 'string) (put 'verilog-auto-unused-ignore-regexp 'safe-local-variable 'stringp) (defcustom verilog-typedef-regexp nil - "*If non-nil, regular expression that matches Verilog-2001 typedef names. + "If non-nil, regular expression that matches Verilog-2001 typedef names. For example, \"_t$\" matches typedefs named with _t, as in the C language." :group 'verilog-mode-auto :type 'string) (put 'verilog-typedef-regexp 'safe-local-variable 'stringp) (defcustom verilog-mode-hook 'verilog-set-compile-command - "*Hook run after Verilog mode is loaded." + "Hook run after Verilog mode is loaded." :type 'hook :group 'verilog-mode) (defcustom verilog-auto-hook nil - "*Hook run after `verilog-mode' updates AUTOs." + "Hook run after `verilog-mode' updates AUTOs." :group 'verilog-mode-auto :type 'hook) (defcustom verilog-before-auto-hook nil - "*Hook run before `verilog-mode' updates AUTOs." + "Hook run before `verilog-mode' updates AUTOs." :group 'verilog-mode-auto :type 'hook) (defcustom verilog-delete-auto-hook nil - "*Hook run after `verilog-mode' deletes AUTOs." + "Hook run after `verilog-mode' deletes AUTOs." :group 'verilog-mode-auto :type 'hook) (defcustom verilog-before-delete-auto-hook nil - "*Hook run before `verilog-mode' deletes AUTOs." + "Hook run before `verilog-mode' deletes AUTOs." :group 'verilog-mode-auto :type 'hook) (defcustom verilog-getopt-flags-hook nil - "*Hook run after `verilog-getopt-flags' determines the Verilog option lists." + "Hook run after `verilog-getopt-flags' determines the Verilog option lists." :group 'verilog-mode-auto :type 'hook) (defcustom verilog-before-getopt-flags-hook nil - "*Hook run before `verilog-getopt-flags' determines the Verilog option lists." + "Hook run before `verilog-getopt-flags' determines the Verilog option lists." :group 'verilog-mode-auto :type 'hook) @@ -1211,17 +1211,17 @@ For example, \"_t$\" matches typedefs named with _t, as in the C language." ;; Customization variables: ;; (defvar verilog-date-scientific-format nil - "*If non-nil, dates are written in scientific format (e.g. 1997/09/17). + "If non-nil, dates are written in scientific format (e.g. 1997/09/17). If nil, in European format (e.g. 17.09.1997). The brain-dead American 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) @@ -6686,7 +6686,7 @@ Region is defined by B and EDPOS." (defvar verilog-buffer-to-use nil) (defvar verilog-flag nil) (defvar verilog-toggle-completions nil - "*True means \\<verilog-mode-map>\\[verilog-complete-word] should try all possible completions one by one. + "True means \\<verilog-mode-map>\\[verilog-complete-word] should try all possible completions one by one. Repeated use of \\[verilog-complete-word] will show you all of them. Normally, when there is more than one possible completion, it displays a list of all possible completions.") @@ -6701,13 +6701,13 @@ it displays a list of all possible completions.") "rtranif1" "semaphore" "time" "tran" "tranif0" "tranif1" "tri" "tri0" "tri1" "triand" "trior" "trireg" "wand" "wire" "wor" "xnor" "xor" ) - "*Keywords for types used when completing a word in a declaration or parmlist. + "Keywords for types used when completing a word in a declaration or parmlist. \(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. + "Keywords to complete when at first word of a line in declarative scope. \(initial, always, begin, assign...) The procedures and variables defined within the Verilog program will be completed at runtime and should not be added to this list.") @@ -6721,7 +6721,7 @@ will be completed at runtime and should not be added to this list.") "task" "endtask" "primitive" "endprimitive" ) verilog-type-keywords) - "*Keywords to complete when at first word of a line in declarative scope. + "Keywords to complete when at first word of a line in declarative scope. \(initial, always, begin, assign...) The procedures and variables defined within the Verilog program will be completed at runtime and should not be added to this list.") @@ -6732,28 +6732,28 @@ will be completed at runtime and should not be added to this list.") "endgenerate" "endinterface" "endpackage" "endspecify" "endtask" "for" "fork" "if" "join" "join_any" "join_none" "repeat" "return" "while") - "*Keywords to complete when at first word of a line in behavioral scope. + "Keywords to complete when at first word of a line in behavioral scope. \(begin, if, then, else, for, fork...) The procedures and variables defined within the Verilog program 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. + "Keywords to complete when at first word of a line in a task or function. \(begin, if, then, else, for, fork.) The procedures and variables defined within the Verilog program 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. + "Keywords to complete when at first word of a line in case scope. \(begin, if, then, else, for, fork...) The procedures and variables defined within the Verilog program 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. + "Keywords to complete when NOT standing at the first word of a statement. \(else, then, begin...) Variables and function names defined within the Verilog program will be completed at runtime and should not be added to this list.") @@ -6786,10 +6786,10 @@ will be completed at runtime and should not be added to this list.") ("tranif1" "inout" "inout") ("xnor" "output") ("xor" "output")) - "*Map of direction for each positional argument to each gate primitive.") + "Map of direction for each positional argument to each gate primitive.") (defvar verilog-gate-keywords (mapcar `car verilog-gate-ios) - "*Keywords for gate primitives.") + "Keywords for gate primitives.") (defun verilog-string-diff (str1 str2) "Return index of first letter where STR1 and STR2 differs." diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el index c9bf638bb59..9b7ee5d6aa0 100644 --- a/lisp/progmodes/vhdl-mode.el +++ b/lisp/progmodes/vhdl-mode.el @@ -198,7 +198,7 @@ Examples: :group 'vhdl) (defcustom vhdl-indent-tabs-mode nil - "*Non-nil means indentation can insert tabs. + "Non-nil means indentation can insert tabs. Overrides local variable `indent-tabs-mode'." :type 'boolean :group 'vhdl-mode) @@ -322,7 +322,7 @@ Overrides local variable `indent-tabs-mode'." ("^ *Compiling \"\\(.+\\)\" " 1) nil) ) - "*List of available VHDL compilers and their properties. + "List of available VHDL compilers and their properties. Each list entry specifies the following items for a compiler: Compiler: Compiler name : name used in option `vhdl-compiler' to choose compiler @@ -429,7 +429,7 @@ NOTE: Activate new error and file message regexps and reflect the new setting :group 'vhdl-compile) (defcustom vhdl-compiler "ModelSim" - "*Specifies the VHDL compiler to be used for syntax analysis. + "Specifies the VHDL compiler to be used for syntax analysis. Select a compiler name from the ones defined in option `vhdl-compiler-alist'." :type (let ((alist vhdl-compiler-alist) list) (while alist @@ -439,7 +439,7 @@ Select a compiler name from the ones defined in option `vhdl-compiler-alist'." :group 'vhdl-compile) (defcustom vhdl-compile-use-local-error-regexp t - "*Non-nil means use buffer-local `compilation-error-regexp-alist'. + "Non-nil means use buffer-local `compilation-error-regexp-alist'. In this case, only error message regexps for VHDL compilers are active if compilation is started from a VHDL buffer. Otherwise, the error message regexps are appended to the predefined global regexps, and all regexps are @@ -451,7 +451,7 @@ NOTE: Activate the new setting by restarting Emacs." :group 'vhdl-compile) (defcustom vhdl-makefile-generation-hook nil - "*Functions to run at the end of Makefile generation. + "Functions to run at the end of Makefile generation. Allows to insert user specific parts into a Makefile. Example: @@ -462,7 +462,7 @@ Example: :group 'vhdl-compile) (defcustom vhdl-default-library "work" - "*Name of default library. + "Name of default library. Is overwritten by project settings if a project is active." :type 'string :group 'vhdl-compile) @@ -488,7 +488,7 @@ Is overwritten by project settings if a project is active." -- This is a multi-line project description -- that can be used as a project dependent part of the file header. ")) - "*List of projects and their properties. + "List of projects and their properties. Name : name used in option `vhdl-project' to choose project Title : title of project (single-line string) Default directory: default project directory (absolute path) @@ -594,7 +594,7 @@ NOTE: Reflect the new setting in the choice list of option `vhdl-project' :group 'vhdl-project) (defcustom vhdl-project nil - "*Specifies the default for the current project. + "Specifies the default for the current project. Select a project name from the ones defined in option `vhdl-project-alist'. Is used to determine the project title and description to be inserted in file headers and the source files/directories to be scanned in the hierarchy @@ -608,7 +608,7 @@ browser. The current project can also be changed temporarily in the menu." :group 'vhdl-project) (defcustom vhdl-project-file-name '("\\1.prj") - "*List of file names/paths for importing/exporting project setups. + "List of file names/paths for importing/exporting project setups. \"\\1\" is replaced by the project name (SPC is replaced by `_'), \"\\2\" is replaced by the user name (allows to have user-specific project setups). The first entry is used as file name to import/export individual project @@ -624,7 +624,7 @@ in global directories)." :group 'vhdl-project) (defcustom vhdl-project-auto-load '(startup) - "*Automatically load project setups from files. + "Automatically load project setups from files. All project setup files that match the file names specified in option `vhdl-project-file-name' are automatically loaded. The project of the \(alphabetically) last loaded setup of the first `vhdl-project-file-name' @@ -635,7 +635,7 @@ A project setup file can be obtained by exporting a project (see menu). :group 'vhdl-project) (defcustom vhdl-project-sort t - "*Non-nil means projects are displayed in alphabetical order." + "Non-nil means projects are displayed in alphabetical order." :type 'boolean :group 'vhdl-project) @@ -648,7 +648,7 @@ A project setup file can be obtained by exporting a project (see menu). :group 'vhdl-compose) (defcustom vhdl-standard '(87 nil) - "*VHDL standards used. + "VHDL standards used. Basic standard: VHDL'87 : IEEE Std 1076-1987 VHDL'93 : IEEE Std 1076-1993 @@ -675,13 +675,13 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl-style) (defcustom vhdl-basic-offset 2 - "*Amount of basic offset used for indentation. + "Amount of basic offset used for indentation. This value is used by + and - symbols in `vhdl-offsets-alist'." :type 'integer :group 'vhdl-style) (defcustom vhdl-upper-case-keywords nil - "*Non-nil means convert keywords to upper case. + "Non-nil means convert keywords to upper case. This is done when typed or expanded or by the fix case functions." :type 'boolean :set (lambda (variable value) @@ -689,7 +689,7 @@ This is done when typed or expanded or by the fix case functions." :group 'vhdl-style) (defcustom vhdl-upper-case-types nil - "*Non-nil means convert standardized types to upper case. + "Non-nil means convert standardized types to upper case. This is done when expanded or by the fix case functions." :type 'boolean :set (lambda (variable value) @@ -697,7 +697,7 @@ This is done when expanded or by the fix case functions." :group 'vhdl-style) (defcustom vhdl-upper-case-attributes nil - "*Non-nil means convert standardized attributes to upper case. + "Non-nil means convert standardized attributes to upper case. This is done when expanded or by the fix case functions." :type 'boolean :set (lambda (variable value) @@ -705,7 +705,7 @@ This is done when expanded or by the fix case functions." :group 'vhdl-style) (defcustom vhdl-upper-case-enum-values nil - "*Non-nil means convert standardized enumeration values to upper case. + "Non-nil means convert standardized enumeration values to upper case. This is done when expanded or by the fix case functions." :type 'boolean :set (lambda (variable value) @@ -713,7 +713,7 @@ This is done when expanded or by the fix case functions." :group 'vhdl-style) (defcustom vhdl-upper-case-constants t - "*Non-nil means convert standardized constants to upper case. + "Non-nil means convert standardized constants to upper case. This is done when expanded." :type 'boolean :set (lambda (variable value) @@ -721,7 +721,7 @@ This is done when expanded." :group 'vhdl-style) (defcustom vhdl-use-direct-instantiation 'standard - "*Non-nil means use VHDL'93 direct component instantiation. + "Non-nil means use VHDL'93 direct component instantiation. Never : never Standard: only in VHDL standards that allow it (VHDL'93 and higher) Always : always" @@ -737,7 +737,7 @@ This is done when expanded." (defcustom vhdl-entity-file-name '(".*" . "\\&") (concat - "*Specifies how the entity file name is obtained. + "Specifies how the entity file name is obtained. The entity file name can be obtained by modifying the entity name (e.g. attaching or stripping off a substring). The file extension is automatically taken from the file name of the current buffer." @@ -749,7 +749,7 @@ taken from the file name of the current buffer." (defcustom vhdl-architecture-file-name '("\\(.*\\) \\(.*\\)" . "\\1_\\2") (concat - "*Specifies how the architecture file name is obtained. + "Specifies how the architecture file name is obtained. The architecture file name can be obtained by modifying the entity and/or architecture name (e.g. attaching or stripping off a substring). The file extension is automatically taken from the file name of the current @@ -764,7 +764,7 @@ access to both names (see default setting as example)." (defcustom vhdl-configuration-file-name '(".*" . "\\&") (concat - "*Specifies how the configuration file name is obtained. + "Specifies how the configuration file name is obtained. The configuration file name can be obtained by modifying the configuration name (e.g. attaching or stripping off a substring). The file extension is automatically taken from the file name of the current buffer." @@ -776,7 +776,7 @@ automatically taken from the file name of the current buffer." (defcustom vhdl-package-file-name '(".*" . "\\&") (concat - "*Specifies how the package file name is obtained. + "Specifies how the package file name is obtained. The package file name can be obtained by modifying the package name (e.g. attaching or stripping off a substring). The file extension is automatically taken from the file name of the current buffer. Package files can be created @@ -789,7 +789,7 @@ file name." :group 'vhdl-compose) (defcustom vhdl-file-name-case 'identity - "*Specifies how to change case for obtaining file names. + "Specifies how to change case for obtaining file names. When deriving a file name from a VHDL unit name, case can be changed as follows: As Is: case is not changed (taken as is) @@ -809,7 +809,7 @@ follows: :group 'vhdl) (defcustom vhdl-electric-keywords '(vhdl user) - "*Type of keywords for which electrification is enabled. + "Type of keywords for which electrification is enabled. VHDL keywords: invoke built-in templates User keywords: invoke user models (see option `vhdl-model-alist')" :type '(set (const :tag "VHDL keywords" vhdl) @@ -819,7 +819,7 @@ follows: :group 'vhdl-template) (defcustom vhdl-optional-labels 'process - "*Constructs for which labels are to be queried. + "Constructs for which labels are to be queried. Template generators prompt for optional labels for: None : no constructs Processes only: processes only (also procedurals in VHDL-AMS) @@ -830,7 +830,7 @@ Template generators prompt for optional labels for: :group 'vhdl-template) (defcustom vhdl-insert-empty-lines 'unit - "*Specifies whether to insert empty lines in some templates. + "Specifies whether to insert empty lines in some templates. This improves readability of code. Empty lines are inserted in: None : no constructs Design units only: entities, architectures, configurations, packages only @@ -845,7 +845,7 @@ Replaces option `vhdl-additional-empty-lines'." :group 'vhdl-compose) (defcustom vhdl-argument-list-indent nil - "*Non-nil means indent argument lists relative to opening parenthesis. + "Non-nil means indent argument lists relative to opening parenthesis. That is, argument, association, and port lists start on the same line as the opening parenthesis and subsequent lines are indented accordingly. Otherwise, lists start on a new line and are indented as normal code." @@ -855,7 +855,7 @@ Otherwise, lists start on a new line and are indented as normal code." :group 'vhdl-compose) (defcustom vhdl-association-list-with-formals t - "*Non-nil means write association lists with formal parameters. + "Non-nil means write association lists with formal parameters. Templates prompt for formal and actual parameters (ports/generics). When pasting component instantiations, formals are included. If nil, only a list of actual parameters is entered." @@ -865,17 +865,17 @@ If nil, only a list of actual parameters is entered." :group 'vhdl-compose) (defcustom vhdl-conditions-in-parenthesis nil - "*Non-nil means place parenthesis around condition expressions." + "Non-nil means place parenthesis around condition expressions." :type 'boolean :group 'vhdl-template) (defcustom vhdl-zero-string "'0'" - "*String to use for a logic zero." + "String to use for a logic zero." :type 'string :group 'vhdl-template) (defcustom vhdl-one-string "'1'" - "*String to use for a logic one." + "String to use for a logic one." :type 'string :group 'vhdl-template) @@ -906,7 +906,7 @@ If nil, only a list of actual parameters is entered." ------------------------------------------------------------------------------- " - "*String or file to insert as file header. + "String or file to insert as file header. If the string specifies an existing file name, the contents of the file is inserted, otherwise the string itself is inserted as file header. Type `C-j' for newlines. @@ -936,7 +936,7 @@ dependent part of the file header and can also contain the above keywords." :group 'vhdl-header) (defcustom vhdl-file-footer "" - "*String or file to insert as file footer. + "String or file to insert as file footer. If the string specifies an existing file name, the contents of the file is inserted, otherwise the string itself is inserted as file footer (i.e. at the end of the file). @@ -946,7 +946,7 @@ The same keywords as in option `vhdl-file-header' can be used." :group 'vhdl-header) (defcustom vhdl-company-name "" - "*Name of company to insert in file header. + "Name of company to insert in file header. See option `vhdl-file-header'." :type 'string :group 'vhdl-header) @@ -955,14 +955,14 @@ See option `vhdl-file-header'." ------------------------------------------------------------------------------- -- Copyright (c) <year> <company> " - "*Copyright string to insert in file header. + "Copyright string to insert in file header. Can be multi-line string (type `C-j' for newline) and contain other file header keywords (see option `vhdl-file-header')." :type 'string :group 'vhdl-header) (defcustom vhdl-platform-spec "" - "*Specification of VHDL platform to insert in file header. + "Specification of VHDL platform to insert in file header. The platform specification should contain names and versions of the simulation and synthesis tools used. See option `vhdl-file-header'." @@ -970,7 +970,7 @@ See option `vhdl-file-header'." :group 'vhdl-header) (defcustom vhdl-date-format "%Y-%m-%d" - "*Specifies the date format to use in the header. + "Specifies the date format to use in the header. This string is passed as argument to the command `format-time-string'. For more information on format strings, see the documentation for the `format-time-string' command (C-h f `format-time-string')." @@ -978,7 +978,7 @@ For more information on format strings, see the documentation for the :group 'vhdl-header) (defcustom vhdl-modify-date-prefix-string "-- Last update: " - "*Prefix string of modification date in VHDL file header. + "Prefix string of modification date in VHDL file header. If actualization of the modification date is called (menu, `\\[vhdl-template-modify]'), this string is searched and the rest of the line replaced by the current date." @@ -986,7 +986,7 @@ of the line replaced by the current date." :group 'vhdl-header) (defcustom vhdl-modify-date-on-saving t - "*Non-nil means update the modification date when the buffer is saved. + "Non-nil means update the modification date when the buffer is saved. Calls function `\\[vhdl-template-modify]'). NOTE: Activate the new setting in a VHDL buffer by using the menu entry @@ -1000,26 +1000,26 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl-template) (defcustom vhdl-reset-kind 'async - "*Specifies which kind of reset to use in sequential processes." + "Specifies which kind of reset to use in sequential processes." :type '(choice (const :tag "None" none) (const :tag "Synchronous" sync) (const :tag "Asynchronous" async)) :group 'vhdl-sequential-process) (defcustom vhdl-reset-active-high nil - "*Non-nil means reset in sequential processes is active high. + "Non-nil means reset in sequential processes is active high. Otherwise, reset is active low." :type 'boolean :group 'vhdl-sequential-process) (defcustom vhdl-clock-rising-edge t - "*Non-nil means rising edge of clock triggers sequential processes. + "Non-nil means rising edge of clock triggers sequential processes. Otherwise, falling edge triggers." :type 'boolean :group 'vhdl-sequential-process) (defcustom vhdl-clock-edge-condition 'standard - "*Syntax of the clock edge condition. + "Syntax of the clock edge condition. Standard: \"clk'event and clk = '1'\" Function: \"rising_edge(clk)\"" :type '(choice (const :tag "Standard" standard) @@ -1027,12 +1027,12 @@ Otherwise, falling edge triggers." :group 'vhdl-sequential-process) (defcustom vhdl-clock-name "" - "*Name of clock signal to use in templates." + "Name of clock signal to use in templates." :type 'string :group 'vhdl-sequential-process) (defcustom vhdl-reset-name "" - "*Name of reset signal to use in templates." + "Name of reset signal to use in templates." :type 'string :group 'vhdl-sequential-process) @@ -1054,7 +1054,7 @@ begin -- process <label> end if; end process <label>;" "e" "")) - "*List of user models. + "List of user models. VHDL models (templates) can be specified by the user in this list. They can be invoked from the menu, through key bindings (`C-c C-m ...'), or by keyword electrification (i.e. overriding existing or creating new keywords, see @@ -1103,7 +1103,7 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry (defcustom vhdl-compose-architecture-name '(".*" . "str") (concat - "*Specifies how the component architecture name is obtained. + "Specifies how the component architecture name is obtained. The component architecture name can be obtained by modifying the entity name \(e.g. attaching or stripping off a substring). If TO STRING is empty, the architecture name is queried." @@ -1115,7 +1115,7 @@ If TO STRING is empty, the architecture name is queried." (defcustom vhdl-compose-configuration-name '("\\(.*\\) \\(.*\\)" . "\\1_\\2_cfg") (concat - "*Specifies how the configuration name is obtained. + "Specifies how the configuration name is obtained. The configuration name can be obtained by modifying the entity and/or architecture name (e.g. attaching or stripping off a substring). The string that is matched against the regexp is the concatenation of the entity and the @@ -1129,7 +1129,7 @@ default setting as example)." (defcustom vhdl-components-package-name '((".*" . "\\&_components") . "components") (concat - "*Specifies how the name for the components package is obtained. + "Specifies how the name for the components package is obtained. The components package is a package containing all component declarations for the current design. Its name can be obtained by modifying the project name \(e.g. attaching or stripping off a substring). If no project is defined, the @@ -1142,19 +1142,19 @@ DIRECTORY entry is chosen." :group 'vhdl-compose) (defcustom vhdl-use-components-package nil - "*Non-nil means use a separate components package for component declarations. + "Non-nil means use a separate components package for component declarations. Otherwise, component declarations are inserted and searched for in the architecture declarative parts." :type 'boolean :group 'vhdl-compose) (defcustom vhdl-compose-include-header t - "*Non-nil means include a header in automatically generated files." + "Non-nil means include a header in automatically generated files." :type 'boolean :group 'vhdl-compose) (defcustom vhdl-compose-create-files 'single - "*Specifies whether new files should be created for the new component. + "Specifies whether new files should be created for the new component. The component's entity and architecture are inserted: None : in current buffer Single file : in new single file @@ -1167,14 +1167,14 @@ The file names are obtained from variables `vhdl-entity-file-name' and :group 'vhdl-compose) (defcustom vhdl-compose-configuration-create-file nil - "*Specifies whether a new file should be created for the configuration. + "Specifies whether a new file should be created for the configuration. If non-nil, a new file is created for the configuration. The file name is obtained from variable `vhdl-configuration-file-name'." :type 'boolean :group 'vhdl-compose) (defcustom vhdl-compose-configuration-hierarchical t - "*Specifies whether hierarchical configurations should be created. + "Specifies whether hierarchical configurations should be created. If non-nil, automatically created configurations are hierarchical and include the whole hierarchy of subcomponents. Otherwise the configuration only includes one level of subcomponents." @@ -1182,7 +1182,7 @@ includes one level of subcomponents." :group 'vhdl-compose) (defcustom vhdl-compose-configuration-use-subconfiguration t - "*Specifies whether subconfigurations should be used inside configurations. + "Specifies whether subconfigurations should be used inside configurations. If non-nil, automatically created configurations use configurations in binding indications for subcomponents, if such configurations exist. Otherwise, entities are used in binding indications for subcomponents." @@ -1196,22 +1196,22 @@ entities are used in binding indications for subcomponents." :group 'vhdl-compose) (defcustom vhdl-include-port-comments nil - "*Non-nil means include port comments when a port is pasted." + "Non-nil means include port comments when a port is pasted." :type 'boolean :group 'vhdl-port) (defcustom vhdl-include-direction-comments nil - "*Non-nil means include port direction in instantiations as comments." + "Non-nil means include port direction in instantiations as comments." :type 'boolean :group 'vhdl-port) (defcustom vhdl-include-type-comments nil - "*Non-nil means include generic/port type in instantiations as comments." + "Non-nil means include generic/port type in instantiations as comments." :type 'boolean :group 'vhdl-port) (defcustom vhdl-include-group-comments 'never - "*Specifies whether to include group comments and spacings. + "Specifies whether to include group comments and spacings. The comments and empty lines between groups of ports are pasted: Never : never Declarations: in entity/component/constant/signal declarations only @@ -1223,7 +1223,7 @@ The comments and empty lines between groups of ports are pasted: (defcustom vhdl-actual-port-name '(".*" . "\\&") (concat - "*Specifies how actual port names are obtained from formal port names. + "Specifies how actual port names are obtained from formal port names. In a component instantiation, an actual port name can be obtained by modifying the formal port name (e.g. attaching or stripping off a substring)." vhdl-name-doc-string) @@ -1233,7 +1233,7 @@ modifying the formal port name (e.g. attaching or stripping off a substring)." (defcustom vhdl-instance-name '(".*" . "\\&_%d") (concat - "*Specifies how an instance name is obtained. + "Specifies how an instance name is obtained. The instance name can be obtained by modifying the name of the component to be instantiated (e.g. attaching or stripping off a substring). \"%d\" is replaced by a unique number (starting with 1). @@ -1250,7 +1250,7 @@ If TO STRING is empty, the instance name is queried." (defcustom vhdl-testbench-entity-name '(".*" . "\\&_tb") (concat - "*Specifies how the testbench entity name is obtained. + "Specifies how the testbench entity name is obtained. The entity name of a testbench can be obtained by modifying the name of the component to be tested (e.g. attaching or stripping off a substring)." vhdl-name-doc-string) @@ -1260,7 +1260,7 @@ the component to be tested (e.g. attaching or stripping off a substring)." (defcustom vhdl-testbench-architecture-name '(".*" . "") (concat - "*Specifies how the testbench architecture name is obtained. + "Specifies how the testbench architecture name is obtained. The testbench architecture name can be obtained by modifying the name of the component to be tested (e.g. attaching or stripping off a substring). If TO STRING is empty, the architecture name is queried." @@ -1271,7 +1271,7 @@ If TO STRING is empty, the architecture name is queried." (defcustom vhdl-testbench-configuration-name vhdl-compose-configuration-name (concat - "*Specifies how the testbench configuration name is obtained. + "Specifies how the testbench configuration name is obtained. The configuration name of a testbench can be obtained by modifying the entity and/or architecture name (e.g. attaching or stripping off a substring). The string that is matched against the regexp is the concatenation of the entity @@ -1284,7 +1284,7 @@ names (see default setting as example)." (defcustom vhdl-testbench-dut-name '(".*" . "DUT") (concat - "*Specifies how a DUT instance name is obtained. + "Specifies how a DUT instance name is obtained. The design-under-test instance name (i.e. the component instantiated in the testbench) can be obtained by modifying the component name (e.g. attaching or stripping off a substring)." @@ -1294,7 +1294,7 @@ or stripping off a substring)." :group 'vhdl-testbench) (defcustom vhdl-testbench-include-header t - "*Non-nil means include a header in automatically generated files." + "Non-nil means include a header in automatically generated files." :type 'boolean :group 'vhdl-testbench) @@ -1302,7 +1302,7 @@ or stripping off a substring)." -- clock signal Clk : std_logic := '1'; " - "*String or file to be inserted in the testbench declarative part. + "String or file to be inserted in the testbench declarative part. If the string specifies an existing file name, the contents of the file is inserted, otherwise the string itself is inserted in the testbench architecture before the BEGIN keyword. @@ -1322,7 +1322,7 @@ Type `C-j' for newlines." wait until Clk = '1'; end process WaveGen_Proc; " - "*String or file to be inserted in the testbench statement part. + "String or file to be inserted in the testbench statement part. If the string specifies an existing file name, the contents of the file is inserted, otherwise the string itself is inserted in the testbench architecture before the END keyword. @@ -1331,22 +1331,22 @@ Type `C-j' for newlines." :group 'vhdl-testbench) (defcustom vhdl-testbench-initialize-signals nil - "*Non-nil means initialize signals with `0' when declared in testbench." + "Non-nil means initialize signals with `0' when declared in testbench." :type 'boolean :group 'vhdl-testbench) (defcustom vhdl-testbench-include-library t - "*Non-nil means a library/use clause for std_logic_1164 is included." + "Non-nil means a library/use clause for std_logic_1164 is included." :type 'boolean :group 'vhdl-testbench) (defcustom vhdl-testbench-include-configuration t - "*Non-nil means a testbench configuration is attached at the end." + "Non-nil means a testbench configuration is attached at the end." :type 'boolean :group 'vhdl-testbench) (defcustom vhdl-testbench-create-files 'single - "*Specifies whether new files should be created for the testbench. + "Specifies whether new files should be created for the testbench. testbench entity and architecture are inserted: None : in current buffer Single file : in new single file @@ -1360,7 +1360,7 @@ and `vhdl-testbench-architecture-file-name'." (defcustom vhdl-testbench-entity-file-name vhdl-entity-file-name (concat - "*Specifies how the testbench entity file name is obtained. + "Specifies how the testbench entity file name is obtained. The entity file name can be obtained by modifying the testbench entity name \(e.g. attaching or stripping off a substring). The file extension is automatically taken from the file name of the current buffer. Testbench @@ -1373,7 +1373,7 @@ absolute path to the file name." (defcustom vhdl-testbench-architecture-file-name vhdl-architecture-file-name (concat - "*Specifies how the testbench architecture file name is obtained. + "Specifies how the testbench architecture file name is obtained. The architecture file name can be obtained by modifying the testbench entity and/or architecture name (e.g. attaching or stripping off a substring). The string that is matched against the regexp is the concatenation of the entity @@ -1392,17 +1392,17 @@ name." :group 'vhdl) (defcustom vhdl-self-insert-comments t - "*Non-nil means various templates automatically insert help comments." + "Non-nil means various templates automatically insert help comments." :type 'boolean :group 'vhdl-comment) (defcustom vhdl-prompt-for-comments t - "*Non-nil means various templates prompt for user definable comments." + "Non-nil means various templates prompt for user definable comments." :type 'boolean :group 'vhdl-comment) (defcustom vhdl-inline-comment-column 40 - "*Column to indent and align inline comments to. + "Column to indent and align inline comments to. Overrides local option `comment-column'. NOTE: Activate the new setting in a VHDL buffer by using the menu entry @@ -1411,7 +1411,7 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl-comment) (defcustom vhdl-end-comment-column 79 - "*End of comment column. + "End of comment column. Comments that exceed this column number are wrapped. NOTE: Activate the new setting in a VHDL buffer by using the menu entry @@ -1427,19 +1427,19 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl) (defcustom vhdl-auto-align t - "*Non-nil means align some templates automatically after generation." + "Non-nil means align some templates automatically after generation." :type 'boolean :group 'vhdl-align) (defcustom vhdl-align-groups t - "*Non-nil means align groups of code lines separately. + "Non-nil means align groups of code lines separately. A group of code lines is a region of consecutive lines between two lines that match the regexp in option `vhdl-align-group-separate'." :type 'boolean :group 'vhdl-align) (defcustom vhdl-align-group-separate "^\\s-*$" - "*Regexp for matching a line that separates groups of lines for alignment. + "Regexp for matching a line that separates groups of lines for alignment. Examples: \"^\\s-*$\": matches an empty line \"^\\s-*\\(--.*\\)?$\": matches an empty line or a comment-only line" @@ -1447,7 +1447,7 @@ Examples: :group 'vhdl-align) (defcustom vhdl-align-same-indent t - "*Non-nil means align blocks with same indent separately. + "Non-nil means align blocks with same indent separately. When a region or the entire buffer is aligned, the code is divided into blocks of same indent which are aligned separately (except for argument/port lists). This gives nicer alignment in most cases. @@ -1461,7 +1461,7 @@ Option `vhdl-align-groups' still applies within these blocks." :group 'vhdl) (defcustom vhdl-highlight-keywords t - "*Non-nil means highlight VHDL keywords and other standardized words. + "Non-nil means highlight VHDL keywords and other standardized words. The following faces are used: `font-lock-keyword-face' : keywords `font-lock-type-face' : standardized types @@ -1477,7 +1477,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-names t - "*Non-nil means highlight declaration names and construct labels. + "Non-nil means highlight declaration names and construct labels. The following faces are used: `font-lock-function-name-face' : names in declarations of units, subprograms, components, as well as labels of VHDL constructs @@ -1494,7 +1494,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-special-words nil - "*Non-nil means highlight words with special syntax. + "Non-nil means highlight words with special syntax. The words with syntax and color specified in option `vhdl-special-syntax-alist' are highlighted accordingly. Can be used for visual support of naming conventions. @@ -1507,7 +1507,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-forbidden-words nil - "*Non-nil means highlight forbidden words. + "Non-nil means highlight forbidden words. The reserved words specified in option `vhdl-forbidden-words' or having the syntax specified in option `vhdl-forbidden-syntax' are highlighted in a warning color (face `vhdl-font-lock-reserved-words-face') to indicate not to @@ -1522,7 +1522,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-verilog-keywords nil - "*Non-nil means highlight Verilog keywords as reserved words. + "Non-nil means highlight Verilog keywords as reserved words. Verilog keywords are highlighted in a warning color (face `vhdl-font-lock-reserved-words-face') to indicate not to use them. @@ -1535,7 +1535,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-translate-off nil - "*Non-nil means background-highlight code excluded from translation. + "Non-nil means background-highlight code excluded from translation. That is, all code between \"-- pragma translate_off\" and \"-- pragma translate_on\" is highlighted using a different background color \(face `vhdl-font-lock-translate-off-face'). @@ -1549,7 +1549,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-highlight-case-sensitive nil - "*Non-nil means consider case for highlighting. + "Non-nil means consider case for highlighting. Possible trade-off: non-nil also upper-case VHDL words are highlighted, but case of words with special syntax is not considered @@ -1566,7 +1566,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu '(("generic/constant" "\\w+_[cg]" "Gold3" "BurlyWood1") ("type" "\\w+_t" "ForestGreen" "PaleGreen") ("variable" "\\w+_v" "Grey50" "Grey80")) - "*List of special syntax to be highlighted. + "List of special syntax to be highlighted. If option `vhdl-highlight-special-words' is non-nil, words with the specified syntax (as regular expression) are highlighted in the corresponding color. @@ -1599,7 +1599,7 @@ NOTE: Activate a changed regexp in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-forbidden-words '() - "*List of forbidden words to be highlighted. + "List of forbidden words to be highlighted. If option `vhdl-highlight-forbidden-words' is non-nil, these reserved words are highlighted in a warning color to indicate not to use them. @@ -1612,7 +1612,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-forbidden-syntax "" - "*Syntax of forbidden words to be highlighted. + "Syntax of forbidden words to be highlighted. If option `vhdl-highlight-forbidden-words' is non-nil, words with this syntax are highlighted in a warning color to indicate not to use them. Can be used to highlight too long identifiers (e.g. \"\\w\\w\\w\\w\\w\\w\\w\\w\\w\\w+\" @@ -1627,7 +1627,7 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl-highlight) (defcustom vhdl-directive-keywords '("pragma" "synopsys") - "*List of compiler directive keywords recognized for highlighting. + "List of compiler directive keywords recognized for highlighting. NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu entry \"Fontify Buffer\")." @@ -1643,13 +1643,13 @@ NOTE: Activate the new setting in a VHDL buffer by re-fontifying it (menu :group 'vhdl) (defcustom vhdl-speedbar-auto-open nil - "*Non-nil means automatically open speedbar at startup. + "Non-nil means automatically open speedbar at startup. Alternatively, the speedbar can be opened from the VHDL menu." :type 'boolean :group 'vhdl-speedbar) (defcustom vhdl-speedbar-display-mode 'files - "*Specifies the default displaying mode when opening speedbar. + "Specifies the default displaying mode when opening speedbar. Alternatively, the displaying mode can be selected from the speedbar menu or by typing `f' (files), `h' (directory hierarchy) or `H' (project hierarchy)." :type '(choice (const :tag "Files" files) @@ -1658,7 +1658,7 @@ by typing `f' (files), `h' (directory hierarchy) or `H' (project hierarchy)." :group 'vhdl-speedbar) (defcustom vhdl-speedbar-scan-limit '(10000000 (1000000 50)) - "*Limits scanning of large files and netlists. + "Limits scanning of large files and netlists. Design units: maximum file size to scan for design units Hierarchy (instances of subcomponents): File size: maximum file size to scan for instances (in bytes) @@ -1685,18 +1685,18 @@ prevent the scanning of large netlists." :group 'vhdl-speedbar) (defcustom vhdl-speedbar-jump-to-unit t - "*Non-nil means jump to the design unit code when opened in a buffer. + "Non-nil means jump to the design unit code when opened in a buffer. The buffer cursor position is left unchanged otherwise." :type 'boolean :group 'vhdl-speedbar) (defcustom vhdl-speedbar-update-on-saving t - "*Automatically update design hierarchy when buffer is saved." + "Automatically update design hierarchy when buffer is saved." :type 'boolean :group 'vhdl-speedbar) (defcustom vhdl-speedbar-save-cache '(hierarchy display) - "*Automatically save modified hierarchy caches when exiting Emacs. + "Automatically save modified hierarchy caches when exiting Emacs. Hierarchy: design hierarchy information Display: displaying information (which design units to expand)" :type '(set (const :tag "Hierarchy" hierarchy) @@ -1704,7 +1704,7 @@ The buffer cursor position is left unchanged otherwise." :group 'vhdl-speedbar) (defcustom vhdl-speedbar-cache-file-name ".emacs-vhdl-cache-\\1-\\2" - "*Name of file for saving hierarchy cache. + "Name of file for saving hierarchy cache. \"\\1\" is replaced by the project name if a project is specified, \"directory\" otherwise. \"\\2\" is replaced by the user name (allows for different users to have cache files in the same directory). Can also have @@ -1718,20 +1718,20 @@ an absolute path (i.e. all caches can be stored in one global directory)." :group 'vhdl) (defcustom vhdl-index-menu nil - "*Non-nil means add an index menu for a source file when loading. + "Non-nil means add an index menu for a source file when loading. Alternatively, the speedbar can be used. Note that the index menu scans a file when it is opened, while speedbar only scans the file upon request." :type 'boolean :group 'vhdl-menu) (defcustom vhdl-source-file-menu nil - "*Non-nil means add a menu of all source files in current directory. + "Non-nil means add a menu of all source files in current directory. Alternatively, the speedbar can be used." :type 'boolean :group 'vhdl-menu) (defcustom vhdl-hideshow-menu nil - "*Non-nil means add hideshow menu and functionality at startup. + "Non-nil means add hideshow menu and functionality at startup. Hideshow can also be enabled from the VHDL Mode menu. Hideshow allows hiding code of various VHDL constructs. @@ -1741,7 +1741,7 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl-menu) (defcustom vhdl-hide-all-init nil - "*Non-nil means hide all design units initially after a file is loaded." + "Non-nil means hide all design units initially after a file is loaded." :type 'boolean :group 'vhdl-menu) @@ -1751,7 +1751,7 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl) (defcustom vhdl-print-two-column t - "*Non-nil means print code in two columns and landscape format. + "Non-nil means print code in two columns and landscape format. Adjusts settings in a way that PostScript printing (\"File\" menu, `ps-print') prints VHDL files in a nice two-column landscape style. @@ -1761,7 +1761,7 @@ NOTE: Activate the new setting by restarting Emacs. :group 'vhdl-print) (defcustom vhdl-print-customize-faces t - "*Non-nil means use an optimized set of faces for PostScript printing. + "Non-nil means use an optimized set of faces for PostScript printing. NOTE: Activate the new setting by restarting Emacs. Overrides `ps-print' settings locally." @@ -1774,7 +1774,7 @@ NOTE: Activate the new setting by restarting Emacs. :group 'vhdl) (defcustom vhdl-intelligent-tab t - "*Non-nil means `TAB' does indentation, word completion and tab insertion. + "Non-nil means `TAB' does indentation, word completion and tab insertion. That is, if preceding character is part of a word then complete word, else if not at beginning of line then insert tab, else if last command was a `TAB' or `RET' then dedent one step, @@ -1788,28 +1788,28 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry :group 'vhdl-misc) (defcustom vhdl-indent-syntax-based t - "*Non-nil means indent lines of code based on their syntactic context. + "Non-nil means indent lines of code based on their syntactic context. Otherwise, a line is indented like the previous nonblank line. This can be useful in large files where syntax-based indentation gets very slow." :type 'boolean :group 'vhdl-misc) (defcustom vhdl-word-completion-case-sensitive nil - "*Non-nil means word completion using `TAB' is case sensitive. + "Non-nil means word completion using `TAB' is case sensitive. That is, `TAB' completes words that start with the same letters and case. Otherwise, case is ignored." :type 'boolean :group 'vhdl-misc) (defcustom vhdl-word-completion-in-minibuffer t - "*Non-nil enables word completion in minibuffer (for template prompts). + "Non-nil enables word completion in minibuffer (for template prompts). NOTE: Activate the new setting by restarting Emacs." :type 'boolean :group 'vhdl-misc) (defcustom vhdl-underscore-is-part-of-word nil - "*Non-nil means consider the underscore character `_' as part of word. + "Non-nil means consider the underscore character `_' as part of word. An identifier containing underscores is then treated as a single word in select and move operations. All parts of an identifier separated by underscore are treated as single words otherwise. @@ -1844,24 +1844,24 @@ NOTE: Activate the new setting in a VHDL buffer by using the menu entry ;; Internal variables (defvar vhdl-menu-max-size 20 - "*Specifies the maximum size of a menu before splitting it into submenus.") + "Specifies the maximum size of a menu before splitting it into submenus.") (defvar vhdl-progress-interval 1 - "*Interval used to update progress status during long operations. + "Interval used to update progress status during long operations. If a number, percentage complete gets updated after each interval of that many seconds. To inhibit all messages, set this option to nil.") (defvar vhdl-inhibit-startup-warnings-p nil - "*If non-nil, inhibits start up compatibility warnings.") + "If non-nil, inhibits start up compatibility warnings.") (defvar vhdl-strict-syntax-p nil - "*If non-nil, all syntactic symbols must be found in `vhdl-offsets-alist'. + "If non-nil, all syntactic symbols must be found in `vhdl-offsets-alist'. If the syntactic symbol for a particular line does not match a symbol in the offsets alist, an error is generated, otherwise no error is reported and the syntactic symbol is ignored.") (defvar vhdl-echo-syntactic-information-p nil - "*If non-nil, syntactic info is echoed when the line is indented.") + "If non-nil, syntactic info is echoed when the line is indented.") (defconst vhdl-offsets-alist-default '((string . -1000) @@ -1889,7 +1889,7 @@ Do not change this constant! See the variable `vhdl-offsets-alist' for more information.") (defvar vhdl-offsets-alist (copy-alist vhdl-offsets-alist-default) - "*Association list of syntactic element symbols and indentation offsets. + "Association list of syntactic element symbols and indentation offsets. As described below, each cons cell in this list has the form: (SYNTACTIC-SYMBOL . OFFSET) @@ -1950,7 +1950,7 @@ Here is the current list of valid syntactic element symbols: package-body -- inside a package body") (defvar vhdl-comment-only-line-offset 0 - "*Extra offset for line which contains only the start of a comment. + "Extra offset for line which contains only the start of a comment. Can contain an integer or a cons cell of the form: (NON-ANCHORED-OFFSET . ANCHORED-OFFSET) @@ -1961,7 +1961,7 @@ the amount of offset to give column-zero anchored comment-only lines. Just an integer as value is equivalent to (<val> . 0)") (defvar vhdl-special-indent-hook nil - "*Hook for user defined special indentation adjustments. + "Hook for user defined special indentation adjustments. This hook gets called after a line is indented by the mode.") (defvar vhdl-style-alist @@ -2003,7 +2003,7 @@ your style, only those that are different from the default.") (setq vhdl-style-alist (cons default vhdl-style-alist)))) (defvar vhdl-mode-hook nil - "*Hook called by `vhdl-mode'.") + "Hook called by `vhdl-mode'.") ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; diff --git a/lisp/progmodes/xscheme.el b/lisp/progmodes/xscheme.el index 1f50910330c..f9d83da1a3a 100644 --- a/lisp/progmodes/xscheme.el +++ b/lisp/progmodes/xscheme.el @@ -48,7 +48,7 @@ "Name of xscheme buffer that we're currently interacting with.") (defvar xscheme-expressions-ring-max 30 - "*Maximum length of Scheme expressions ring.") + "Maximum length of Scheme expressions ring.") (defvar xscheme-expressions-ring nil "List of expressions recently transmitted to the Scheme process.") @@ -116,12 +116,12 @@ from being inserted into the process-buffer.") :group 'lisp) (defcustom scheme-band-name nil - "*Band loaded by the `run-scheme' command." + "Band loaded by the `run-scheme' command." :type '(choice (const nil) string) :group 'xscheme) (defcustom scheme-program-arguments nil - "*Arguments passed to the Scheme program by the `run-scheme' command." + "Arguments passed to the Scheme program by the `run-scheme' command." :type '(choice (const nil) string) :group 'xscheme) |