1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-04 14:40:54 -08:00
Commit graph

11105 commits

Author SHA1 Message Date
F. Jason Park
af43f0a295 * doc/misc/erc.texi: Elaborate on upgrading via ELPA. 2023-04-26 06:21:29 -07:00
Eli Zaretskii
fe8efbb8f7 Document the 'end-session' event on MS-Windows
* doc/lispref/commands.texi (Misc Events): Document the
'end-session' event.  (Bug#63058)
2023-04-25 09:35:30 +03:00
Eli Zaretskii
d041f01b02 ; Minor fix in Emacs Lisp Intro manual
* doc/lispintro/emacs-lisp-intro.texi (what-line): Fix punctuation
and wording.  Reported by Holger Kienle <hkienle@posteo.de>.
(Bug#62998)
2023-04-21 19:16:52 +03:00
Spencer Baugh
ecdd3a9efa Improve Completion Example section in the Emacs manual
This can be a useful substitute for full-on fuzzy completion, as
provided by other completion styles and completion packages.
* doc/emacs/mini.texi (Completion Example): Give an example of
completion with point not at end of minibuffer.  Also, use
@kbd{@key{TAB}} when telling the user to hit TAB.  (Bug#62836)
2023-04-19 15:21:37 +03:00
Robert Pluim
327986936c Add index entry for fallback modes
* doc/emacs/custom.texi (Specifying File Variables): Add index for
'fallback modes'.
2023-04-19 12:29:57 +02:00
Shynur
1b8b2cf61b Fix typo and inaccuracy in the ELisp Reference manual
* doc/lispref/loading.texi (Dynamic Modules): Fix a typo.
* doc/lispref/customize.texi (Group Definitions): Faces are also
in the 'custom-group' property of a customization group.
(Bug#62887)

Copyright-paperwork-exempt: yes
2023-04-18 15:03:32 +03:00
Eli Zaretskii
60560cc7ad Fix description of lexical environment's internals
* doc/lispref/variables.texi (Lexical Binding): Update the
description of how the lexical environment is represented
internally.  (Bug#62840)
2023-04-18 14:30:28 +03:00
Kyle Meyer
596b780ab7 Update to Org 9.6.4-2-g0f6ae7 2023-04-16 21:13:08 -04:00
Earl Hyatt
6e6e8b5c97 Add more documentation for the keys of package-vc-selected-packages.
* doc/emacs/package.texi (Specifying Package Sources): List the
accepted keys in a new subsection of Fetching Package Sources.

* lisp/emacs-lisp/package-vc.el (package-vc-selected-packages):
Mention the `:doc` key.  Add the `:doc` key to the Customize form,
mention the new Info node, correct "TexInfo" to "Texinfo", avoid
Git-specific terms for the description of `:branch`, mention guessing
`:vc-backend` based on the URL.
2023-04-12 09:45:52 +02:00
Mattias Engdegård
954e2d96a9 Update manual about sort
* doc/lispref/sequences.texi (Sequence Functions):
Remove inaccurate and over-specific claims about how `sort` works for
lists: there is no guarantee that it doesn't modify the `car` fields
of the input list (which is precisely what it does at this time).

(cherry picked from commit c753a95923)
2023-04-11 10:12:15 +02:00
Eli Zaretskii
2445100d7d ; Improve documentation of 'match-buffers'
* doc/lispref/buffers.texi (Buffer List):
* lisp/subr.el (match-buffers): Fix documentation of
'buffer-match-p' and 'match-buffers'.
2023-04-10 12:30:23 +03:00
Basil L. Contovounesios
d6af1f1498 ; doc/lispref/windows.texi: Fix @pxref paren. 2023-04-09 19:08:06 +01:00
Eli Zaretskii
74ddfe811f ; * doc/misc/calc.texi (Rewrites Tutorial): Fix a typo (bug#62658). 2023-04-08 19:14:15 +03:00
Eli Zaretskii
08cda286c3 Improve the documentation of the XDS support
* doc/lispref/frames.texi (Drag and Drop): Rephrase and rearrange
the documentation of XDS support.  Add indexing.  Document
'x-dnd-save-direct' and 'x-dnd-save-direct-immediately'.  Original
patch from Po Lu <luangruo@yahoo.com>.

* lisp/x-dnd.el (x-dnd-types-alist, x-dnd-test-function)
(x-dnd-default-test-function, x-dnd-direct-save-function): Doc
fixes.
(x-dnd-save-direct, x-dnd-save-direct-immediately): Rename the
second argument to FILENAME.  Doc fix.
2023-04-08 18:36:23 +03:00
Eli Zaretskii
96714c106b Improve documentation of image-related commands
* lisp/image.el (image-map): Make it inherit from
'image-slice-map' instead of repeating the bindings.

* doc/emacs/files.texi (Image Mode): Document the key bindings set
by 'insert-image'.  Add indexing.

* doc/lispref/display.texi (Showing Images): Make the description
of user commands more concise.  Add index entries and
cross-reference to the Emacs manual.

* etc/NEWS: Rearrange entries relevant to image commands.
2023-04-08 14:33:06 +03:00
Eli Zaretskii
5880179270 ; Minor addition to the Emacs FAQ
* doc/misc/efaq.texi (Fullscreen mode on MS-Windows): Tell how to
avoid the initial screen changing size on display without using
the Registry.  Suggested by David Hedlund <public@beloved.name>.
2023-04-08 10:41:53 +03:00
Eli Zaretskii
6b9f9df945 ; Improve documentation of 'declare-function'
* doc/lispref/functions.texi (Declaring Functions):
* lisp/subr.el (declare-function): Document explicitly that
ARGLIST argument, if provided, should include the parentheses.
2023-04-05 12:31:01 +03:00
Eli Zaretskii
38cdfcb212 ; Fix description of new 'keymap-*' functions
* doc/lispref/keymaps.texi (Prefix Keys): Fix example (bug#62673).
(Functions for Key Lookup): Clarify the possible values of KEYMAP
argument of 'keymap-lookup'.
(Active Keymaps): Fix typo in function name; add cross-reference.
2023-04-05 11:31:15 +03:00
Eli Zaretskii
90c07d3fdd Another terminology fix in ELisp reference manual
* doc/lispref/frames.texi (Mouse Tracking):
* doc/lispref/commands.texi (Motion Events, Event Examples):
'track-mouse' is a macro, not a special form.
2023-04-04 14:22:56 +03:00
Shynur
a832bc7090 Correct terminology in Elisp Reference Manual
* doc/lispref/functions.texi (Function Names): 'defun' is a macro, not
a special form.  (Bug#62661)

Copyright-paperwork-exempt: yes
2023-04-04 14:16:23 +03:00
Robert Pluim
eda88c63ad ; * doc/emacs/trouble.texi (Checklist): Minor grammar fix. 2023-04-03 14:42:54 +02:00
Eli Zaretskii
24ed9c7ae7 ; * doc/emacs/trouble.texi (Checklist): Minor copyedits (bug#62320). 2023-04-01 13:00:36 +03:00
Eli Zaretskii
d1d39a0f09 Document enhancements in handling of echo-area messages
* etc/NEWS:
* doc/lispref/display.texi (Displaying Messages):
* lisp/minibuffer.el (inhibit-message-regexps)
(set-message-functions, inhibit-message, set-multi-message):
Improve the documentation of functions dealing with display of
echo-area messages.
2023-04-01 12:49:18 +03:00
Shynur
d0eb12e8d3 Fix typo in section 14.1 of Emacs Manual
* doc/emacs/display.texi (Scrolling): Fix typo.  (Bug#62569)

Copyright-paperwork-exempt: yes
2023-03-31 16:00:51 +03:00
Eli Zaretskii
4508a024e8 ; Clarify documentation of 'cursor' text property
* doc/lispref/text.texi (Special Properties): Clarify that
'cursor' property is only considered when the overlay hides buffer
text on display.  (Bug#62540)
2023-03-30 16:34:41 +03:00
Eli Zaretskii
9b32bc134c Improve documentation of 'defcustom's :set keyword
* lisp/custom.el (defcustom):
* doc/lispref/customize.texi (Variable Definitions): Improve the
documentation of the :set keyword in 'defcustom'.
2023-03-30 09:09:43 +03:00
Michael Albinus
46fd10a760 * doc/misc/tramp.texi (Remote shell setup): Clarify use of ssh RemoteCommand. 2023-03-29 10:55:18 +02:00
Gregory Heytings
85ed1c9ca6 Code cleanup for long line optimizations
This commit does not change any code, it merely renames functions
and clarifies the documentation, to make the code hopefully easier
to grasp.

* src/dispextern.h (struct it): Rename the 'narrowed_begv',
'narrowed_zv', 'locked_narrowing_begv', 'locked_narrowing_zv' to
'medium_narrowing_begv', 'medium_narrowing_zv',
'large_narrowing_begv', 'large_narrowing_zv'.  Clarify the
comments.
Update the prototypes of the functions renamed in xdisp.c.

* src/lisp.h: Update the prototypes of the functions renamed in
editfns.c.  Remove the prototype of
'safe_run_hooks_maybe_narrowed', which is used only in keyboard.c.

* src/xdisp.c
(get_small_narrowing_begv): Renamed from
'get_closer_narrowed_begv'.
(get_medium_narrowing_begv): Renamed from 'get_narrowed_begv'.
(get_medium_narrowing_zv): Renamed from 'get_narrowed_zv'.
(get_large_narrowing_begv): Renamed from 'get_locked_narrowing_begv'.
(get_large_narrowing_zv): Renamed from 'get_locked_narrowing_zv'.
(SET_WITH_NARROWED_BEGV): Use the new field names.
(handle_fontified_prop): Use the new function and new field names.
(back_to_previous_line_start): Use the new field name.
(back_to_previous_visible_line_start): Use the new field name.
(reseat): Use the new function and new field names.
(get_visually_first_element): Use the new field name.
(move_it_vertically_backward): Use the new function name.
(redisplay_internal): Use the new function name.
Also add a large comment to explain how Emacs deals with long lines.

* src/keyboard.c:
(safe_run_hooks_maybe_narrowed): Use the new function names from
xdisp.c and editfns.c.  Make the function static, and add a
prototype.

* src/editfns.c:
(labeled_restrictions): Renamed from 'narrowing_locks'.
(labeled_restrictions_add): Renamed from 'narrowing_locks_add'.
(labeled_restrictions_remove): Renamed from
'narrowing_locks_remove'.
(labeled_restrictions_get_bound): Renamed from
'narrowing_lock_get_bound'.
(labeled_restrictions_peek_label): Renamed from
'narrowing_lock_peek_tag'.
(labeled_restrictions_push): Renamed from 'narrowing_lock_push'.
(labeled_restrictions_pop): Renamed from 'narrowing_lock_pop'.
(unwind_reset_outermost_restriction): Renamed from
'unwind_reset_outermost_narrowing'.
(reset_outermost_restrictions): Renamed from
'reset_outermost_narrowings'.
(labeled_restrictions_save): Renamed from 'narrowing_locks_save'.
(labeled_restrictions_restore): Renamed from
'narrowing_locks_restore'.
(unwind_labeled_narrow_to_region): Renamed from
'unwind_narrow_to_region_locked'.
(labeled_narrow_to_region): Renamed from
'narrow_to_region_locked'.
(Finternal__label_restriction): Renamed from
'Finternal__lock_narrowing'.
(Finternal__unlabel_restriction): Renamed from
'Finternal__unlock_narrowing'.
(Fwiden): Use the new function names.
(Fnarrow_to_region): Use the new function names.
(save_restriction_save): Use the new function names.
(syms_of_editfns): Use the new function names.
<outermost-restriction>: Renamed from 'outermost-narrowing'.

* lisp/subr.el (internal--with-restriction): Use the new internal
function name.
(internal--without-restriction): Use the new internal function
name.

* src/composite.c (composition_compute_stop_pos):
(find_automatic_composition): Use the new function name.

* doc/lispref/positions.texi (Narrowing): Add index entry.
2023-03-29 01:12:31 +02:00
Eli Zaretskii
c1eac5b658 Improve documentation of 'read-choice' and related symbols
* doc/lispref/commands.texi (Reading One Event):
* lisp/subr.el (read-char-choice-use-read-key, read-char-choice)
(read-char-choice-with-read-key, y-or-n-p-use-read-key): Improve
documentation of these functions and variables.
2023-03-28 21:08:12 +03:00
Jonas Bernoulli
0337131bfa
Update to Transient v0.3.7-218-g3dbb22a 2023-03-26 23:53:03 +02:00
Phil Sainty
9107b2dec1 * doc/lispref/modes.texi: Improve docs for obsolete '%m' construct
Bug #57080.
2023-03-27 00:16:35 +13:00
Phil Sainty
59b7086838 Improve docs for global-mode-string / %M construct
* src/xdisp.c (global-mode-string): Update docstring.
* doc/lispref/modes.texi: Update manual.
2023-03-26 23:44:06 +13:00
Michael Albinus
08fbc13375 Adapt Tramp manual
* doc/misc/tramp.texi (Default Method): OpenSSH for MS Windows can
be used.
(Ssh setup): Extend for MS Windows and ssh.
2023-03-24 13:30:25 +01:00
Eli Zaretskii
be8147c53f Improve "Bugs" in the Emacs manual
* doc/emacs/trouble.texi (Bugs, Known Problems)
(Understanding Bug Reporting, Checklist, Sending Patches)
(Contributing, Coding Standards): Improve wording, structure,
markup, and indexing.  (Bug#62320)
2023-03-23 15:33:04 +02:00
João Távora
1bc9dfc5be ; Minor copyedits to Eglot manual
* doc/misc/eglot.texi (Troubleshooting Eglot): Minor fixes.
2023-03-23 10:26:50 +00:00
Eli Zaretskii
bcd02cf512 ; Improve documentation of :predicate in globalized minor modes
* doc/lispref/modes.texi (Defining Minor Modes):
* lisp/emacs-lisp/easy-mmode.el (define-globalized-minor-mode):
Improve documentation of the :predicate keyword in defining
globalized minor modes.
2023-03-23 11:30:19 +02:00
Yuan Fu
8b6a0de964
Improve docstring of treesit-parent-while (bug#62301)
* doc/lispref/parsing.texi (Retrieving Nodes): Improve and fix
docstring for treesit-parent-until and treesit-parent-while.
* lisp/treesit.el (treesit-parent-while): Improve docstring.
2023-03-21 14:51:41 -07:00
Robert Pluim
4a6eefb93a Expand defvar-keymap documentation
* doc/lispref/keymaps.texi (Creating Keymaps): Describe the :repeat keyword.
2023-03-21 10:57:39 +01:00
Robert Pluim
6bf441ff11 Warn package authors away from keymap-unset with REMOVE
* doc/lispref/keymaps.texi (Changing Key Bindings): Ask package
authors to not use the REMOVE argument to `keymap-unset'.
2023-03-20 16:21:36 +01:00
Gregory Heytings
b7f0333355 Improve warning about changing the string returned by symbol-name
* src/data.c (Fsymbol_name): Add warning.  See bug#62009.

* doc/lispref/symbols.texi (Creating Symbols): Improve warning.
2023-03-19 22:17:40 +01:00
Eli Zaretskii
e388a77cf0 ; Minor copyedits of recent changes in ELisp reference manual
* doc/lispref/keymaps.texi (Changing Key Bindings): Fix wording
and markup.
2023-03-18 15:54:35 +02:00
Eli Zaretskii
33a2670368 ; Minor fixes in recent Eglot changes
* doc/misc/eglot.texi (Project-specific configuration): Fix
whitespace.

* lisp/progmodes/eglot.el (eglot-diagnostics-map): Doc fix.
2023-03-18 15:46:05 +02:00
Eli Zaretskii
d2cf1386fa ; * doc/misc/eglot.texi (Eglot Commands): Improve indexing. 2023-03-18 15:41:55 +02:00
João Távora
b75e489362 ; Again correct node reference casing in doc/misc/eglot.texi
Emacs's info-generating Texinfo incantation seems to be case
insensitive, but others -- like Eglot's HTML manual generation -- is
case sensitive.

* doc/misc/eglot.texi (Eglot Features): Fix.
2023-03-18 12:43:31 +00:00
João Távora
22a70451f3 Merge confusing duplicate sections on commands in Eglot manual
Also describe eglot-diagnostics-map.

* doc/misc/eglot.texi (Eglot Features): Don't describe commands here.
(Eglot Commands): Describe commands here.
2023-03-18 12:35:45 +00:00
João Távora
013057e351 ; Prefer "language server" to "LSP server" in Eglot manual
* eglot.texi (Quick Start, Customizing Eglot)
(Project-specific configuration)
(Troubleshooting Eglot): LSP server -> language server.
2023-03-18 12:22:47 +00:00
João Távora
90362f87d5 ; Correct last commit, downcase node reference
* doc/misc/eglot.texi (Troubleshooting Eglot): Downcase node reference
2023-03-17 14:21:11 +00:00
João Távora
38067f05b9 Enhance section about troubleshooting in Eglot manual.
* doc/misc/eglot.texi (Troubleshooting Eglot): Parially rewrite.
2023-03-17 14:18:11 +00:00
Robert Pluim
e8cee15f78 ; Fix markup in previous change 2023-03-17 14:25:39 +01:00
Robert Pluim
e4a7d0cd6e Document `keymap-unset' in lispref
* doc/lispref/keymaps.texi (Changing Key Bindings): Document
keymap-unset.
2023-03-17 14:18:10 +01:00