1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-18 10:16:51 +00:00
Commit Graph

1025 Commits

Author SHA1 Message Date
Martin Rudalics
fdaf534a7b Fix and rewrite doc on window recombining facilities.
* window.c (Fsplit_window_internal): Set combination limit of
new parent window to t iff Vwindow_combination_limit is t;
fixing a regression introduced with the change from 2012-09-22.
(Fwindow_combination_limit, Fset_window_combination_limit): Fix
doc-strings.

* elisp.texi (Top): Add Recombining Windows to menu.
* windows.texi (Recombining Windows): New subsection.
(Splitting Windows): Rewrite text on handling of window
combinations and move it to new subsection.
2012-11-07 10:41:52 +01: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
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
Chong Yidong
a9a3835c26 * frames.texi (Initial Parameters): Doc fix.
Fixes: debbugs:12144
2012-11-05 22:30:58 +08:00
Chong Yidong
2395ab64f6 Clarify documentation about escape sequences in strings.
* objects.texi (General Escape Syntax): Clarify the explanation of
escape sequences.
(Non-ASCII in Strings): Clarify when a string is unibyte vs
multibyte.  Hex escapes do not automatically make a string multibyte.
2012-11-03 19:02:43 +08:00
Martin Rudalics
43bcfda6d8 Doc changes related to displaying buffers and quitting windows.
* window.el (switch-to-visible-buffer)
(switch-to-buffer-preserve-window-point): Fix doc-strings.

