1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-31 17:30:54 -08:00
Commit graph

88 commits

Author SHA1 Message Date
Paul Eggert
09b73f0820 Style fixes for floating-point doc.
* commands.texi, customize.texi, display.texi, elisp.texi, files.texi:
* frames.texi, hash.texi, internals.texi, keymaps.texi, lists.texi:
* minibuf.texi, nonascii.texi, numbers.texi, objects.texi, os.texi:
* processes.texi, streams.texi, strings.texi, text.texi:
* variables.texi, windows.texi:
Hyphenate "floating-point" iff it precedes a noun.
Reword to avoid nouns and hyphenation when that's easy.
Prefer "integer" to "integer number" and "is floating point"
to "is a floating point number".
Prefer "@minus{}" to "-" when it's a minus.
2014-03-17 18:19:03 -07:00
Chong Yidong
81c7d631e9 More doc updates.
* backups.texi (Making Backups): Document backup-buffer change.

* commands.texi (Defining Commands): Document the interactive-form
property more carefully.  Document interactive-only.

* compile.texi (Compiler Errors): Copyedits.  Note that the
details for byte-compile-warnings are in its docstring.

* customize.texi (Variable Definitions): Likewise.

* files.texi (Visiting Files): Copyedits.
(Testing Accessibility): Mention ACLs.  Move file-modes here from
File Attributes.
(Truenames): Move file-equal-p here from Kinds of Files.
(File Attributes): Move file-newer-than-file-p here from Testing
Accessibility.
(Extended Attributes): New node.  Add file-extended-attributes.
(Changing Files): Document set-file-extended-attributes.

* minibuf.texi (Minibuffer Contents): Remove obsolete function
minibuffer-completion-contents.

* variables.texi (Defining Variables): Note that defvar acts
always on the dynamic value.
2014-01-06 07:36:13 +08:00
Paul Eggert
ba3189039a Update copyright year to 2014 by running admin/update-copyright. 2014-01-01 07:43:34 +00:00
Chong Yidong
362397edd9 Document `eval' changes.
* doc/lispref/eval.texi (Eval): Document the LEXICAL arg to eval.

* doc/lispref/variables.texi (Variables, Void Variables): Use "scoping rule"
terminology consistently.
(Variable Scoping): Add index entries, and use "dynamic scope"
terminology in place of "indefinite scope" to reduce confusion.
(Lexical Binding): Document lexical environment format.
(Using Lexical Binding): Add index entries for error messages.
2013-12-25 11:05:11 +08:00
Xue Fuqiao
b345c56182 Document `enable-dir-local-variables'.
* doc/lispref/variables.texi (Directory Local Variables): Document `enable-dir-local-variables'.
2013-12-22 14:15:17 +08:00
Stefan Monnier
a8544941cf * lispref/variables.texi (File Local Variables): Don't recommend quoting! 2013-08-26 11:28:24 -04:00
Xue Fuqiao
9097ad863d Add indexes for elisp manual.
* doc/lispref/display.texi (Face Functions): Add an index.

* doc/lispref/variables.texi (Variable Aliases): Add an index.

* doc/lispref/functions.texi (Defining Functions): Add an index.

* doc/lispref/nonascii.texi (Coding System Basics): Add an index.
2013-08-02 21:52:10 +08:00
Glenn Morris
611e8a4854 * doc/lispref/variables.texi (Lexical Binding): Fix typo. 2013-06-11 21:25:53 -04:00
Bastien Guerry
5765e9e081 * variables.texi (File Local Variables): Fix reference.
Thanks to Aurélien Aptel and for reporting this problem
and to Xue Fuqiao for suggesting a fix.
2013-02-27 13:12:20 +01:00
Paul Eggert
ab422c4d68 Update copyright notices for 2013. 2013-01-01 09:11:05 +00:00
Eli Zaretskii
151d90884b Fix bug #13292 with use of @var in @def.. commands in ELisp manual.
doc/lispref/functions.texi (Declare Form):
 doc/lispref/intro.texi (A Sample Function Description):
 doc/lispref/syntax.texi (Syntax Table Internals, Syntax Table Functions):
 doc/lispref/variables.texi (Using Lexical Binding): Don't use @var or CAPS
 in @def.. commands.
2012-12-29 10:23:21 +02:00
Paul Eggert
1df7defd80 Fix minor whitespace issues after "." in manual.
Be more systematic about using "@." (not ".") at end of sentence that
ends in a capital letter, and about appending "@:" after non-ends of
sentences that end in a lower case letter followed by "." followed by
whitespace.  Omit unnecessary use of "@:" and "@.".  Similarly for "?"
and "!".  Be more consistent about putting a comma after "i.e." and
"e.g."; this is the typical American style and it's easier to code in
Texinfo.

Fixes: debbugs:12973
2012-12-05 14:27:56 -08:00
Chong Yidong
f02f19bd4e Lisp manual improvements for plists and symbol plists.
* doc/lispref/commands.texi (Using Interactive): Fix index entry.

* doc/lispref/customize.texi (Variable Definitions):
* doc/lispref/display.texi (Defining Faces):
* doc/lispref/sequences.texi (Char-Tables): Fix xref.

* doc/lispref/lists.texi (Property Lists): Move here from symbols.texi.
(Plist Access): Rename from Other Plists.

* doc/lispref/symbols.texi (Symbol Properties): New node.
(Symbol Plists): Make it a subsection under Symbol Properties.
(Standard Properties): New node.
2012-12-02 17:14:16 +08:00
Glenn Morris
a13e12f957 Mention a few more gv.el features in the lispref
* doc/lispref/variables.texi (Adding Generalized Variables):
At least mention gv-define-expander and gv-letplace.
2012-11-12 00:23:23 -08:00
Glenn Morris
6efddf7851 Formatting tweak for variables.texi
* doc/lispref/variables.texi (Adding Generalized Variables):
Use standard formatting for common lisp note about setf functions.
2012-11-10 16:20:51 -08:00
Chong Yidong
7c08f8ba72 Document setf-local, defvar-local, and some doc updates for setf.
* doc/lispref/edebug.texi (Specification List): setf is no longer CL-only.

* doc/lispref/lists.texi (List Elements, List Variables): Clarify descriptions
of push and pop for generalized variables.

* doc/lispref/variables.texi (Creating Buffer-Local): Document setq-local and
defvar-local.
(Setting Generalized Variables): Arrange table alphabetically.
2012-11-07 13:22:10 +08:00
Glenn Morris
2ee1d59f5b Small doc updates for generalized variables
* lisp/emacs-lisp/gv.el (gv-letplace): Fix doc typo.
(gv-define-simple-setter): Update doc of `fix-return'.

