diff options
| author | Karl Heuer | 1999-02-23 22:23:57 +0000 |
|---|---|---|
| committer | Karl Heuer | 1999-02-23 22:23:57 +0000 |
| commit | 701b1ec29afc83a41a2250e794b0ec0b4d531633 (patch) | |
| tree | 3cdf4aefdf9f3527d52031469ff87ff93a8f4757 /src/eval.c | |
| parent | e6e9c5160dfef762ce0e41c8b17c43a024bdd0f2 (diff) | |
| download | emacs-701b1ec29afc83a41a2250e794b0ec0b4d531633.tar.gz emacs-701b1ec29afc83a41a2250e794b0ec0b4d531633.zip | |
(Fdefconst): Doc fix.
Diffstat (limited to 'src/eval.c')
| -rw-r--r-- | src/eval.c | 11 |
1 files changed, 2 insertions, 9 deletions
diff --git a/src/eval.c b/src/eval.c index 45147ecfb35..e8ff6857053 100644 --- a/src/eval.c +++ b/src/eval.c | |||
| @@ -623,18 +623,11 @@ If INITVALUE is missing, SYMBOL's value is not set.") | |||
| 623 | 623 | ||
| 624 | DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0, | 624 | DEFUN ("defconst", Fdefconst, Sdefconst, 2, UNEVALLED, 0, |
| 625 | "(defconst SYMBOL INITVALUE DOCSTRING): define SYMBOL as a constant variable.\n\ | 625 | "(defconst SYMBOL INITVALUE DOCSTRING): define SYMBOL as a constant variable.\n\ |
| 626 | The intent is that programs do not change this value, but users may.\n\ | 626 | The intent is that nether programs nor users should ever change this value.\n\ |
| 627 | Always sets the value of SYMBOL to the result of evalling INITVALUE.\n\ | 627 | Always sets the value of SYMBOL to the result of evalling INITVALUE.\n\ |
| 628 | If SYMBOL is buffer-local, its default value is what is set;\n\ | 628 | If SYMBOL is buffer-local, its default value is what is set;\n\ |
| 629 | buffer-local values are not affected.\n\ | 629 | buffer-local values are not affected.\n\ |
| 630 | DOCSTRING is optional.\n\ | 630 | DOCSTRING is optional.") |
| 631 | If DOCSTRING starts with *, this variable is identified as a user option.\n\ | ||
| 632 | This means that M-x set-variable and M-x edit-options recognize it.\n\n\ | ||
| 633 | Note: do not use `defconst' for user options in libraries that are not\n\ | ||
| 634 | normally loaded, since it is useful for users to be able to specify\n\ | ||
| 635 | their own values for such variables before loading the library.\n\ | ||
| 636 | Since `defconst' unconditionally assigns the variable,\n\ | ||
| 637 | it would override the user's choice.") | ||
| 638 | (args) | 631 | (args) |
| 639 | Lisp_Object args; | 632 | Lisp_Object args; |
| 640 | { | 633 | { |