* windows.texi (Switching Buffers): Document option
switch-to-buffer-preserve-window-point.
(Display Action Functions): Document window-height and
window-width alist entries.
(Display Action Functions): Document
display-buffer-below-selected and
display-buffer-in-previous-window.
(Quitting Windows): Document quit-restore-window.  Rewrite
section.
(Window Configurations): In window-state-get mention that
argument window must be valid.
(Window Parameters): Document quit-restore window parameter
(Bug#12158).
2012-11-03 11:47:03 +01:00
Glenn Morris
88390adf40 * doc/lispref/control.texi (Catch and Throw): Add xref to cl.texi. 2012-10-31 17:00:57 -04:00
Glenn Morris
aec5e6f9fe * doc/lispref/lists.texi (Sets And Lists): Point xref to better location. 2012-10-31 17:00:13 -04:00
Glenn Morris
0d8e94e928 Small lispref update for cl-lib namespace changes
* doc/lispref/errors.texi (Standard Errors):
* doc/lispref/loading.texi (Autoload): Update for cl-lib namespace changes.
2012-10-31 16:59:04 -04:00
Glenn Morris
5241598ae5 lispref xref update
* doc/lispref/modes.texi (Defining Minor Modes):
"Generalized Variables" section is now in this manual rather than cl.texi.
2012-10-31 16:56:55 -04:00
Glenn Morris
89b2c8a133 Lispref updates for some things no longer being special forms
* doc/lispref/eval.texi (Special Forms): No longer special forms:
defmacro, defun, save-window-excursion, with-output-to-temp-buffer.

* doc/lispref/functions.texi (Defining Functions): Defun is now a macro.
Defalias is a function.
2012-10-31 16:54:19 -04: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
Chong Yidong
e29e39c9c6 Document more Emacs 24.3 changes.
* frames.texi (Visibility of Frames): Document tty-top-frame.

* loading.texi (Autoload): Document autoloadp, autoload-do-load.

* symbols.texi (Symbol Plists): Document function-get.
2012-10-30 08:29:37 +08:00
Stefan Monnier
70edffb130 * lisp/tmm.el (tmm-prompt): Use map-keymap.
* doc/lispref/keymaps.texi (Format of Keymaps): Document the multiple
inheritance format.

Fixes: debbugs:12744
2012-10-28 10:56:51 -04:00
Martin Rudalics
3a51f0eb41 Reformulate description of windows basics. Describe changes in window ordering.
* windows.texi (Basic Windows): Reformulate description of live,
internal and valid windows.
(Cyclic Window Ordering): Describe new argument of
get-lru-window and get-largest-window.  Add description of
window-in-direction.
2012-10-28 13:56:15 +01: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
Glenn Morris
5b6887ad2a * doc/lispref/lists.texi (List Elements): Typo fix. 2012-10-27 15:07:43 -07:00
Chong Yidong
05b621a6b2 More Emacs 24.3 documentation updates.
* doc/emacs/building.texi (Compilation): Document compilation-always-kill.

* doc/emacs/files.texi (Misc File Ops): Symbolic links on Windows only work
on Vista and later.

* doc/emacs/frames.texi (Mouse Avoidance): Mention new variable
mouse-avoidance-banish-position.

* doc/emacs/mule.texi (Recognize Coding): Remove an unreferenced vindex.

* doc/emacs/package.texi (Package Menu): Document the "new" status.

* doc/emacs/programs.texi (Which Function): Which Function mode now works in
all major modes by default.

* doc/emacs/search.texi (Symbol Search): New node.

* doc/emacs/windows.texi (Window Choice): Don't refer to the obsolete
special-display feature.

* commands.texi (Event Input Misc): Remove last-input-char.
(Command Loop Info): Remove last-command-char.

* display.texi (Fringe Bitmaps): Add exclamation-mark bitmap.

* frames.texi (Initial Parameters): Don't mention the obsolete
special-display feature.

* hooks.texi (Standard Hooks): Remove obsolete hooks.

* markers.texi (Information from Markers): Remove obsolete
function buffer-has-markers-at.

* minibuf.texi (High-Level Completion): Don't mention removed
function iswitchb-read-buffer.

* text.texi (Yanking): Document yank-handled-properties.

* windows.texi (Choosing Window): Don't mention the obsolete
special display feature.
(Choosing Window Options): Remove obsolete special-display
variables, and the functions special-display-p and
special-display-popup-frame.

* subr.el (insert-buffer-substring-as-yank): Doc fix.
2012-10-27 13:03:52 +08:00
Chong Yidong
cd99601878 Document some Emacs 24.3 changes.
* doc/emacs/dired.texi (Dired Deletion, Marks vs Flags): Document Emacs 24.3
changes to the mark and unmark commands.
(Comparison in Dired): Document chages to dired-diff.  Remove M-=,
which is no longer bound to dired-backup-diff.

* doc/emacs/mule.texi (Text Coding): set-buffer-file-coding-system can now
be invoked from the mode line.

* lisp/dired.el (dired-mark, dired-unmark, dired-flag-file-deletion):
Doc fix.
2012-10-24 22:38:49 +08:00
Paul Eggert
72ec96fb41 Update manual for new time stamp format.
These instances were missed the first time around.
Problem reported by Glenn Morris in <http://bugs.gnu.org/12706#25>.
* doc/lispintro/emacs-lisp-intro.texi (Files List):
* doc/lispref/buffers.texi (Modification Time):
* doc/lispref/files.texi (Testing Accessibility, File Attributes):
* doc/lispref/intro.texi (Version Info):
* doc/lispref/os.texi (Time of Day):
* doc/misc/emacs-mime.texi (time-date): 
Update for new time stamp format (HIGH LOW MICROSEC PICOSEC).
* doc/misc/emacs-mime.texi (time-date): 
Also, fix bogus time stamp and modernize a bit.
2012-10-24 05:12:23 +00:00
Chong Yidong
75e8f9d2de Improve documentation of easy-menu-define.
* lisp/emacs-lisp/easymenu.el (easy-menu-define): Doc fix.

* doc/lispref/keymaps.texi (Toolkit Differences): Node deleted.
(Easy Menu): New node.

Fixes: debbugs:12628
2012-10-24 11:48:50 +08:00
Stefan Monnier
d106953274 Cleanup uses of "-hooks".
* doc/emacs/custom.texi (Hooks):
* doc/lispref/hooks.texi (Standard Hooks): Clarify that -hooks is deprecated.

* lisp/gnus/nndiary.el (nndiary-request-create-group-functions)
(nndiary-request-update-info-functions)
(nndiary-request-accept-article-functions):
* lisp/gnus/gnus-start.el (gnus-subscribe-newsgroup-functions):
* lisp/cedet/semantic/db-file.el (semanticdb-save-database-functions):
* lisp/cedet/semantic/lex.el (semantic-lex-reset-functions):
* lisp/cedet/semantic/edit.el (semantic-change-functions)
(semantic-edits-new-change-functions)
(semantic-edits-delete-change-functions)
(semantic-edits-reparse-change-functions):
* lisp/htmlfontify.el (hfy-post-html-hook):
* lisp/filesets.el (filesets-cache-fill-content-hook):
* lisp/arc-mode.el (archive-extract-hook):
* lisp/progmodes/cc-mode.el (c-prepare-bug-report-hook):
* lisp/net/rcirc.el (rcirc-sentinel-functions)
(rcirc-receive-message-functions, rcirc-activity-functions)
(rcirc-print-functions):
* lisp/net/dbus.el (dbus-event-error-functions):
* lisp/emacs-lisp/eieio.el (eieio-pre-method-execution-functions):
* lisp/emacs-lisp/checkdoc.el (checkdoc-style-functions)
(checkdoc-comment-style-functions): Don't use "-hooks" suffix.

* lisp/term/sun.el (sun-raw-prefix-hooks):
* lisp/mail/sendmail.el (mail-yank-hooks):
* lisp/mh-e/mh-letter.el (mh-yank-hooks): Use make-obsolete-variable.
2012-10-23 11:06:07 -04:00
Paul Eggert
c4132fd4f0 Fix outdated timestamp documentation in Elisp manual.
* doc/lispref/files.texi (File Attributes):
* doc/lispref/text.texi (Undo):
Time stamp resolution is now 1 picosecond, not 1 second.
* etc/NEWS: Document increased precision in undo list.

Fixes: debbugs:12706
2012-10-23 00:57:42 -07:00
Chong Yidong
49238e7f5c Make unused variable font-list-limit obsolete, and move it out of C.
* display.texi (Font Lookup): Remove font-list-limit.

* lisp/startup.el (command-line):
* lisp/cus-start.el: Don't refer to font-list-limit.

* lisp/faces.el (font-list-limit): Define as an obsolete variable.

* xfaces.c (Vfont_list_limit): Move unused variable to faces.el.
2012-10-23 10:39:13 +08:00
Chong Yidong
1fb3aa3fea * doc/lispref/keymaps.texi (Key Sequences): Avoid referring to Edit Macro mode.
* doc/emacs/kmacro.texi (Edit Keyboard Macro): Fix typo.

Fixes: debbugs:12529
2012-10-23 10:23:39 +08:00
Glenn Morris
f961c7d82b * doc/lispref/os.texi (Recording Input): Tiny fix. 2012-10-22 17:57:14 -04:00
Glenn Morris
4ee8774065 Refer to cl-lib rather than cl in lispref
* intro.texi (Lisp History):
* lists.texi (Sets And Lists): Refer to cl-lib rather than cl.
2012-10-21 19:22:27 -07:00
Glenn Morris
5fb904b0e4 * doc/lispref/tips.texi (Coding Conventions): Recommend cl-lib over cl. 2012-10-21 19:18:58 -07:00
Chong Yidong
d18a0d2460 More documentation fixes for changes to defun, defmacro, etc.
* doc/lispref/functions.texi (Anonymous Functions): Explicitly list the
docstring, declare, and interactive arguments to lambda.
(Defining Functions): Likewise for defun.
(Inline Functions): Likewise for defsubst.
(Declare Form): Tweak description.

* doc/lispref/macros.texi (Defining Macros):  defmacro is now a macro.
Explicitly list the docstring and declare arguments.

* emacs-lisp/byte-run.el (defsubst): Doc fix.
2012-10-15 12:03:04 +08:00
Chong Yidong
73f2b4abf5 Document 24.3 ImageMagick changes.
* doc/emacs/files.texi (File Conveniences): ImageMagick enabled by default.

* doc/lispref/display.texi (ImageMagick Images): ImageMagick enabled by default.
2012-10-13 09:18:52 +08:00
Dani Moncayo
d8e213ebe3 * doc/emacs/basic.texi (Arguments): Fix typos.
Also, remove "tiny change" tags from ChangeLogs; Dani Moncayo now has
a copyright assignment.
2012-10-10 10:52:55 +08:00
Chong Yidong
379acb9514 * minibuf.texi (Basic Completion): Clarify list form of completion table.
Fixes: debbugs:12564
2012-10-05 15:48:25 +08:00
Glenn Morris
e8757f091a Merge from emacs-24; up to 2012-05-08T14:11:47Z!monnier@iro.umontreal.ca 2012-10-05 00:38:05 -07:00
Bruno Félix Rezende Ribeiro
26026637d3 * doc/lispref/functions.texi (Function Safety): Copyedit (tiny change)
Fixes: debbugs:12562
2012-10-03 00:25:17 -07:00
Paul Eggert
86ec63ba30 Revert the FOLLOW-SYMLINKS change for file-attributes. 2012-09-30 19:07:14 -07:00
Paul Eggert
e7a2937b11 file-attributes has a new optional arg FOLLOW-SYMLINKS.
* doc/lispref/files.texi (File Attributes): Describe it.
(Magic File Names): Use it.
* etc/NEWS: Document the change.
* lisp/files.el (remote-file-name-inhibit-cache):
* lisp/time.el (display-time-file-nonempty-p): Use it.
* lisp/files.el (after-find-file): Don't chase links before calling
file-exists-p, as file-exists-p already does the right thing.
* src/dired.c (directory_files_internal, Ffile_attributes):
New arg follow_symlinks.  All uses changed.
2012-09-30 14:12:04 -07:00
Chong Yidong
48de8b1221 Update docs for a bunch of 24.3 changes.
* doc/emacs/killing.texi (Rectangles): Document copy-rectangle-as-kill.

* doc/emacs/search.texi (Special Isearch): Document the lax space search
feature and M-s SPC.
(Regexp Search): Move main search-whitespace-regexp description to
Special Isearch.
(Replace): Document replace-lax-whitespace.

* doc/emacs/basic.texi (Position Info): Document C-u M-=.
(Moving Point): Document move-to-column.

* doc/emacs/display.texi (Useless Whitespace): Add delete-trailing-lines.

* doc/emacs/misc.texi (emacsclient Options): Document the effect of
initial-buffer-choice on client frames.  Document server-auth-dir.
Do not document server-host, which is bad security practice.

* doc/emacs/building.texi (Lisp Libraries): Docstring lookups can trigger
autoloading.  Document help-enable-auto-load.

* doc/emacs/mini.texi (Yes or No Prompts): New node.

* doc/emacs/ack.texi (Acknowledgments): Remove obsolete packages.

* doc/lispref/commands.texi (Click Events): Define "mouse position list".
Remove mention of unimplemented horizontal scroll bars.
(Drag Events, Motion Events): Refer to "mouse position list".
(Accessing Mouse): Document posnp.

* doc/lispref/errors.texi (Standard Errors): Tweak arith-error description.
Tweak markup.  Remove domain-error and friends, which seem to be
unused after the floating-point code revamp.

* doc/lispref/functions.texi (Obsolete Functions): Obsolescence also affects
documentation commands.  Various clarifications.
(Declare Form): New node.

* doc/lispref/loading.texi (Autoload):
* doc/lispref/help.texi (Documentation Basics): The special sequences can
trigger autoloading.

* doc/lispref/macros.texi (Defining Macros): Move description of `declare' to
Declare Form node.

* doc/lispref/numbers.texi (Integer Basics): Copyedits.
(Float Basics): Consider IEEE floating point always available.
(Random Numbers): Document actual limits.
(Arithmetic Operations): Clarify division by zero.  Don't mention
the machine-independence of negative division since it does not
happen in practice.

* doc/lispref/os.texi (Idle Timers): Minor clarifications.
(User Identification): Add system-users and system-groups.

* doc/lispref/strings.texi (String Basics): Copyedits.

* lisp/minibuffer.el (minibuffer-local-filename-syntax): Doc fix.

* lisp/server.el (server-host): Document the security implications.
(server-auth-key): Doc fix.

* lisp/startup.el (initial-buffer-choice): Doc fix.

* src/fns.c (Frandom): Doc fix.
2012-09-30 17:18:38 +08:00
Glenn Morris
e61d39cddf Merge from emacs-24; up to 2012-05-07T21:26:08Z!rgm@gnu.org 2012-09-28 09:02:31 -07:00
Leo Liu
03922966f3 Fix typo in files.texi 2012-09-25 22:40:20 +08:00
Chong Yidong
e109c4a651 Doc updates for read-only-mode.
* buffers.texi (Misc Buffer): Replace toggle-read-only with
read-only-mode.

* files.texi (Visiting): Likewise.

* backups.texi (Auto-Saving): Refer to Minor Mode Conventions for
calling conventions.

* buffers.texi (Read Only Buffers): Document read-only-mode.

* keymaps.texi (Alias Menu Items): Replace toggle-read-only with
read-only-mode.
2012-09-23 18:46:50 +08:00
Chong Yidong
c88b867fec Misc doc fixes.
* searching.texi (Replacing Match): Minor clarification.

* lisp/repeat.el (repeat): Doc fix.

* lisp/simple.el (shell-command-on-region): Doc fix.

* lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc fix.

* cmds.c (Fforward_char, Fbackward_char): Doc fix.

* editfns.c (Fline_beginning_position): Doc fix.
(Fline_end_position): Doc fix.

* minibuf.c (Finternal_complete_buffer): Doc fix.

* search.c (Freplace_match): Doc fix.

Fixes: debbugs:12325 debbugs:12391 debbugs:12416 debbugs:12414 debbugs:10909 debbugs:12348
2012-09-22 23:24:26 +08:00
Eli Zaretskii
287d74553b edebug.texi (Instrumenting): Improve indexing. 2012-09-22 16:24:58 +03:00
Eli Zaretskii
df9685f396 Fix bugs #12447 and #12326 with infloop causes by idle timers, update docs.
src/keyboard.c (timer_check_2): Move calculation of 'timers' and
 'idle_timers' from here ...
 (timer_check): ... to here.  Use Fcopy_sequence to copy the timer
 lists, to avoid infloops when the timer does something stupid,
 like reinvoke itself with the same or smaller time-out.

 lisp/emacs-lisp/timer.el (run-with-idle-timer)
 (timer-activate-when-idle): Warn against reinvoking an idle timer
 from within its own timer action.

 doc/lispref/os.texi (Idle Timers): Warn against reinvoking an idle timer
 from within its own timer action.
2012-09-22 16:16:03 +03:00
Chong Yidong
471333800d * frames.texi (Pop-Up Menus): Minor clarification for x-popup-menu.
Fixes: debbugs:11148
2012-09-22 11:29:37 +08:00
Glenn Morris
ab199df27b ChangeLog date fix 2012-09-20 20:22:27 -07:00
Chong Yidong
acfa068f4a Merge from emacs-24; up to 2012-05-07T14:57:18Z!michael.albinus@gmx.de 2012-09-21 11:03:48 +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
Glenn Morris
1bfe31778b * doc/lispref/debugging.texi (Using Debugger): Fix typo. 2012-09-11 22:18:43 -04:00