* doc/lispref/variables.texi (Adding Generalized Variables):
Update description of FIX-RETURN expansion.

* doc/misc/cl.texi (Obsolete Setf Customization):
Revert defsetf example to the more correct let rather than prog1.
2012-11-06 20:37:07 -08:00
Glenn Morris
072c7b659c Minor rephrasing of previous variables.texi change 2012-11-06 00:02:25 -08:00
Glenn Morris
651af8c631 Move note on lack of setf functions from cl.texi to lispref
* doc/lispref/variables.texi (Adding Generalized Variables):
Move note on lack of setf functions to here...

* doc/misc/cl.texi (Obsolete Setf Customization): ... from here.
2012-11-05 21:03:34 -05:00
Glenn Morris
ebdbfb9535 Add some documentation on defining new generalized variables
* doc/lispref/variables.texi (Setting Generalized Variables):
Split most of previous contents into this subsection.
(Adding Generalized Variables): New subsection.

* doc/lispref/elisp.texi:
Add Generalized Variables subsections to detailed menu.

* etc/NEWS: Mention some gv.el macros by name.
2012-11-05 20:42:17 -05:00
Paul Eggert
5c6ce1c7d0 Spelling fixes. 2012-10-31 12:23:06 -07:00
Glenn Morris
516e1a08ce More small manual updates for cl.texi
* doc/misc/cl.texi (Setf Extensions): Partially restore note about cl-getf,
mainly moved to lispref/variables.texi.
(Property Lists): Fix cl-getf typos.

* doc/lispref/variables.texi (Generalized Variables): Fix typo.
2012-10-30 00:54:17 -07:00
Glenn Morris
5887564d5b Move generalized variable documentation from misc/cl.texi to lispref
* doc/lispref/variables.texi (Generalized Variables): New section,
adapted from misc/cl.texi.

* doc/lispref/elisp.texi (Top): Add Generalized Variables to menu.

* doc/lispref/lists.texi (List Elements, List Variables):
Mention generalized variables.

* doc/misc/cl.texi (Control Structure): Update for setf now being in core.
(Setf Extensions): Rename from Basic Setf.  Move much of the
former content to lispref/variables.texi.
(Modify Macros): Move pop, push details to lispref/variables.texi.
(Customizing Setf): Copyedits for setf etc being in core.
(Modify Macros, Efficiency Concerns, Porting Common Lisp):
Further namespaces updates.
2012-10-27 15:42:07 -07:00
Chong Yidong
ed1f0bd388 Doc fixes for defface and friends.
* lisp/cus-edit.el (custom-unlispify-remove-prefixes): Add warning.

* lisp/custom.el (defface): Doc fix.

