1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-01 13:21:11 -08:00
Commit graph

5100 commits

Author SHA1 Message Date
Eli Zaretskii
889a550ca0 ; Fix Texinfo warnings
* doc/misc/wisent.texi (Grammar format):
* doc/misc/efaq.texi (Not writing files to the current directory):
* doc/misc/ede.texi:
* doc/lispref/errors.texi (Standard Errors): Fix warnings emitted
by makeinfo 7.1.
2023-10-22 12:21:08 +03:00
Jens Schmidt
b99d12c30c ; Fix argument name for function `copy-file'
* doc/lispref/files.texi (Changing Files): Change name of last
argument of function `copy-file' from `preserve-extended-attributes'
to `preserve-permissions', as used in the function's description, its
doc string and the description below in the manual.
2023-10-20 09:04:39 +03:00
Bob Rogers
0ea2d6d9e8 Document that time-to-days and days-to-time use different epochs
* doc/lispref/os.texi (Time Calculations):
* lisp/calendar/time-date.el (days-to-time, time-to-days): Doc fixes.
(Bug#66502)
2023-10-14 11:57:30 +03:00
Eli Zaretskii
809da7fc9a ; * doc/lispref/processes.texi (Process Buffers): More accurate wording. 2023-10-07 19:09:58 +03:00
Eli Zaretskii
e110312ad9 ; * doc/lispref/minibuf.texi (Text from Minibuffer): Mention alias. 2023-09-16 08:55:17 +03:00
shynur
d11d81dfcc ; Fix doc typos (Bug#65868) 2023-09-11 17:16:23 +02:00
Stefan Kangas
5ab2792d5c Update defvar usage tips example in manual
* doc/lispref/variables.texi (Tips for Defining): Change example
to be about syntax tables instead of old way of defining keymaps
using 'defvar' and 'make-sparse-keymap'.  (Bug#59224)
2023-09-11 01:49:36 +02:00
Vincent Lefevre
b8a8106fa1 ; Add missing space in the manual
* doc/lispref/compile.texi (Native-Compilation Variables): Add missing
space.  (Bug#65782)

Copyright-paperwork-exempt: yes
2023-09-08 18:49:23 +02:00
Eli Zaretskii
4e7112ab21 ; Fix inaccuracy in ELisp reference manual
* doc/lispref/text.texi (Motion by Indent): Remove incorrect
information about return values that can be anything.  (Bug#65819)
2023-09-08 14:39:49 +03:00
Sebastian Miele
b068fcd4a3 * doc/lispref/strings.texi (Text Comparison): Fix typo (bug#65799). 2023-09-07 16:16:34 +03:00
Eli Zaretskii
9e9f61866e Improve wording in ELisp manual
* doc/lispref/objects.texi (Printed Representation): Improve
wording.  Suggested by Xie Shynur <one.last.kiss@outlook.com>.
(Bug# 60639)
2023-09-06 15:49:11 +03:00
Eli Zaretskii
e660ee88e3 ; Remove incorrect example from ELisp Reference manual
* doc/lispref/commands.texi (Event Examples): Remove incorrect
example of using SIGUSR1 signal as an event.  (Bug#65577)
2023-09-02 10:38:16 +03:00
Eli Zaretskii
5cbe96d17f ; Improve documentation of 'char-table-range'
* doc/lispref/sequences.texi (Char-Tables):
* src/chartab.c (Fchar_table_range): Clarify what
'char-table-range' returns for an argument that is a cons cell.
2023-09-01 16:33:40 +03:00
Eli Zaretskii
3296031ad7 ; Another improvement for documentation of pixelwise scrolling
* doc/lispref/commands.texi (Misc Events): More details about
pixelwise mouse-wheel scrolling events.  (Bug#65070)
2023-08-20 11:09:40 +03:00
Eli Zaretskii
781ddd7e7d Fix touchpad scrolling on MS-Windows
* src/w32term.c (w32_construct_mouse_wheel): The number of lines
to scroll should always be positive in wheel-scroll events.
Whether to scroll up or down is encoded in the modifiers, which
produce either wheel-up or wheel-down event.  (Bug#65070)

* doc/lispref/commands.texi (Misc Events): Clarify the
documentation of 'wheel-up' and 'wheel-down' events.
2023-08-19 17:01:18 +03:00
Eli Zaretskii
221ed70b90 ; Improve documentation of 'define-alternatives'
* doc/lispref/commands.texi (Generic Commands):
* lisp/simple.el (define-alternatives): Improve documentation of
'define-alternatives'.
2023-08-15 17:08:12 +03:00
Eli Zaretskii
6eddbfe33f Clarify the meaning of the argument of ':align-to' space spec
* doc/lispref/display.texi (Specified Space): Clarify the meaning
and measurement of HPOS in ':align-to' space specs.  (Bug#65015)
2023-08-03 08:31:17 +03:00
Eli Zaretskii
54e98b5f9b ; Clarify documentation of 'server-after-make-frame-hook'
* doc/lispref/frames.texi (Creating Frames):
* lisp/server.el (server-after-make-frame-hook): Clarify
documentation of 'server-after-make-frame-hook'.  (Bug#64873)

(cherry picked from commit e650a14f64)
2023-07-30 10:23:32 +03:00
Eli Zaretskii
d149a4dc42 ; Improve documentation of automatic addition to minibuffer history
* doc/lispref/minibuf.texi (Minibuffer History)
(Minibuffer Commands, Text from Minibuffer)
(Minibuffer Completion): Document the behavior of 'M-n' and
"future history" when the value(s) in DEFAULT is/are exhausted.
(Bug#64656)
2023-07-22 11:02:04 +03:00
Eli Zaretskii
42a9962794 ; Improve documentation of 'last-command-event'
* doc/lispref/text.texi (Commands for Insertion):
* doc/lispref/commands.texi (Command Loop Info):
* src/cmds.c (syms_of_cmds) <post-self-insert-hook>: Improve the
documentation of 'last-command-event' and 'post-self-insert-hook'.
2023-07-22 09:34:15 +03:00
Eli Zaretskii
d172cd5985 ; * doc/lispref/keymaps.texi (Modifying Menus): Add cross-references. 2023-07-18 16:17:15 +03:00
Eli Zaretskii
927e8b470f ; * doc/lispref/keymaps.texi (Extended Menu Items): Add @pxref. 2023-07-18 15:57:01 +03:00
Gregory Heytings
419b4d4491 ; Improve documentation of with-restriction
* lisp/subr.el (with-restriction):
* doc/lispref/positions.texi (Narrowing): Make it clear that the
argument is evaluated and that the result of the evaluation must
not be nil.
2023-07-09 19:28:29 +00:00
Eli Zaretskii
40f84e906f ; * doc/lispref/keymaps.texi (Key Binding Commands): Fix typo. 2023-07-07 09:59:52 +03:00
Eli Zaretskii
502a780031 ; Improve documentation of 'vertical-motion' in ELisp manual
* doc/lispref/positions.texi (Screen Lines): Improve the
documentation of 'vertical-motion'.
2023-07-07 09:26:58 +03:00
Eli Zaretskii
a30ebe7a55 ; Improve documentation of key-binding commands
* doc/lispref/keymaps.texi (Key Binding Commands): Improve the
documentation of arguments expected by key binding commands.

* lisp/keymap.el (keymap-set, keymap-global-set)
(keymap-local-set, keymap-global-unset, keymap-local-unset)
(keymap-unset, key-parse): Doc fixes.
2023-07-06 11:42:01 +03:00
Robert Pluim
244d4c837a correct info documentation of benchmark-call
* doc/lispref/debugging.texi (Profiling): 'benchmark-call' is a defun,
not a macro.
2023-07-04 17:35:40 +02:00
Eli Zaretskii
aa030698ce ; Fix typos in documented names of keymap-* functions
* doc/lispref/keymaps.texi (Functions for Key Lookup): Fix typos
in function names.  (Bug#64434)
2023-07-03 15:12:12 +03:00
Eli Zaretskii
37ed3d15f3 Avoid errors in completion due to 'completion-regexp-list'
* doc/lispref/minibuf.texi (Basic Completion):
* src/minibuf.c (syms_of_minibuf) <completion-regexp-list>:
Document that global non-nil settings of 'completion-regexp-list'
are not safe.

* lisp/minibuffer.el (completion-pcm--merge-completions): Avoid
errors in 'try-completion' when PREFIX is nil.  (Bug#64351)
2023-07-02 09:16:58 +03:00
Michael Heerdegen
fe7b909c16 ; Fix two typos in recent changes in the manual
* doc/lispref/text.texi (Property Search):
* lisp/register.el (register-preview-function): Fix typos.
2023-07-02 08:23:28 +03:00
Eli Zaretskii
fc6099bf04 ; Improve documentation of text-property-search-* functions
* doc/lispref/text.texi (Property Search): Improve wording and markup.

* lisp/emacs-lisp/text-property-search.el (text-property-search-forward)
(text-property-search-backward): Doc fixes.  (Bug#64367)
2023-07-01 12:28:33 +03:00
Basil L. Contovounesios
624c779517 ; Fix tree-sitter C binding typos in Elisp manual. 2023-06-30 12:04:42 +01:00
Eli Zaretskii
16e9bdff4f Improve documentation of registers
* doc/lispref/text.texi (Registers): Document buffers in
registers.  Mention "frameset" as another name for "frame
configuration".
* doc/emacs/regs.texi (Registers, Configuration Registers)
(File and Buffer Registers): Clarify and improve wording.  Add
cross-references and indexing.
(Configuration Registers): Rename the section to a more accurate
name.  (Bug#64354)

* lisp/register.el (jump-to-register, point-to-register)
(register-alist, frame-configuration-to-register): Doc fixes.
(Bug#64353)
2023-06-30 10:13:53 +03:00
Vladimir Sedach
53332bdf62 ; * doc/lispref/variables.texi: Fix define-obsolete-variable-alias arglist
The WHEN argument is not optional anymore (bug#64312)

Copyright-paperwork-exempt: yes
2023-06-27 14:21:49 +03:00
Eli Zaretskii
162c9c058e ; Document that 'named-let' needs lexical-binding
* doc/lispref/variables.texi (Local Variables): Warn that
'named-let' only works under lexical-binding.  (Bug#64290)
2023-06-26 18:41:06 +03:00
Eli Zaretskii
2591eb1190 Improve documentation of 'minibuffer-message'
* doc/lispref/minibuf.texi (Minibuffer Misc): Clarify that
'minibuffer-message' behaves like 'message' if called from a
buffer that is not a minibuffer.

* lisp/minibuffer.el (minibuffer-message)
(set-minibuffer-message, clear-minibuffer-message): Doc fixes.
(Bug#64165)
2023-06-20 15:31:57 +03:00
Mattias Engdegård
8f62e7b85f Describe primarily the Emacs s-exp dialect for treesit queries
* doc/lispref/parsing.texi (Pattern Matching, Multiple Languages):
Writing tree-sitter queries as Emacs s-expressions is much more
convenient than using the native query notation inside a string,
so it makes sense to base the documentation on the former dialect
(bug#64017).
2023-06-18 10:42:44 +02:00
Eli Zaretskii
eacd75df4e ; Improve documentation of overlay priorities
* doc/lispref/display.texi (Overlay Properties): Don't advise
against using overlay property values that are cons cells.
(Bug#64101)
2023-06-18 09:13:02 +03:00
Eli Zaretskii
b3f11e94fa Fix documentation of :predicate in 'define-globalized-minor-mode'
* doc/lispref/modes.texi (Defining Minor Modes):
* lisp/emacs-lisp/easy-mmode.el (define-globalized-minor-mode):
Document that :predicate creates a customizable user option.
(Bug#64048)
2023-06-18 08:50:54 +03:00
Eli Zaretskii
aad7d68164 ; * doc/lispref/display.texi (Display Tables): Remove extra parens. 2023-06-17 16:13:38 +03:00
Eli Zaretskii
70fc7c41ef Improve documentation of 'declare' forms
* lisp/simple.el (read-extended-command-predicate): Mention the
'(declare completion ...' form in the doc string.

* doc/lispref/functions.texi (Declare Form): Clarify
'completion-predicate' and 'modes'; add cross-references.
(Bug#64045)
2023-06-15 09:28:26 +03:00
Basil L. Contovounesios
2847857496 Improve tree-sitter docs
* doc/lispref/positions.texi (List Motion): Incorporate more
accurate description of treesit-defun-type-regexp from
'(elisp) Tree-sitter Major Modes', replacing that duplicate
entry (bug#64018).

* doc/lispref/parsing.texi (Parsing Program Source)
(Language Grammar, Using Parser, Retrieving Nodes)
(Accessing Node Information, Pattern Matching, Multiple Languages):
(Tree-sitter Major Modes):
* doc/lispref/modes.texi (Parser-based Font Lock): Improve wording,
grammar, punctuation, and markup.  Fix typos.
(Parser-based Indentation): Ditto.  Document indent rule presets
field-is, catch-all, nth-sibling, grand-parent, and
great-grand-parent.

* lisp/treesit.el (treesit-simple-indent-presets): Mention field-is,
catch-all, nth-sibling, grand-parent, great-grand-parent in
docstring.
(treesit-major-mode-setup, treesit-explore-mode): Improve
docstring/commentary grammar.
2023-06-13 17:22:16 +01:00
Basil L. Contovounesios
0e9307eb2b Fix some Texinfo markup in manuals
* doc/emacs/macos.texi (Mac / GNUstep Customization):
* doc/lispintro/emacs-lisp-intro.texi (condition-case):
* doc/lispref/control.texi (pcase Macro):
* doc/lispref/debugging.texi (Internals of Debugger):
* doc/lispref/internals.texi (Building Emacs):
* doc/lispref/modes.texi (Imenu):
(Parser-based Font Lock, Parser-based Indentation):
* doc/lispref/parsing.texi (Retrieving Nodes, Tree-sitter C API):
* doc/lispref/processes.texi (Network, Bindat Types):
* doc/lispref/searching.texi (Rx Functions):
* doc/lispref/text.texi (Replacing):
* doc/lispref/windows.texi (Textual Scrolling):
* doc/misc/calc.texi (Killing From Stack, Customizing Calc):
* doc/misc/cc-mode.texi (Misc Font Locking, List Line-Up):
* doc/misc/ede.texi (ede-cpp-root-project)
(ede-proj-target-makefile, ede-sourcecode):
* doc/misc/ert.texi (Running Tests in Batch Mode):
* doc/misc/eudc.texi (Emacs-only Configuration, The Server Hotlist):
* doc/misc/eww.texi (Advanced):
* doc/misc/flymake.texi (Starting Flymake)
(Proc customization variables):
* doc/misc/tramp.texi (File name completion):
* doc/misc/gnus.texi (Summary Buffer Lines, Gnus Registry Setup)
(Fancy splitting to parent, Customizing the IMAP Connection)
(Mail Source Specifiers, Agent as Cache): Consistently mark up nil
and t as @code.  Also fix the markup and wording of some surrounding
text (bug#64016).

* doc/lispref/display.texi (SVG Images, Icons):
* doc/lispref/modes.texi (Customizing Keywords): Prefer ASCII
apostrophe over Unicode right single quotation mark.
2023-06-13 15:29:06 +01:00
Eli Zaretskii
f4ee696b88 Improve documentation of color-related functions
* doc/lispref/frames.texi (Color Names): Document
'color-name-to-rgb' and 'color-dark-p'.
2023-06-09 10:28:36 +03:00
Eli Zaretskii
240803cc3e Document 'startup-redirect-eln-cache'
* doc/lispref/compile.texi (Native Compilation)
(Native-Compilation Functions): Document
'startup-redirect-eln-cache'.

* etc/PROBLEMS: Fix last change.
* etc/NEWS: Mark 'startup-redirect-eln-cache' as documented.
2023-06-08 08:50:54 +03:00
Eli Zaretskii
5aadb87d6f Fix 'use-dialog-box-p' and friends
* lisp/subr.el (use-dialog-box-p): Use dialog boxes also when
invoked from some window-system gesture.  (Bug#63655)
(y-or-n-p): Fix the description in the doc string of conditions
under which a dialog box will be used.

* src/fns.c (Fyes_or_no_p): Use the same condition for dialog
boxes as in 'use-dialog-box-p'.  Fix the description in the doc
string of conditions under which a dialog box will be used.

* doc/lispref/minibuf.texi (Multiple Queries, Yes-or-No Queries):
Fix the description of conditions under which a dialog box will be
used.
2023-05-23 17:44:23 +03:00
Basil L. Contovounesios
5c95239aca ; Fix markup of some treesit vars in Elisp manual.
* doc/lispref/modes.texi (Parser-based Font Lock):
(Parser-based Indentation):
* doc/lispref/parsing.texi (Multiple Languages): Use @code in place
of @var when the argument is not a metavariable.
2023-05-22 15:28:01 +01:00
Eli Zaretskii
ce7d18cbc0 ; Minor fixes in ELisp manual
* doc/lispref/functions.texi (Declare Form): Improve indexing.
(Obsolete Functions): Add cross-reference.
`
2023-05-14 10:26:03 +03:00
Gregory Heytings
dcf8c01102 Merge branch 'scratch/long-lines-cleanup' into 'emacs-29' 2023-05-13 00:13:44 +02:00
Eli Zaretskii
346f4ac3bf ; Fix example in ELisp manual
* doc/lispref/minibuf.texi (Yes-or-No Queries): Fix example.
(Bug#63399)
2023-05-10 16:47:14 +03:00