1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-20 23:20:36 -08:00
Commit graph

6627 commits

Author SHA1 Message Date
Eli Zaretskii
936a8f3093 Document Emacs 26 behavior of Dired's 'Z' on directories
* doc/emacs/dired.texi (Operating on Files): Document behavior
of 'Z' on directories.

* etc/NEWS: Belatedly announce the new behavior of Dired's 'Z'
on directory names and on .tar.gz archives.
2018-11-16 10:19:22 +02:00
Eli Zaretskii
99f99a1fb2 ; Minor editing change in windows.texi
* doc/emacs/windows.texi (Window Convenience): Avoid breaking
line in the middle of a key sequence.
2018-11-16 09:54:56 +02:00
Eli Zaretskii
13bb665372 Fix a typo in the Emacs manual
* doc/emacs/rmail.texi (Rmail Deletion): Fix a typo.
Reported by Jorge P. de Morais Neto <jorge+list@disroot.org>
in emacs-manual-bugs@gnu.org
2018-11-15 21:59:32 +02:00
Markus Triska
edcd6b722c Small documentation correction.
* doc/lispref/windows.texi (Textual Scrolling): In the description of
scroll-up-aggressively, refer to scroll-down-aggressively instead of
a recursive reference to scroll-up-aggressively.  (Bug#33369)
2018-11-14 18:05:31 +02:00
Eli Zaretskii
8c2778a9fb Improve documentation of 'move-file-to-trash'
* doc/emacs/files.texi (Misc File Ops): Index
move-file-to-trash.  State that the way to restore trashed
files is system-dependent.
2018-11-10 22:22:39 +02:00
Charles A. Roelli
c7b8a51b79 ; * doc/lispref/functions.texi (Anonymous Functions): Fix typo. 2018-11-10 20:32:36 +01:00
Eli Zaretskii
a3242cc459 Improve documentation of Diff mode
* doc/emacs/files.texi (Diff Mode): Document the effect of
prefix argument on the Diff mode's commands.  Document
'diff-jump-to-old-file'.
2018-11-09 11:13:32 +02:00
Noam Postavsky
39e85a0c6c Note that lex bound lambda forms are not self-quoting (Bug#33199)
* doc/lispref/functions.texi (Anonymous Functions):
* lisp/subr.el (lambda): Note that under lexical binding a lambda form
yields a closure object (Bug#33199).
2018-11-08 20:13:56 -05:00
Martin Rudalics
fa605f242e Rewrite buffer display related doc-strings and doc
* lisp/window.el (display-buffer-overriding-action)
(display-buffer-alist, display-buffer-base-action)
(display-buffer-fallback-action, display-buffer-assq-regexp)
(display-buffer): Rewrite doc-strings using suggestions by
Alan Mackenzie <acm@muc.de>.
(display-buffer-use-some-frame): Adjust doc-string and
reformat code.
* doc/lispref/windows.texi (Buffer Display Action Alists):
Make docs on 'window-height', 'window-width' and
'preserve-size' entries more accurate.
2018-11-08 20:20:13 +01:00
Eli Zaretskii
6937c35d32 Improve recent changes in documentation of window handling
* doc/lispref/windows.texi (Displaying Buffers)
(Choosing Window, Buffer Display Action Functions)
(Buffer Display Action Alists, Choosing Window Options)
(Precedence of Action Functions, The Zen of Buffer Display):
Fix wording, punctuation, and markup.  Remove redundant
cross-references.

* doc/emacs/windows.texi (Window Choice, Temporary Displays):
Fix wording and punctuation.
2018-11-04 19:08:00 +02:00
Martin Rudalics
c04b48c088 Rewrite documentation of buffer display
* doc/emacs/windows.texi (Window Choice): Rewrite, replacing
references to older buffer display options with references to
and examples of buffer display actions.
(Temporary Displays): Rewrite display of *Completions*
example.

* doc/lispref/elisp.texi (Top): New Windows section
'Displaying Buffers'.
* doc/lispref/frames.texi (Child Frames): Adjust cross
reference.
* doc/lispref/windows.texi (Windows): New section 'Displaying
Buffers'.  Move sections 'Choosing Window', 'Display Action
Functions' and 'Choosing Window Options' there and adjust
namings.  Preferably write 'Buffer Display Action' instead of
'Display Action'.  More consistently use @w{} to make key
binding specifications unsplittable.
(Displaying Buffers): New section.
(Choosing Window): Make it a subsection of 'Displaying
Buffers'.  More explicitly describe how 'display-buffer'
compiles its list of action functions and the action alist.
(Buffer Display Action Functions): Rename from 'Display Action
Functions', make it a subsection of 'Displaying Buffers' and
rewrite it.  Elide more detailed descriptions of action alist
entries; these are now in the new section 'Buffer Display
Action Functions'.  Remove example.
(Buffer Display Action Alists): New subsection of 'Displaying
Buffers' giving a comprehensive description of recognized
action alist entries with appropriate indexing.  Contents were
partially moved here from the old 'Display Action Functions'
section.
(Choosing Window Options): Make it a subsection of 'Displaying
Buffers'.  Add examples of how to rewrite old buffer display
options with the help of buffer display actions.
(Precedence of Action Functions): New subsection of
'Displaying Buffers' explaining the execution order of action
functions with the help of a detailed example.
(The Zen of Buffer Display): New subsection of 'Displaying
Buffers' supplying guidelines on how to write and use buffer
display actions with examples.
(Side Windows, Displaying Buffers in Side Windows)
(Frame Layouts with Side Windows, Atomic Windows): Update
references to the 'Displaying Buffers' subsections.
2018-11-04 09:15:13 +01:00
Eli Zaretskii
7cadb32809 ; * doc/lispref/control.texi (pcase Macro): Fix another typo. 2018-11-03 19:37:54 +02:00
Eli Zaretskii
963f1d9584 ; * doc/lispref/control.texi (pcase Macro): Fix a typo. 2018-11-03 18:11:29 +02:00
Eli Zaretskii
e824c914da Improve documentation of destructuring-binding macros
* lisp/emacs-lisp/pcase.el (pcase-dolist, pcase-let)
(pcase-let*): Improve the doc strings.

* doc/lispref/sequences.texi (Sequence Functions): Improve
wording and rename arguments of seq-let to be more
descriptive.  Add a cross-reference to "Destructuring with
pcase Patterns".
* doc/lispref/control.texi (Pattern-Matching Conditional):
Improve wording and the menu.
(pcase Macro): Incorporate patch suggested by Paul Eggert
<eggert@cs.ucla.edu>.  Reformat text.
(Destructuring with pcase Patterns): Rename from
"Destructuring patterns", and improve wording and indexing.
2018-11-03 15:11:33 +02:00
Stefan Monnier
9962cf959f * doc/lispref/control.texi (Destructuring patterns): New subsection. 2018-10-31 15:34:45 -04:00
Eli Zaretskii
38f88a7f00 Document that generic functions cannot be commands
* doc/lispref/commands.texi (Defining Commands):
* doc/lispref/functions.texi (Generic Functions): Document
that generic functions cannot be turned into commands.
(Bug#33170)
2018-10-30 12:14:19 +02:00
Charles A. Roelli
10e0fd8ca9 Add index entries for more isearch commands/bindings (Bug#32990)
* doc/emacs/search.texi (Basic Isearch): Index isearch-exit,
isearch-abort, isearch-cancel, isearch-repeat-forward,
isearch-repeat-backward and their bindings.
(Repeat Isearch): Index isearch-ring-advance,
isearch-ring-retreat and isearch-edit-string.
(Special Isearch): Index isearch-quote-char,
isearch-char-by-name and their bindings.  Index
isearch-query-replace and isearch-query-replace-regexp, and
the latter's binding.  Explain what
isearch-query-replace-regexp does.  Index isearch-complete.
(Word Search): Index isearch-toggle-word.
2018-10-28 18:07:01 +01:00
Eli Zaretskii
d192c1671c Fix recent change in lispref/processes.texi.
* doc/lispref/processes.texi (Asynchronous Processes): Clarify
wording.  Suggested by Thomas Fitzsimmons <fitzsim@fitzsim.org>.
(Bug#33050)
2018-10-27 21:47:59 +03:00
Eli Zaretskii
9193db08de Improve documentation of 'process-connection-type'
* doc/lispref/processes.texi (Asynchronous Processes): Clarify
better when it is advisable to use pipes for communicating
with subprocesses.  (Bug#33050)
2018-10-27 13:18:33 +03:00
Eli Zaretskii
53ae90f493 Minor copyedits in cmdargs.texi
* doc/emacs/cmdargs.texi (Initial Options): Document '-nsl'.
Add a cross-reference to "Writing Dynamic Modules".
2018-10-27 11:40:33 +03:00
Eli Zaretskii
fc2e65ae82 Improve documentation of X resource loading
* doc/emacs/cmdargs.texi (Initial Options):
* doc/emacs/frames.texi (Frame Parameters):
* doc/emacs/xresources.texi (Resources): Document the
'--no-x-resources' command-line option and the fact that X
resources override .emacs settings of frame parameters.
(Bug#32975)
2018-10-27 11:24:53 +03:00
Charles A. Roelli
c3adbc88a0 Improve 'isearch-delete-char' documentation (Bug#32990)
* doc/emacs/search.texi (Basic Isearch): Index
'isearch-delete-char', its keybinding and the isearch "input
item" concept, and define the latter.
(Error in Isearch): Clarify the different uses of DEL and
C-M-w during isearch.

* lisp/isearch.el (isearch-delete-char): Correct its
documentation and link to the Info node '(emacs)Basic Isearch'
which explains less technically how this function works in
everyday usage.
2018-10-25 21:01:53 +02:00
Noam Postavsky
c97a5f1f44 * doc/misc/calc.texi (Summary): The +/- key is 'p', not 'P'. 2018-10-23 21:48:36 -04:00
Robert Pluim
2efd40076c Correct typo in GNU ELPA url
* doc/misc/efaq.texi (Packages that do not come with Emacs):
Correct typo in GNU ELPA url (Bug#33072).  Change other url
references to use https scheme.
2018-10-23 12:20:13 +02:00
Eli Zaretskii
6239016ca6 * doc/misc/dired-x.texi (Omitting Variables): Fix wording. (Bug#33112) 2018-10-22 08:47:18 +03:00
Eli Zaretskii
a4e40f6cb0 ; * doc/emacs/files.texi (Reverting): Improve wording in last change. 2018-10-19 11:58:53 +03:00
Mauro Aranda
f632ecbb99 Update revert-buffer documentation
* doc/emacs/files.texi (Reverting): Document that revert-buffer
does keep undo history.  (Bug#33084)

Copyright-paperwork-exempt: yes
2018-10-19 11:56:34 +03:00
Alan Mackenzie
73babba26a Clarify documentation of fractional vertical scrolling and some doc strings
* doc/lispref/windows.texi (vertical scrolling): Clarify the meaning of
vertical scrolling by referring to tall screen lines, images, and the display
action.  Clarify an ambiguous English tense.

* src/window.c (window-vscroll, set-window-vscroll): Amend doc strings to
refer to display.
2018-10-15 19:04:05 +00:00
Alan Mackenzie
700acbd991 doc/lispref/edebug.texi (Specification List) Remove obstrusive blank line 2018-10-14 18:22:23 +00:00
Eli Zaretskii
190245035f Fix wording in module API documentation
* doc/lispref/internals.texi (Module Functions): Fix confusing
wording.  Reported by Basil L. Contovounesios <contovob@tcd.ie>.
2018-10-14 19:12:49 +03:00
Eli Zaretskii
91c4c46fd5 Update the description of startup in ELisp manual
* doc/lispref/os.texi (Startup Summary): Remove stale
reference to window-system-initialization-alist.  Reported by
Zhang Haijun <ccsmile2008@outlook.com>.
2018-10-13 11:36:04 +03:00
Eli Zaretskii
d0eca49e3c ; * doc/emacs/mark.texi (Disabled Transient Mark): Fix last change. 2018-10-12 11:33:31 +03:00
Eli Zaretskii
af80b10612 Improve indexing of 'C-SPC C-SPC'
* doc/emacs/mark.texi (Disabled Transient Mark): Fix
indexing.  (Bug#32959)
2018-10-12 11:31:09 +03:00
Eli Zaretskii
89a73016f7 ; * doc/lispref/internals.texi (Writing Dynamic Modules): Fix a typo. 2018-10-11 21:48:10 +03:00
Eric Abrahamsen
a108eaa13c Fix bug with precious entries in Gnus registry
* lisp/registry.el (registry-collect-prune-candidates): This `cdr' was
  an error: it meant that the last key in the precious list, would be
  considered a nil. Since the precious list only contains the symbol
  'mark by default, marks were never considered precious.
* doc/misc/gnus.texi (Store arbitrary data): Fix typo: "marks" should
  be "mark".
2018-10-11 11:20:29 -07:00
Eli Zaretskii
ce8b4584a3 Document in the ELisp manual how to write loadable modules
* doc/lispref/internals.texi (Writing Dynamic Modules)
(Module Initialization, Module Functions, Module Values)
(Module Misc, Module Nonlocal): New nodes.
* doc/lispref/loading.texi (Dynamic Modules): Add
cross-reference to the new node.
* doc/lispref/internals.texi (GNU Emacs Internals):
* doc/lispref/elisp.texi (Top): Update menus for the new nodes.
2018-10-11 20:53:05 +03:00
Mauro Aranda
19f705c438 Fix typo in 'timerp' documentation
* doc/lispref/os.texi (Timers): Fix typo in 'timerp' documentation.
(Bug#32999)

Copyright-paperwork-exempt: yes
2018-10-10 06:27:03 +03:00
Charles A. Roelli
3f1470d96f * doc/emacs/mark.texi (Mark): Index "(de)activating the mark".
(Bug#32956)
2018-10-08 19:22:23 +02:00
Charles A. Roelli
ac3622c81a Improve documentation of 'read-hide-char'
* src/minibuf.c (syms_of_minibuf) <Vread_hide_char>: Clarify
documentation and mention where else the variable is used.
* doc/lispref/minibuf.texi (Reading a Password): Add an index
entry for 'read-hide-char'.
2018-10-03 20:00:13 +02:00
Noam Postavsky
cdca208932 Fix note about interactive advice (Bug#32905)
* doc/lispref/functions.texi (Core Advising Primitives): Add missing
':', and finish the sentence fragment.
2018-10-02 20:07:40 -04:00
Nicolas Goaziou
6a7a869c33 Org manual: Rewrite the Org Mobile section
* doc/misc/org.texi (Org Mobile): Rewritten from "MobileOrg" section.
Remove all references to non-free software.
Moved into "Miscellaneous", much like Org Crypt library. No longer an
appendix.
(Footnotes): Remove a reference to "MobileOrg".
(Bug#32722)
2018-09-30 14:40:14 +03:00
Eli Zaretskii
d309994aff Fix typos in documentation
* doc/misc/vhdl-mode.texi (Custom Indentation Functions):
* doc/misc/url.texi (Customization):
* doc/misc/tramp.texi (Overview):
* doc/misc/srecode.texi (Developing Template Functions):
* doc/misc/sieve.texi (Sieve Mode):
* doc/misc/reftex.texi (Options - Creating Citations):
* doc/misc/org.texi (Cooperation, Conflicts):
* doc/misc/gnus.texi (Misc Group Stuff):
* doc/misc/eshell.texi (Bugs and ideas):
* doc/misc/calc.texi (Summary):
* doc/man/emacsclient.1:
* doc/lispref/os.texi (Security Considerations):
* doc/lispref/control.texi (pcase Macro):
* CONTRIBUTE: Fix typos.  Reported by Mak Kolybabi
<mak@kolybabi.com>  (Bug#32853)
2018-09-27 18:48:06 +03:00
Stefan Monnier
dc7fdee08c * doc/emacs/kmacro.texi (Basic Keyboard Macro): Mention old bindings
According to Apple gospel, function keys are partly going the way of the dodo
so F3/F4 can, like in the good old days, be hard to reach for some users.
2018-09-24 14:58:11 -04:00
Eli Zaretskii
8b8a4c0aeb Improve documentation of directory-local variables
* lisp/files.el (hack-local-variables, normal-mode)
(after-find-file, find-file-hook): Mention directory-local
variables in the doc strings.  Suggested by Marcin Borkowski
<mbork@mbork.pl>.

* doc/emacs/custom.texi (File Variables, Directory Variables):
Clarify that directory-local variables are overridden by
file-local ones.
2018-09-22 12:06:51 +03:00
Eli Zaretskii
c9c9756d21 Don't use obsolete variable 'save-place' in documentation
* doc/lispref/customize.texi (Variable Definitions): Replace
example of saveplace defcustom with a fictitious one, which
will not bit-rot with time.  (Bug#32741)
2018-09-22 10:54:58 +03:00
Eli Zaretskii
d28d54c767 More accurate docs for 'text-char-description'
* src/keymap.c (Ftext_char_description):
* doc/lispref/help.texi (Describing Characters): More accurate
description of 'text-char-description'.  Remove incorrect
examples from the ELisp manual.  (Bug#32743)
2018-09-20 09:41:55 +03:00
Noam Postavsky
b3baf997c8 Document synchronous behavior of eshell/make (Bug#32513)
* doc/misc/eshell.texi (Built-ins):
* lisp/eshell/em-unix.el (eshell/make): Mention that it falls back to
the external 'make' command when called synchronously.
2018-09-19 18:57:37 -04:00
Eli Zaretskii
72a2a36654 Improve wording of last change in dired-x.texi
* doc/misc/dired-x.texi (Shell Command Guessing): Clarify
wording in description of 'dired-guess-shell-alist-user'.
Avoid passive tense.  (Bug#32733)
2018-09-19 10:08:03 +03:00
Eli Zaretskii
cc8f334d2d Document changes called out in NEWS
* doc/lispref/lists.texi (Association Lists): Document
'assoc-delete-all'.
* doc/lispref/minibuf.texi (Minibuffers): Adapt menu.
(Multiple Queries): Document 'read-answer'.

* etc/NEWS: Reflect the above documentation in the respective
entries.
2018-09-15 11:51:34 +03:00
Glenn Morris
24f240d51e Tiny doc updates re yum/dnf etc
* INSTALL: Mention dnf and Debian unversioned emacs package.
* doc/misc/efaq.texi (Installing Emacs): Mention dnf.
2018-09-14 08:54:28 -07:00