* doc/lispref/customize.texi (Customization): Define customization more
carefully.
(Common Keywords): Add xref to Constant Variables.

* doc/lispref/display.texi (Faces): Discuss anonymous faces.
(Face Attributes): Tweak intro.
(Defining Faces): Move after the Face Attributes node.  Copyedits.
(Displaying Faces): Describe role of inheritance.

* doc/lispref/variables.texi (Defining Variables): Link to defcustom's node
instead of the higher-level Customization chapter.

Fixes: debbugs:11440
2012-09-18 13:14:42 +08:00
Chong Yidong
1a5432bc04 Fix doc of local-variable-if-set-p.
* doc/lispref/variables.texi (Creating Buffer-Local): Fix description of
local-variable-if-set-p.

* src/data.c (Flocal_variable_if_set_p): Doc fix (Bug#10713).
2012-09-07 22:15:59 +08:00
Chong Yidong
9f6f48455f Merge from emacs-24; up to 2012-05-02T07:12:52Z!rgm@gnu.org. 2012-08-07 11:33:37 +08:00
Eli Zaretskii
a08eadfecc Fix bug #12138 with indexing "closures".
doc/lispref/functions.texi (Closures): Put the main index entry for
 "closures" here.
 doc/lispref/variables.texi (Lexical Binding): Disambiguate the index entry
 for "closures".
2012-08-06 19:55:41 +03:00
Glenn Morris
ecc6530da9 Nuke hand-written node pointers in doc/lispref
Let makeinfo figure them out, as is recommended.
2012-05-26 18:34:14 -07:00
Glenn Morris
33017fafd1 Merge from emacs-24; up to 2012-04-24T08:35:02Z!lekktu@gmail.com 2012-05-26 18:06:44 -07:00
Chong Yidong
27d1f87a35 Misc docfixes.
Suggested by Martin Rudalics.

* doc/lispref/display.texi (Face Functions): Fix define-obsolete-face-alias.

* doc/lispref/functions.texi (Obsolete Functions): Fix doc for
set-advertised-calling-convention.

* doc/lispref/modes.texi (Mode Help): Fix describe-mode.

* doc/lispref/variables.texi (Variable Aliases): Fix make-obsolete-variable.

* lisp/help.el (describe-mode): Doc fix.
2012-05-15 23:43:06 +08:00
Chong Yidong
a8e7d6d783 Merge changes from emacs-24 branch 2012-04-27 11:10:38 +08:00
Glenn Morris
16152b76a4 Use Texinfo recommended convention for quotes+punctuation. 2012-04-25 20:31:47 -04:00
Glenn Morris
1e103a7cd8 Remove unnecessary @setfilename commands from many doc/lispref/*.texi 2012-04-13 18:59:01 -07:00
Glenn Morris
44e97401cd Standardize possessive apostrophe usage in manuals, docs, and comments
Ref: http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00649.html
2012-02-28 00:17:21 -08:00
Paul Eggert
34706efab4 Spelling fixes. 2012-02-14 21:15:43 -08:00
Chong Yidong
0992bd9c06 Fix and doc-fix for `buffer-local-variables'.
* src/buffer.c (Fbuffer_local_variables)
(buffer_lisp_local_variables): Handle unbound vars correctly;
don't let Qunbound leak into Lisp.

* doc/lispref/variables.texi (Creating Buffer-Local): Minor clarification
to buffer-local-variables doc.

Fixes: debbugs:10715
2012-02-07 14:34:52 +08:00
Chong Yidong
735cc5ca6f Update Functions chapter of Lisp manual; document closures.
* doc/emacs/functions.texi (What Is a Function): Add closures.  Mention
"return value" terminology.  Add xref for command-execute.  Remove
unused "keystroke command" terminology.
(Lambda Expressions): Give a different example than in the
following subsection.  Add xref to Anonymous Functions.
(Function Documentation): Remove gratuitous markup.
(Function Names): Move introductory text to `What Is a Function'.
(Defining Functions): Fix defun argument spec.
(Anonymous Functions): Document lambda macro explicitly.  Mention
effects on lexical binding.
(Function Cells): Downplay direct usage of fset.
(Closures): New node.
(Inline Functions): Remove "open-code" terminology.
(Declaring Functions): Minor tweak; .m is not C code.

* doc/emacs/variables.texi (Variables): Don't refer to "global value".
(Local Variables, Void Variables): Copyedits.
(Lexical Binding): Minor clarification of example.
(File Local Variables): Mention :safe and :risky defcustom args.
(Lexical Binding): Add xref to Closures node.
2012-02-04 22:56:32 +08:00
Glenn Morris
48da739227 Doc fix for lexical-binding being in line one.
Ref http://lists.gnu.org/archive/html/emacs-devel/2012-01/msg00543.html

* doc/lispref/variables.texi (Using Lexical Binding):
Mention that lexical-binding should be set in the first line.

* src/lread.c (syms_of_lread): Doc fix.

* lisp/emacs-lisp/tabulated-list.el, lisp/progmodes/f90.el:
Move lexical-binding file-local to line one.

* etc/NEWS: lexical-binding should be ine the first line.
2012-01-25 22:30:49 -08:00
Chong Yidong
1021c7615d Update Variables chapter of Lisp manual to handle lexical binding.
* doc/lispref/variables.texi (Variables, Local Variables, Void Variables):
Edit to make the descriptions less specific to dynamic binding.
(Local Variables): Default max-specpdl-size is now 1300.
(Defining Variables): Edits for lexical scoping.  Delete
information about starting docstrings with *.  De-document
user-variable-p.
(Tips for Defining): Remove an unimportant discussion of quitting
in the middle of a load.
(Accessing Variables, Setting Variables): Discuss lexical binding.
(Variable Scoping): Rewrite.
(Scope, Extent, Impl of Scope): Nodes deleted.
(Dynamic Binding): New node, with material from Scope, Extent, and
Impl of Scope nodes.
(Dynamic Binding Tips): Rename from Using Scoping.
(Lexical Binding): Rewrite.
(Using Lexical Binding): Rename from Converting to Lexical
Binding.  Convert to subsection.

* doc/lispref/customize.texi (Variable Definitions): Add custom-variable-p.
Move user-variable-p documentation here.
2012-01-25 00:08:00 +08:00
Glenn Morris
61086eb66b Document inhibit-local-variables-regexps in the lispref.
* doc/lispref/modes.texi (Auto Major Mode):
* doc/lispref/variables.texi (File Local Variables):
Mention inhibit-local-variables-regexps.

* etc/NEWS: Markup.
2012-01-20 19:15:07 -08:00
Chong Yidong
6a43ef8e85 Merge changes from emacs-23 branch 2012-01-09 13:29:45 +08:00
Chong Yidong
89bd9ccd5b More customization-related documentation updates.
* doc/emacs/custom.texi (Specifying File Variables): The mode: keyword
doesn't have to be first anymore.  Add example of specifying minor
modes.
(Directory Variables): Simplify example.  Mention application to
non-file buffers.
(Disabling): Use "initialization file" terminology.
(Init Examples): Fix hook example.

* doc/lispref/variables.texi (Directory Local Variables): Document
hack-dir-local-variables-non-file-buffer.

* lisp/files.el (hack-dir-local-variables-non-file-buffer): Add doc.
(hack-one-local-variable-eval-safep): Allow 0 arg for minor mode
functions, along with 1 and -1.
2012-01-06 18:53:41 +08:00
Glenn Morris
acaf905b11 Add 2012 to FSF copyright years for Emacs files 2012-01-05 01:46:05 -08:00
Stefan Monnier
9ca4c014c8 * variables.texi (Creating Buffer-Local): Warn against misuses of
make-variable-buffer-local.

Fixes: debbugs:10258
2011-12-27 18:48:53 -05:00
Juanma Barranquero
9022ae07ee Fix bug#10354.
* doc/lispref/variables.texi (Variables with Restricted Values):
  Change reference to variable.
2011-12-23 14:14:12 +01:00
Lars Magne Ingebrigtsen
3073fc1414 * variables.texi (Lexical Binding): Mention `defcustom'.
Fixes: debbugs:8459
2011-07-15 14:45:51 +02:00
Chong Yidong
c830e5aeea Remove frame-local vars from Lisp manual; obsolete since Emacs 22.3.
* display.texi (Window Systems): `window-system' is terminal-local.

* doc/lispref/frames.texi (Frame Parameters, Parameter Access): Don't mention
frame-local variables.

* doc/lispref/variables.texi (Buffer-Local Variables): Don't mention obsolete
frame-local variables.  (Frame-Local Variables): Node deleted.

* doc/lispref/elisp.texi (Top): Update node listing.
2011-07-12 13:33:18 -04:00
Eli Zaretskii
7018dbe72c Fix incorrect usage of @kindex.
doc/lispref/variables.texi (Defining Variables, Void Variables)
 (Constant Variables): Fix incorrect usage of @kindex.
2011-07-02 20:18:16 +03:00
Lars Magne Ingebrigtsen
8d4294e957 (Defining Variables): Use @findex for functions. 2011-07-02 19:10:29 +02:00
Lars Magne Ingebrigtsen
4051493f74 Remove spurious newline introduced by last checkin. 2011-07-02 18:20:15 +02:00