1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-14 09:39:42 +00:00
Commit Graph

69 Commits

Author SHA1 Message Date
Basil L. Contovounesios
59344c43a9 * doc/lispref/customize.texi (Custom Themes): Clarify .el preference.
Copyright-paperwork-exempt: yes

https://lists.gnu.org/archive/html/emacs-devel/2018-01/msg00824.html.
2018-02-02 09:22:53 -05:00
Paul Eggert
5c7dd8a783 Update copyright year to 2018
Run admin/update-copyright.
2018-01-01 00:57:59 -08:00
Paul Eggert
743b95cc63 Be more consistent about "directory name" in manual
This clarifies the documentation, partly in response to the
discussion in Bug#27986.
2017-09-09 13:41:20 -07:00
Paul Eggert
5badc81c1c Update copyright year to 2017
Run admin/update-copyright.
2016-12-31 19:42:26 -08:00
Lars Ingebrigtsen
93703c547a (Common Keywords): Correct what missing :group means
* doc/lispref/customize.texi (Common Keywords): Correct what
missing :group means.
2016-05-03 19:06:36 +02:00
Lars Ingebrigtsen
805204f3ef Mention what a missing :group does
* doc/lispref/customize.texi (Common Keywords): Document that
a missing :group reuses the group from the preceding item (bug#21601).
2016-05-03 00:03:20 +02:00
Lars Ingebrigtsen
351c079cf6 Add some concept index entries for custom types
* doc/lispref/customize.texi (Composite Types): Add concept
index entries for restricted-sexp, radio and choice (bug#7385).

(cherry picked from commit 388bb723fa)
2016-05-01 19:27:07 +02:00
Glenn Morris
c51943d71d * lisp/custom.el (defcustom): Doc fix.
* doc/lispref/customize.texi (Variable Definitions):
Defcustom should always have a type.
2016-01-28 17:45:50 -05:00
Paul Eggert
0e963201d0 Update copyright year to 2016
Run admin/update-copyright.
2016-01-01 01:34:24 -08:00
Paul Eggert
ef7dbdf587 Quote less in manuals
The manuals often used quotes ``...'' when it is better to use @dfn or
@code or capitalized words or no quoting at all.  For example, there is
no need for the `` and '' in “if a variable has one effect for
@code{nil} values and another effect for ``non-@code{nil}'' values”.
Reword the Emacs, Lisp intro, and Lisp reference manuals to eliminate
unnecessary quoting like this, and to use @dfn etc. instead when called
for (Bug#21472).
2015-09-15 08:48:44 -07:00
Paul Eggert
a2940cd43e Minor quoting etc. fixes to lispref manual
* doc/lispref/tips.texi (Documentation Tips):
Distinguish more clearly among grave accent, apostrophe,
and single quote.
* doc/lispref/README, doc/lispref/buffers.texi:
* doc/lispref/commands.texi, doc/lispref/control.texi:
* doc/lispref/customize.texi, doc/lispref/display.texi:
* doc/lispref/elisp.texi, doc/lispref/files.texi:
* doc/lispref/frames.texi, doc/lispref/hash.texi:
* doc/lispref/help.texi, doc/lispref/internals.texi:
* doc/lispref/loading.texi, doc/lispref/makefile.w32-in:
* doc/lispref/markers.texi, doc/lispref/modes.texi:
* doc/lispref/nonascii.texi, doc/lispref/objects.texi:
* doc/lispref/os.texi, doc/lispref/positions.texi:
* doc/lispref/strings.texi, doc/lispref/syntax.texi:
* doc/lispref/text.texi, doc/lispref/tips.texi:
* doc/lispref/two-volume-cross-refs.txt, doc/lispref/windows.texi:
Use American-style double quoting in ordinary text,
and quote 'like this' when single-quoting in ASCII text.
Also, fix some minor spacing issues.
2015-04-10 11:28:52 -07:00
Paul Eggert
7e09ef09a4 Update copyright year to 2015
Run admin/update-copyright.
2015-01-01 14:26:41 -08:00
Eli Zaretskii
20cfd2480d Improve indexing on the chapter/section/subsection levels.
doc/lispref/windows.texi (Recombining Windows): Index subject of sections.
 doc/lispref/variables.texi (Variables with Restricted Values)
 (Generalized Variables): Index subject of sections.
 doc/lispref/text.texi (Buffer Contents, Examining Properties)
 (Changing Properties, Property Search, Substitution): Index
 subject of sections.
 doc/lispref/syntax.texi (Motion and Syntax, Parsing Expressions)
 (Motion via Parsing, Position Parse, Control Parsing): Index
 subject of sections.
 doc/lispref/strings.texi (Predicates for Strings, Creating Strings)
 (Modifying Strings, Text Comparison): Index subject of sections.
 doc/lispref/searching.texi (Syntax of Regexps, Regexp Special)
 (Regexp Functions, Regexp Functions): Index subject of sections.
 doc/lispref/processes.texi (Subprocess Creation, Process Information): Index
 subject of sections.
 doc/lispref/positions.texi (Screen Lines): Index subject of sections.
 doc/lispref/nonascii.texi (Scanning Charsets, Specifying Coding Systems):
 Index subject of sections.
 doc/lispref/minibuf.texi (Text from Minibuffer, Object from Minibuffer)
 (Multiple Queries, Minibuffer Contents): Index subject of
 sections.
 doc/lispref/markers.texi (Predicates on Markers, Creating Markers)
 (Information from Markers, Moving Markers): Index subject of
 sections.
 doc/lispref/macros.texi (Defining Macros, Problems with Macros): Index
 subject of sections.
 doc/lispref/loading.texi (Loading Non-ASCII, Where Defined): Index subject
 of sections.
 doc/lispref/lists.texi (List-related Predicates, List Variables, Setcar)
 (Setcdr, Plist Access): Index subject of sections.
 doc/lispref/keymaps.texi (Controlling Active Maps, Scanning Keymaps)
 (Modifying Menus): Index subject of sections.
 doc/lispref/help.texi (Accessing Documentation, Help Functions): Index
 subject of sections.
 doc/lispref/hash.texi (Hash Access): Index subject of sections.
 doc/lispref/functions.texi (Core Advising Primitives)
 (Advising Named Functions, Porting old advices): Index subject of
 sections.
 doc/lispref/frames.texi (Creating Frames, Initial Parameters)
 (Position Parameters, Buffer Parameters, Minibuffers and Frames)
 (Pop-Up Menus, Drag and Drop): Index subject of sections.
 doc/lispref/files.texi (Visiting Functions, Kinds of Files)
 (Unique File Names): Index subject of sections.
 doc/lispref/display.texi (Refresh Screen, Echo Area Customization)
 (Warning Variables, Warning Options, Delayed Warnings)
 (Temporary Displays, Managing Overlays, Overlay Properties)
 (Finding Overlays, Size of Displayed Text, Defining Faces)
 (Attribute Functions, Displaying Faces, Face Remapping)
 (Basic Faces, Font Lookup, Fontsets, Replacing Specs)
 (Defining Images, Showing Images): Index subject of sections.
 doc/lispref/debugging.texi (Debugging, Explicit Debug)
 (Invoking the Debugger, Excess Open, Excess Close): Index subject
 of sections.
 doc/lispref/customize.texi (Defining New Types, Applying Customizations)
 (Custom Themes): Index subject of sections.
 doc/lispref/control.texi (Sequencing, Combining Conditions)
 (Processing of Errors, Cleanups): Index subject of sections.
 doc/lispref/compile.texi (Eval During Compile): Index subject of sections.
 doc/lispref/commands.texi (Using Interactive, Distinguish Interactive)
 (Command Loop Info, Classifying Events, Event Mod)
 (Invoking the Input Method): Index subject of sections.
 doc/lispref/buffers.texi (Buffer List, Buffer Gap): Index subject of sections.
 doc/lispref/backups.texi (Making Backups, Numbered Backups, Backup Names)
 (Reverting): Index subject of sections.
 doc/lispref/abbrevs.texi (Abbrev Tables, Defining Abbrevs, Abbrev Files)
 (Abbrev Expansion, Standard Abbrev Tables, Abbrev Properties)
 (Abbrev Table Properties): Index subject of sections.
 doc/lispref/os.texi (Time of Day, Time Conversion, Time Parsing)
 (Time Calculations, Idle Timers): Index subject of sections.
2014-12-23 20:42:30 +02:00
Juanma Barranquero
6b88e570d8 Recommend not modifying :set's value arg in defcustom (bug#16755).
* doc/lispref/customize.texi (Variable Definitions):
* lisp/custom.el (defcustom): Recommend avoiding
  destructive modification of the value argument of :set.
2014-03-19 00:31:17 +01:00
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
18874304db * customize.texi (Custom Themes): Document custom-known-themes.
* custom.el (custom-available-themes): Doc fix.

Fixes: debbugs:15717
2013-12-18 22:54:24 +08:00
Paul Eggert
0877d0dc24 Merge from emacs-24; up to 2012-12-06T01:39:03Z!monnier@iro.umontreal.ca 2013-01-02 08:13:04 -08:00
Paul Eggert
ab422c4d68 Update copyright notices for 2013. 2013-01-01 09:11:05 +00:00
Glenn Morris
22ff2cb8a4 Refer to "button" rather than "active field" in lispref
(cf 2005-12-22 change to doc/emacs/custom.texi)

* doc/lispref/customize.texi (Common Keywords, Type Keywords):
Replace "active field" with "button".

Fixes: debbugs:13310
2012-12-31 12:23:29 -08:00
Glenn Morris
9800c5b059 Add an xref, cindex to the lispref
* customize.texi (Common Keywords): Add xref. 
* tips.texi (Library Headers): Add cindex.

Fixes: debbugs:13311
2012-12-31 12:06:43 -08:00
Glenn Morris
a4b0cca119 Merge from emacs-24; up to 2012-12-01T13:25:13Z!cyd@gnu.org 2012-12-21 11:32:43 -08:00
Chong Yidong
6e55f03e36 * customize.texi (Simple Types): Document key-sequence type.
Fixes: debbugs:13048
2012-12-21 10:56:18 +08:00
Glenn Morris
265c2fbf11 Merge from emacs-24; up to 2012-11-26T19:56:14Z!monnier@iro.umontreal.ca 2012-12-09 18:00:42 -08:00
Glenn Morris
c6c08d3f8f Make eval-defun on a pre-defined defcustom call any :set function
* lisp/emacs-lisp/lisp-mode.el (eval-defun-1): Doc fix.
Respect a defcustom's :set function, if appropriate. 
(eval-defun): Doc fix.

* doc/lispref/customize.texi (Variable Definitions): Mention eval-defun
on a defcustom calls the :set function when appropriate.

* etc/NEWS: Mention this.

Fixes: debbugs:109
2012-12-08 17:04:43 -08:00
Stefan Monnier
1cbae532a0 * doc/lispref/customize.texi (Variable Definitions): Mention the default :group
for defcustoms.

Fixes: debbugs:13093
2012-12-06 13:26:11 -05: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
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
41b7f8bc6c Merge changes from emacs-24; up to 2012-04-26T02:03:19Z!ueno@unixuser.org 2012-06-17 13:13:40 +08:00
Chong Yidong
84f4a53180 More minor manual copyedits to fix 7x9 manual underfull/overfull hboxes.
* doc/emacs/emacs.texi: Remove urlcolor setting.

* doc/lispref/elisp.texi, vol1.texi, vol2.texi: Remove urlcolor setting.

* doc/lispref/vol2.texi: Include package.texi.
2012-06-11 14:48:47 +08: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
666b903b91 Merge from emacs-24; up to 2012-04-21T14:12:27Z!sdl.web@gmail.com 2012-05-08 20:06:08 -07:00
Glenn Morris
ddff335186 More small edits for doc/lispref
* control.texi: Where possible, use example rather than smallexample.
(Sequencing, Conditionals, Signaling Errors, Handling Errors):
Tweak page breaks.

* customize.texi: Where possible, use example rather than smallexample.
(Common Keywords, Variable Definitions, Applying Customizations)
(Custom Themes): Tweak page breaks.

* eval.texi, functions.texi, loading.texi, macros.texi:
Where possible, use example rather than smallexample.

* sequences.texi (Arrays): Tweak page breaks.

* symbols.texi: Where possible, use example rather than smallexample.
(Symbol Components): Fix typo.
(Other Plists): Tweak page break.
2012-05-04 20:37:30 -04: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
35dc09a19c Merge from emacs-24, up to 2012-04-10T02:06:19Z!larsi@gnus.org 2012-04-13 18:46:06 -07:00
Chong Yidong
03ed9e82ad * doc/lispref/customize.texi (Custom Themes): Also document load-theme etc. 2012-04-13 12:18:40 +08:00
Chong Yidong
81927dd2a4 New Lisp manual nodes, Applying Customizations and Custom Themes.
* doc/lispref/customize.texi (Applying Customizations):
(Custom Themes): New nodes.

* doc/lispref/display.texi (Defining Faces): Reference custom-set-faces.

* doc/lispref/modes.texi (Defining Minor Modes, Defining Minor Modes):
* doc/lispref/os.texi (Startup Summary): Copyedits.

* doc/emacs/custom.texi (Creating Custom Themes): Add reference to Custom
Themes node in Lisp manual.

* lisp/custom.el (custom-theme-set-variables): Doc fix.
2012-04-12 22:50:58 +08:00
Glenn Morris
2bb0eca1eb In doc/lispref, use @file for buffers, per the Texinfo manual.
It renders the same as @samp, so there is no visible change in most cases.
2012-04-10 00:11:23 -07:00
Chong Yidong
b4d3bc10dc Remove defining user variables via * in docstring.
* lisp/apropos.el (apropos-variable):
* lisp/files-x.el (read-file-local-variable):
* lisp/simple.el (set-variable):
* lisp/woman.el (woman-mini-help):
* lisp/emacs-lisp/byte-opt.el (side-effect-free-fns): Callers changed.

* lisp/custom.el (custom-variable-p): Return nil for non-symbol
arguments instead of signaling an error.
(user-variable-p): Obsolete alias for custom-variable-p.

* lisp/erc/erc.el (erc-cmd-SET): Call custom-variable-p instead of
user-variable-p.

* src/callint.c (Finteractive, Fcall_interactively):
* src/minibuf.c (Fread_variable): Callers changed.

* src/eval.c (Fuser_variable_p, user_variable_p_eh)
(lisp_indirect_variable): Functions deleted.
(Fdefvar): Caller changed.

* doc/lispref/commands.texi (Interactive Codes):
* doc/lispref/help.texi (Accessing Documentation):
* doc/lispref/minibuf.texi (High-Level Completion): Callers changed.

* doc/lispref/customize.texi (Variable Definitions): Remove user-variable-p.
2012-04-09 20:36:01 +08:00
Chong Yidong
e1161b06fc Update Customization chapter of Lisp manual.
* doc/lispref/customize.texi (Common Keywords): Minor clarifications.
Document custom-unlispify-remove-prefixes.
(Variable Definitions): Backquotes in defcustom seem to work fine
now.  Various other copyedits.
(Simple Types): Copyedits.  Document color selector.
(Composite Types): Copyedits.
(Splicing into Lists): Clarifications.
2012-02-05 22:27:06 +08:00
Chong Yidong
03988c98df Updates to Macros and Customization chapters of Lisp manual.
* doc/lispref/customize.texi (Common Keywords): Minor clarifications.
Document custom-unlispify-remove-prefixes.
(Variable Definitions): Backquotes in defcustom seem to work fine
now.  Various other copyedits.

* doc/lispref/macros.texi (Expansion): Minor clarification.
(Backquote): Move node to eval.texi.
(Defining Macros): Move an example from Backquote node.
(Argument Evaluation): No need to mention Pascal.
(Indenting Macros): Add xref to Defining Macros.

* doc/lispref/eval.texi (Backquote): Move from macros.texi.

* lisp/custom.el (defcustom): Doc fix.
2012-02-05 14:44:47 +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
acaf905b11 Add 2012 to FSF copyright years for Emacs files 2012-01-05 01:46:05 -08:00
Glenn Morris
322b7dab59 Merge from emacs-23; up to 2010-06-16T23:27:20Z!jay.p.belanger@gmail.com. 2011-07-05 19:42:10 -07:00
Chong Yidong
3deead93c4 * customize.texi (Composite Types): Move alist/plist from Simple Types (Bug#7545).
* elisp.texi (Top): Update menu description.
2011-07-02 20:45:24 -04:00
Lars Magne Ingebrigtsen
8a20ca4cb0 Clarify that SETFUNCTION is only used in the Customize user interface
(bug#6089).
2011-07-03 01:52:35 +02:00