1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-04-28 01:00:52 -07:00
Commit graph

7886 commits

Author SHA1 Message Date
Juri Linkov
ba6104d1e8 Change doc-view-mode-map prefix key 's' to 'c'.
* doc/emacs/misc.texi (DocView Slicing): Change prefix key 's' to 'c'.

* lisp/doc-view.el (doc-view-mode-map): Change prefix key 's' to 'c'.

* lisp/image-mode.el (image-mode-map): Add image-transform-set-scale to menu.

* doc/emacs/files.texi (Image Mode): Describe commands
image-transform-fit-both, image-transform-set-scale, image-transform-reset.

* etc/NEWS: Rearrange image sections.

https://lists.gnu.org/archive/html/emacs-devel/2020-04/msg01315.html
2020-04-23 02:14:42 +03:00
Paul Eggert
400ff5cd19 Improve wording about constants
Thanks to Štěpán Němec and Drew Adams for reviews of recent changes.
* doc/lispref/eval.texi (Quoting): Give an example.
* doc/lispref/lists.texi (Association Lists): Simplify example code.
* doc/lispref/objects.texi (Lisp Data Types)
(Constants and Mutability): Clarify wording.
2020-04-22 10:43:46 -07:00
Eli Zaretskii
fc55f65305 Minor improvements in documentation of the last change
* etc/NEWS:
* doc/emacs/files.texi (Image Mode): Minor copyedits of last change.
2020-04-21 16:50:13 +03:00
Juri Linkov
a64da75961 Add image-auto-resize defcustoms to image-mode.el
* lisp/image-mode.el (image-auto-resize)
(image-auto-resize-on-window-resize): New defcustoms.
(image-mode-map): Bind "sb" to image-transform-fit-both.
(image-mode): Set image-transform-resize to image-auto-resize initially.
(image-mode--setup-mode): Add hook on image-auto-resize-on-window-resize.
(image-toggle-display-image): Check if image-transform-resize is t.
(image-transform-properties): Check image-transform-resize for nil and t.
(image-transform-fit-both): New command.
(image-transform-reset): Reset image-transform-resize to image-auto-resize.

* doc/emacs/files.texi (Image Mode): Mention image-auto-resize and
image-auto-resize-on-window-resize.

https://lists.gnu.org/archive/html/emacs-devel/2020-04/msg01160.html
2020-04-21 02:42:16 +03:00
Juri Linkov
692ad40539 Improve the documentation of tab-bar and tab-line
* doc/emacs/frames.texi (Tab Bars): Add xref to "Tab Line".
Document more commands.

* doc/emacs/windows.texi (Windows):
* doc/emacs/emacs.texi (Top): Add "Tab Line" menu.

* doc/emacs/windows.texi (Window Convenience):
Move tab-line documentation to new node "Tab Line".
(Tab Line): New node.

* doc/emacs/glossary.texi (Glossary):
* doc/emacs/modes.texi (Minor Modes):
* doc/emacs/display.texi (Standard Faces): Add xref to "Tab Line".
2020-04-21 02:23:35 +03:00
Paul Eggert
05089a4d65 Tweak wording re constant variables
* doc/lispref/objects.texi (Constants and Mutability): Tweak.
Problem reported by Michael Heerdegen (Bug#40693#44).
2020-04-19 19:53:40 -07:00
Paul Eggert
a1040861f1 Tweak setcar-related wording
* doc/lispref/eval.texi (Self-Evaluating Forms):
Change “primitives” to “operations”.
Problem reported by Štěpán Němec in:
https://lists.gnu.org/r/emacs-devel/2020-04/msg01146.html
2020-04-19 16:47:17 -07:00
Juri Linkov
9261a219ec * doc/emacs/windows.texi (Window Convenience): Decribe more windmove features.
* doc/emacs/windows.texi (Window Convenience): Add descriptions of
windmove-display-default-keybindings,
windmove-delete-default-keybindings,
windmove-swap-states-in-direction.

* etc/NEWS: Regroup to move some parts closer to related sections.
2020-04-20 01:57:32 +03:00
Paul Eggert
e1d42da0d6 Fix mutability glitches reported by Drew Adams
See Bug#40693#32.
* doc/lispref/eval.texi (Self-Evaluating Forms, Backquote):
Say that these yield constant conses, vectors and strings,
not constant symbols.
* doc/lispref/objects.texi (Constants and Mutability): Say that an
attempt to modify a constant variable signals an error, instead of
saying that it has undefined behavior.
2020-04-19 15:12:05 -07:00
Paul Eggert
5805df74f5 Improve mutability doc
See Eli Zaretskii’s suggestions (Bug#40671#33).
* doc/lispref/lists.texi (Setcar, Setcdr, Rearrangement):
* doc/lispref/sequences.texi (Sequence Functions)
(Array Functions):
Add commentary to examples.
* doc/lispref/lists.texi (Sets And Lists):
Revert change to delq example.
2020-04-19 13:29:57 -07:00
Paul Eggert
dca35b31d0 Improve mutability documentation
This change was inspired by comments from Štěpán Němec in:
https://lists.gnu.org/r/emacs-devel/2020-04/msg01063.html
* doc/lispref/objects.texi (Lisp Data Types): Mention mutability.
(Constants and mutability): New section.
* doc/lispintro/emacs-lisp-intro.texi (Lists diagrammed)
(Indent Tabs Mode): Improve wording.
* doc/lispref/eval.texi (Self-Evaluating Forms):
Say that they return constants.
* doc/lispref/lists.texi (Sets And Lists):
Fix memql mistake/confusion that I recently introduced.
2020-04-19 13:29:57 -07:00
Paul Eggert
81e7d7f111 Document that quoting yields constants
* doc/lispref/eval.texi (Quoting, Backquote):
Mention that quoted expressions yield a constant (Bug#40693).
2020-04-19 13:29:57 -07:00
Stefan Monnier
5734339f40 * doc/lispref/keymaps.texi (Extended Menu Items, Easy Menu) <:key-sequence>:
Clarify the documentation further
2020-04-19 11:19:03 -04:00
Mattias Engdegård
14a570afae Remove #' and function quoting from lambda forms in manual
* doc/lispref/abbrevs.texi (Abbrev Expansion):
* doc/lispref/backups.texi (Reverting):
* doc/lispref/functions.texi (Mapping Functions):
* doc/lispref/help.texi (Accessing Documentation):
* doc/lispref/sequences.texi (Char-Tables):
* doc/lispref/syntax.texi (Categories):
* doc/lispref/text.texi (Sorting):
Remove function quoting from lambda in examples where it still occurs,
since examples should follow our best style and be consistent.
2020-04-19 13:19:37 +02:00
Juri Linkov
4df8a61117 Add new node "Image Mode" to Emacs Manual.
* doc/emacs/dired.texi (Image-Dired): Add xref to "Image Mode".

* doc/emacs/emacs.texi (Top): Add new node "Image Mode" to menu.

* doc/emacs/files.texi (Files): Add new node "Image Mode" to menu.
(File Conveniences): Split part of node to new node "Image Mode".

* doc/emacs/frames.texi (Mouse Commands): Add xref to "Image Mode".

* doc/emacs/misc.texi (Embedded WebKit Widgets): Rename xref from
"File Conveniences" to "Image Mode".
2020-04-19 02:43:06 +03:00
Štěpán Němec
d7d5ee6c57 ; Fix a typo in cmdargs.texi (bug#40701) 2020-04-18 23:28:40 +02:00
Paul Eggert
5e9db48fbe * doc/lispref/display.texi (Customizing Bitmaps): Fix typo. 2020-04-18 13:01:08 -07:00
Paul Eggert
eebfb72c90 Document constant vs mutable objects better
This patch builds on a suggested patch by Mattias Engdegård
and on further comments by Eli Zaretskii.
Original bug report by Kevin Vigouroux (Bug#40671).
* doc/lispintro/emacs-lisp-intro.texi (set & setq, Review)
(setcar, Lists diagrammed, Mail Aliases, Indent Tabs Mode):
setq is a special form, not a function or command.
* doc/lispintro/emacs-lisp-intro.texi (setcar):
* doc/lispref/lists.texi (Modifying Lists, Rearrangement):
* doc/lispref/sequences.texi (Sequence Functions)
(Array Functions, Vectors):
* doc/lispref/strings.texi (String Basics, Modifying Strings):
Mention mutable vs constant objects.
* doc/lispintro/emacs-lisp-intro.texi (setcar, setcdr)
(kill-new function, cons & search-fwd Review):
* doc/lispref/edebug.texi (Printing in Edebug):
* doc/lispref/keymaps.texi (Changing Key Bindings):
* doc/lispref/lists.texi (Setcar, Setcdr, Rearrangement)
(Sets And Lists, Association Lists, Plist Access):
* doc/lispref/sequences.texi (Sequence Functions)
(Array Functions):
* doc/lispref/strings.texi (Text Comparison):
Fix examples so that they do not try to change constants.
2020-04-18 13:01:08 -07:00
Štěpán Němec
52288f4b66 Mention 'spam-stat-process-directory-age' in the documentation
I was at a loss as to why my attempt to set up spam-stat seemed to
have no effect, only to find (digging in the code) that it was
ignoring most of the sample files due to this undocumented variable.

* doc/misc/gnus.texi (Creating a spam-stat dictionary): Document
the variable 'spam-stat-process-directory-age'.  (bug#39780)
2020-04-18 17:13:02 +02:00
Štěpán Němec
067b070598 ; Fix some typos and doc issues (bug#40695) 2020-04-18 17:10:02 +02:00
Eli Zaretskii
175c61c18b Fix "C-u M-!" when 'shell-command-dont-erase-buffer' is non-nil
* lisp/simple.el (shell-command-dont-erase-buffer): Clarify the
effect of the various values in the doc string.
(shell-command-save-pos-or-erase, shell-command): Don't move or
push point if the output will go to the current buffer.
(Bug#40690)
(shell-command): Mention 'shell-command-dont-erase-buffer' in the
doc string.

* test/lisp/simple-tests.el
(with-shell-command-dont-erase-buffer): Don't is shell quoting
'like this', as it doesn't work on MS-Windows; quote "like this"
instead.
(simple-tests-shell-command-dont-erase-buffer): Adapt the test to
the new modus operandi.

* doc/emacs/misc.texi (Single Shell): Document the effect of the
various values of 'shell-command-dont-erase-buffer'.

* etc/NEWS: Expand and reword the entry regarding changes in
'shell-command-dont-erase-buffer'.
2020-04-18 12:01:26 +03:00
Paul Eggert
6b297519b5 Fix cl-most-positive-float doc typo
* doc/misc/cl.texi (Implementation Parameters):
Fix typo in documentation of cl-most-positive-float.
2020-04-17 09:38:41 -07:00
Eli Zaretskii
fb5f616ae8 Improve an example in w32 FAQ
* doc/misc/efaq-w32.texi (Font names): Modify the expression to
insert a lits of all installed fonts so as to avoid producing too
long lines.  Suggested by ndame <ndame@protonmail.com>.
2020-04-15 20:27:12 +03:00
Martin Rudalics
e5ca8e5e73 Fix Elisp manual entry on 'set-window-configuration'
* doc/lispref/windows.texi (Window Configurations): Fix
description of 'set-window-configuration'.
2020-04-15 10:18:15 +02:00
Štěpán Němec
f84aed5fd2 Clarify documentation on inhibit-modification-hooks intended usage
Cf. bug#40332 and the discussion at
https://lists.gnu.org/archive/html/emacs-devel/2020-03/msg00921.html

* doc/lispref/text.texi (Change Hooks):
* src/insdel.c (syms_of_insdel): Clarify the intended usage of
'inhibit-modification-hooks'.
2020-04-13 12:15:13 +02:00
Eli Zaretskii
1dfc497fac Minor wording change in Introduction to Programming in Emacs Lisp
* doc/lispintro/emacs-lisp-intro.texi (Prevent confusion): Mention
that dynamic scoping is only the default in Emacs Lisp, not the
only scoping rule.  (Bug#40594)
2020-04-13 11:53:47 +03:00
Eli Zaretskii
63e8d0ea87 Fix last changes describing mail commands
* doc/emacs/sending.texi (Sending Mail): Fix the description of
the behavior of 'C-x m' without prefix argument.  (Bug#40561)
2020-04-12 21:47:52 +03:00
Eli Zaretskii
3f9310b0fe Fix and improve documentation of mail-related features
* lisp/simple.el (compose-mail): Clarify the effect of the
CONTINUE argument.
* lisp/mail/sendmail.el (mail-from-style): Update the RFC value in
the obsolescence warning text.

* doc/emacs/sending.texi (Sending Mail): Fix the description of
the behavior of 'C-x m' wrt prefix argument.
(Mail Headers): Remove the description of 'mail-from-style'.

* etc/NEWS: Mention that 'mail-from-style' is obsolete.

(Bug#40561)
2020-04-12 11:31:29 +03:00
Alan Mackenzie
cf57663f2a Mention jit-lock deferred as an alternative to fast-but-imprecise-scrolling
* doc/emacs/display.texi (Scrolling): Add a paragraph on using jit-lock
deferred fontification as a way of obviating Emacs hanging after
auto-repeated scrolling.
2020-04-11 21:04:50 +00:00
Eli Zaretskii
fd27685c1e ; * doc/lispref/keymaps.texi (Extended Menu Items): Fix last change. 2020-04-11 09:40:37 +03:00
Stefan Monnier
6057d79a4e * doc/lispref/keymaps.texi (Extended Menu Items): Tweak :key-sequence
Don't make it sound like `:key-sequence nil` is any different than the
absence of `:key-sequence`.  And the performance advantage of
`:key-sequence` disappeared long ago.
2020-04-10 17:04:19 -04:00
Michael Albinus
36c42d2a30 * doc/misc/tramp.texi (Bug Reports): Avoid line breaks in traces. 2020-04-09 15:55:32 +02:00
Eli Zaretskii
18d1bc0a09 Improve documentation of 'jit-lock-contextually'
* lisp/jit-lock.el (jit-lock-contextually): Clarify the jit-lock
operation when 'jit-lock-contextually' is non-nil and non-t.

* doc/lispref/modes.texi (Syntactic Font Lock)
(Other Font Lock Variables): Document the relation between
'jit-lock-register', 'font-lock-keywords-only', and syntactic
refontification.
2020-04-08 18:33:52 +03:00
Philipp Stephani
6de20c7eab Fix syntax error in man page.
* doc/man/emacs.1.in: Fix syntax of --script argument.  The Info
manual states that --script has to be followed by a space, and the
syntax with the equals sign doesn't actually work.
2020-04-05 10:19:31 +02:00
Michael Albinus
02b3820315 Document how to disable Tramp file archives
* doc/misc/tramp.texi (Archive file names): Explain how to disable
file archives.
2020-03-25 19:24:06 +01:00
Eli Zaretskii
561e9fb91b Improve documentation of project.el commands
* lisp/progmodes/project.el (project-find-regexp): Require 'grep'
to be able to call 'grep-read-files'.
(project-search, project-query-replace-regexp): Doc fixes.

* doc/emacs/maintaining.texi (Projects): New section.
* doc/emacs/emacs.texi (Top): Add "Projects" to the detailed menu.
2020-03-21 13:26:19 +02:00
Eli Zaretskii
b468b3d1ff Fix a recent documentation change
* doc/emacs/frames.texi (Mouse Commands): More detailed
description of how tilting the mouse-wheel works.

* lisp/mwheel.el (mouse-wheel-tilt-scroll)
(mouse-wheel-flip-direction): Fix the wording of doc strings.
(Bug#39979)
2020-03-13 12:24:25 +02:00
İ. Göktuğ Kayaalp
ef5744a988 Improve docs for horizontal scrolling with mouse and touchpad (Bug#39979)
* lisp/mwheel.el (mouse-wheel-tilt-scroll,
mouse-wheel-flip-direction): Improve docstrings.
* doc/emacs/frames.texi (Mouse Commands): Mention touchpads.
2020-03-11 19:48:47 -04:00
Mattias Engdegård
0883c800a0 Simplify rx example in manual
* doc/lispref/searching.texi (Rx Notation):
Use the 'not' shorthand introduced in Emacs 27.
2020-03-09 16:00:18 +01:00
Paul Eggert
818333c85a * doc/lispref/os.texi (time-subtract): Doc fix. 2020-03-07 09:50:18 -08:00
Alan Third
72f87f8873 NS port documentation updates
* doc/emacs/macos.texi (Mac / GNUstep Customization): Document some
more of the ns- variables and remove incorrect font back-end
information.
* etc/NEWS: Update the documentation status of macOS news entries.
2020-03-07 14:41:47 +00:00
Eli Zaretskii
08c042bd26 Document that 'byte-compile-dynamic' is obsolete
* doc/lispref/compile.texi (Dynamic Loading): Document that this
is deprecated.

* etc/NEWS: mark the 'byte-compile-dynamic' entry as documented.
2020-03-07 14:23:23 +02:00
Eli Zaretskii
fdbe7cacfb Document the changes in 'read-answer'
* doc/lispref/minibuf.texi (Multiple Queries): Document the
fact that 'read-answer' can now accept non-character input
events.
2020-03-07 13:40:10 +02:00
Eli Zaretskii
10c58356e4 Document changes in lexical-binding
* doc/lispref/variables.texi (Using Lexical Binding): Document
that lexical-binding is now turned on by default in more cases.

* etc/NEWS: Fix wording of the NEWS entry about the above, and mark it
as fully documented.
2020-03-07 13:32:52 +02:00
Noam Postavsky
60418a1ab2 Explain how to unset mode bindings (Bug#39802)
* doc/emacs/custom.texi (Init Rebinding): Explain that passing nil to
define-key will unbind keys, and extend the example accordingly.
2020-03-03 22:04:48 -05:00
Juri Linkov
592b1cfee9 Improve documentation of next-error-highlight-no-select (bug#38778)
* doc/emacs/building.texi (Compilation Mode):
Mention next-error-highlight-no-select.

* lisp/simple.el (next-error-highlight): Add reference to
next-error-highlight-no-select.
(next-error-highlight-no-select): Add reference to
next-error-highlight.
2020-03-04 01:48:03 +02:00
Eli Zaretskii
d373647e8f ; * doc/emacs/mini.texi (Yes or No Prompts): Fix last change. 2020-03-03 18:23:40 +02:00
Juri Linkov
1ca6d15656 * doc/emacs/mini.texi (Yes or No Prompts): 'y-or-n-p' now uses the minibuffer. 2020-03-03 00:33:30 +02:00
Mattias Engdegård
49d3cd90bd rx: Improve 'or' compositionality (bug#37659)
Perform 'regexp-opt' on nested 'or' forms, and after expansion of
user-defined and 'eval' forms.  Characters are now turned into strings
for wider 'regexp-opt' scope.  This preserves the longest-match
semantics for string in 'or' forms over composition.

* doc/lispref/searching.texi (Rx Constructs): Document.
* lisp/emacs-lisp/rx.el (rx--normalise-or-arg)
(rx--all-string-or-args): New.
(rx--translate-or): Normalise arguments first, and check for strings
in subforms.
(rx--expand-eval): Extracted from rx--translate-eval.
(rx--translate-eval): Call rx--expand-eval.
* test/lisp/emacs-lisp/rx-tests.el (rx-or, rx-def-in-or): Add tests.
* etc/NEWS: Announce.
2020-03-01 10:47:14 +01:00
Štěpán Němec
ff729e3f97 ; bug#39779: Fix some typos in documentation. 2020-02-28 15:21:55 +02:00