Commit graph

5820 commits

Author SHA1 Message Date
Eli Zaretskii
477335a10b ; Fix documentation of 'find-file-noselect'
* doc/lispref/files.texi (Visiting Functions):
* lisp/files.el (find-file-noselect): Document that NOWARN non-nil
also bypasses the file's last change verification.  (Bug#79127)
2025-08-02 17:33:15 +03:00
Eli Zaretskii
456f44a7b3 ; Improve documentation of change hooks
* doc/lispref/text.texi (Change Hooks): Warn against buffer
changes in the hook functions.  (Bug#79115)
2025-07-30 19:48:07 +03:00
Eli Zaretskii
8ec2ddebdd ; Update documentation of GC in ELisp manual
* doc/lispref/internals.texi (Garbage Collection): Update default
values for GC-related thresholds.  (Bug#79074)
2025-07-28 16:14:44 +03:00
Eli Zaretskii
e4908623f2 ; Fix documentation of 'other-window'
* doc/lispref/windows.texi (Cyclic Window Ordering):
* lisp/window.el (other-window): Document ALL-FRAMES in interactive
invocations.
2025-07-26 11:36:16 +03:00
Eli Zaretskii
5bdacbe460 Improve documentation of 'warning-display-at-bottom'
* lisp/emacs-lisp/warnings.el (warning-display-at-bottom):
* doc/lispref/display.texi (Warning Options):
* doc/emacs/windows.texi (Temporary Displays):
* etc/NEWS: Improve documentation of 'warning-display-at-bottom'.
See https://lists.gnu.org/archive/html/emacs-devel/2025-07/msg00024.html
for more details.
2025-07-04 15:02:29 +03:00
Eli Zaretskii
de18407f51 ; * doc/lispref/functions.texi (Mapping Functions): Fix wording (bug#78930). 2025-06-30 22:06:15 +03:00
Eli Zaretskii
e51ff3ee66 ; * doc/lispref/threads.texi (Condition Variables): Fix wording. 2025-06-28 22:17:06 +03:00
Eli Zaretskii
c0a913ea4f ; * doc/lispref/modes.texi (Font Lock Basics): Remove old info (bug#78720). 2025-06-08 18:43:20 +03:00
Eli Zaretskii
8881dca81c ; * doc/lispref/searching.texi (Char Classes): Add speedup advice. 2025-05-29 19:02:13 +03:00
Eli Zaretskii
399d05332e ; Remove confusing text from ELisp manual
* doc/lispref/variables.texi (Defining Variables): Remove outdated
confusing warning.  For the details, see
https://lists.gnu.org/archive/html/emacs-devel/2025-05/msg00332.html.
2025-05-17 12:35:29 +03:00
Sean Whitton
49c06df224 ; * doc/lispref/variables.texi (Default Value): Update.
Frame-local variables have been removed.
2025-05-13 12:07:42 +01:00
Eli Zaretskii
b172a1478c ; * doc/lispref/tips.texi (Library Headers): Fix wording (bug#78253). 2025-05-05 14:51:56 +03:00
Eli Zaretskii
79e7eeb329 ; Improve documentation of 'format-time-string'
* doc/lispref/os.texi (Time Parsing): Fix documentation of week
numbers for %U, %V and %W.  (Bug#78096)
2025-04-29 11:19:19 +03:00
Eli Zaretskii
9adb05422e ; Improve obsolescence of 'text-mode-variant'
* lisp/textmodes/text-mode.el (text-mode-variant): Improve
obsolescence announcement text.

* doc/lispref/modes.texi (Example Major Modes): Update example.
(Bug#78125).
2025-04-29 10:09:54 +03:00
Sean Whitton
b901290ae7 * doc/lispref/text.texi (Margins): Grammar fix.
Author:
2025-04-18 14:31:50 +08:00
Sean Whitton
3f06059730 Update remarks on name prefixes in coding conventions
* doc/lispref/tips.texi (Coding Conventions): Say that it's okay
to put the name prefix later for defining constructs, rather
than explicitly instructing the reader to do so.  Condense the
recommendation to err on the side of prepending the name prefix.
2025-04-12 11:05:45 +08:00
Eli Zaretskii
38fec86281 ; Improve the documentation of 'slice' display spec (bug#77384). 2025-03-30 19:27:22 +03:00
Yue Yi
816a17a711 peg.texi: Fix bug#76555 even a bit more
* doc/lispref/peg.texi (Parsing Expression Grammars):
Fix other part of the grammar of `define-peg-ruleset` example.
2025-03-25 22:22:13 -04:00
Yue Yi
4d396138b4 peg.texi: Fix bug#76555 even a bit more
* doc/lispref/peg.texi (Parsing Expression Grammars):
Fix grammar of `define-peg-ruleset` example.
2025-03-25 22:20:56 -04:00
Stefan Monnier
fb4db5c1a7 PEG: Fix bug#76555
* doc/lispref/peg.texi (Parsing Expression Grammars):
Fix `define-peg-ruleset` example.

* lisp/progmodes/peg.el (define-peg-rule): Fix indent rule.
2025-03-25 22:17:32 -04:00
Stefan Kangas
b3881ac443 ; Improve type specifier documentation
* doc/lispref/functions.texi (Declare Form): Clarify wording for
precision and consistency; note consequences of incorrect declarations.
* doc/lispref/objects.texi (Type Specifiers): Mention use by the native
compiler; tighten wording.
2025-03-25 23:44:01 +01:00
Eli Zaretskii
6a3e2b88d2 ; Improve documentation of "function types"
* doc/lispref/functions.texi (Declare Form):
* doc/lispref/objects.texi (Type Specifiers): Improve wording and
indexing.
2025-03-25 14:37:17 +02:00
Basil L. Contovounesios
10d534023a ; Fix some markup in doc/lispref/commands.texi. 2025-03-23 18:13:52 +01:00
Stefan Kangas
dcf3916e55 ; Doc fix for legacy keymap functions
* doc/lispref/keymaps.texi (Low-Level Key Binding): Add new alternatives
for two more legacy functions.
2025-03-15 19:41:02 +01:00
Eli Zaretskii
01c03043e6 ; Improve documentation of 'gui-get-selection' use on X
* doc/lispref/frames.texi (Window System Selections):
* lisp/select.el (gui-get-selection): Suggest to use an explicit
DATA-TYPE when calling 'gui-get-selection'.
2025-03-15 11:48:36 +02:00
Eli Zaretskii
66ec9ae719 ; Fix documentation of mouse-click events
* doc/lispref/commands.texi (Click Events): Add menu-bar events to
the description.  Add missing details about tab-bar click events.

(cherry picked from commit 6e28c2019e)
2025-03-15 10:12:35 +02:00
Sean Whitton
2029104605 Correct some outdated docs for hack-local-variables
* doc/lispref/variables.texi (File Local Variables):
<hack-local-variables>: Say that it applies directory-local
variables too.  Add a cross-reference.
(Directory Local Variables): Document dir-local-variables-alist.
* lisp/files.el (hack-local-variables): Say that it always puts
into effect directory-local variables.
2025-03-12 10:05:32 +08:00
Stefan Kangas
7dcf9b71e6 ; Don't document package-x.el
* doc/lispref/package.texi (Package Archives): Delete documentation on
package-x.el, since it's obsolete in Emacs 31 and we want to discourage
its use.
2025-03-02 05:09:37 +01:00
Eli Zaretskii
bd1d6761f4 ; Document what happens when 'display' and 'invisible' props clash
* doc/lispref/display.texi (Replacing Specs, Overlay Properties)
(Invisible Text): Document that 'invisible' is ignored when
'display' property covers the same text.  (Bug#76658)
2025-03-01 12:59:32 +02:00
Stefan Kangas
526eeedf88 keymaps.texi: Move "Changing Key Bindings" section up
* doc/lispref/keymaps.texi (Changing Key Bindings): Move section
up.  (Bug#52821)
2025-03-01 06:36:43 +01:00
Stefan Kangas
7ec6531c7b keymaps.texi: Move "Key Sequences" section down
* doc/lispref/keymaps.texi (Key Sequences): Move section
down.  (Bug#52821)
2025-03-01 06:36:43 +01:00
Eli Zaretskii
f88dc0f2f9 ; Fix documentation of 'buffer-text-pixel-size'
* doc/lispref/display.texi (Size of Displayed Text): Fix arguments
of 'buffer-text-pixel-size'.  (Bug#76519)
2025-02-26 14:52:26 +02:00
Stefan Kangas
3c9b1c3cd1 Don't document deleted xwidget functions
* doc/lispref/display.texi (Xwidgets): Don't document deleted function
xwidget-webkit-execute-script-rv.  Fix name of deleted and then re-added
function xwidget-webkit-title.
2025-02-23 20:47:34 +01:00
Stefan Kangas
9e9b78dda9 ; Improve lsh and ash documented argument names
* doc/lispref/numbers.texi (Bitwise Operations): Improve lsh and
ash argument names.
2025-02-23 20:47:34 +01:00
Stefan Kangas
92e96a1175 ; Delete troff markers from ChangeLog files 2025-02-20 02:46:43 +01:00
Stefan Kangas
be7625cae7 ; Fix typos 2025-02-18 05:42:12 +01:00
Stefan Kangas
87a61eba1b Move 'package-archives' documentation to emacs manual
* doc/lispref/package.texi (Package Archives): Move documentation
of package-archives variable from here...
* doc/emacs/package.texi (Package Installation): ...to here.
(Bug#76266)
2025-02-13 16:40:15 +01:00
Stefan Kangas
c68886ddb7 ; Change "virus" to "malicious" in lispref
* doc/lispref/functions.texi (Function Safety): Replace 'virus' with
'malicious' to ensure broader accuracy, as 'malicious' encompasses all
harmful software types.
2025-02-13 03:04:30 +01:00
Eli Zaretskii
737f249aa2 ; Document 'completing-read-multiple' in the ELisp manual
* doc/lispref/minibuf.texi (Minibuffer Completion): Mention
'completing-read-multiple' (bug#76194).
2025-02-11 16:42:19 +02:00
Eli Zaretskii
223ee56aae ; Avoid passive tense in Emacs manual
* doc/lispref/variables.texi (Defining Variables): Avoid passive
tense (bug#76135).
2025-02-08 13:47:11 +02:00
Eli Zaretskii
143f1096da Improve documentation of 'file-name-concat'
* doc/lispref/files.texi (Directory Names):
* src/fileio.c (Ffile_name_concat): Advise not to use
'file-name-concat' unless necessary.  (Bug#76023)
2025-02-06 10:42:04 +02:00
Eli Zaretskii
6d7e7899d8 Improve documentation of 'display-monitor-attributes-
* doc/lispref/frames.texi (Multiple Terminals):
* lisp/frame.el (display-monitor-attributes-list): Better
documentation of what the 'source' key means on X.  (Bug#75936)
2025-02-02 15:58:18 +02:00
Stefan Kangas
3bccd04c5c Improve wording in symbols.texi
* doc/lispref/symbols.texi (Symbol Components): Improve wording
(Bug#75512).   Reported by Matt Trzcinski <matt@excalamus.com>.
2025-02-01 04:08:43 +01:00
Eli Zaretskii
5d021a711a ; Improve documentation of '.dir-locals.el'
* doc/lispref/variables.texi (Directory Local Variables):
* doc/emacs/custom.texi (Directory Variables): Document that
'.dir-locals-2.el' must be in the same directory as
'.dir-locals.el'.  (Bug#75890)
2025-01-27 15:19:06 +02:00
Stefan Kangas
5617b07a45 ; Prefer HTTPS to HTTP in docs
* doc/emacs/android.texi (Android Software):
* doc/lispref/frames.texi (X Selections):
* doc/misc/cc-mode.texi (Custom Filling and Breaking):
* doc/misc/efaq.texi (Basic editing):
* doc/misc/gnus.texi (Propagating marks, Spam Statistics Package):
* doc/misc/org.org (External Links, Images in HTML export)
(LaTeX Export, LaTeX math snippets): Prefer HTTPS to HTTP.  Fix or
mark some broken links while we're at it.
2025-01-26 22:45:13 +01:00
Stefan Kangas
3c820cd265 Document insert-directory-program as a user option
* doc/lispref/files.texi (Contents of Directories): Document
'insert-directory-program' as a user option.
2025-01-26 22:45:13 +01:00
Stefan Monnier
2c1edf5f62 doc/lispref/modes.texi (Syntactic Font Lock): Update for commit 644c6b414f
Remove outdated `nil` element, as discussed in
https://lists.gnu.org/archive/html/help-gnu-emacs/2025-01/msg00244.html
2025-01-25 10:48:38 -05:00
Stefan Kangas
fb282da2a0 Avoid double spaces around abbrevations in Texinfo
* doc/emacs/custom.texi (Init Rebinding):
* doc/emacs/dired.texi (Operating on Files):
* doc/emacs/emacs.texi (Top):
* doc/emacs/emerge-xtra.texi (Emerge):
* doc/emacs/files.texi (Files):
* doc/emacs/frames.texi (Drag and Drop):
* doc/emacs/misc.texi (Hyperlinking):
* doc/emacs/modes.texi (Modes):
* doc/emacs/mule.texi (Input Methods):
* doc/emacs/windows.texi (Window Tool Bar):
* doc/lispintro/emacs-lisp-intro.texi
(Lexical & Dynamic Binding Differences):
* doc/lispref/elisp.texi (Top):
* doc/lispref/functions.texi (Functions, Generic Functions):
* doc/lispref/hash.texi (Defining Hash):
* doc/lispref/keymaps.texi (Creating Keymaps):
* doc/lispref/lists.texi (Property Lists):
* doc/lispref/modes.texi (%-Constructs):
* doc/lispref/nonascii.texi (Character Properties):
* doc/lispref/processes.texi (Misc Network):
* doc/lispref/searching.texi (Regexp Functions):
* doc/lispref/syntax.texi (Syntax Table Internals):
* doc/lispref/text.texi (Filling, Checksum/Hash)
(JSONRPC deferred requests):
* doc/misc/calc.texi (What is Calc, Modes Tutorial):
* doc/misc/cc-mode.texi (List Line-Up, Operator Line-Up)
(Custom Macros, Indenting Directives):
* doc/misc/efaq.texi (Colors on a TTY, Security risks with Emacs):
* doc/misc/eglot.texi (Eglot Variables):
* doc/misc/erc.texi (Connecting):
* doc/misc/eshell.texi (Aliases, Completion):
* doc/misc/flymake.texi (Backend functions):
* doc/misc/gnus-faq.texi (FAQ 5 - Composing messages):
* doc/misc/gnus.texi (Gnus Unplugged, Window Layout)
(Filtering Incoming Mail, History):
* doc/misc/idlwave.texi (Online Help, Catalogs):
* doc/misc/wisent.texi (Wisent Overview): Be more consistent with
abbreviations.  Use @: or comma or rewrite to avoid double spaces.
Ref: https://lists.gnu.org/r/emacs-devel/2025-01/msg00909.html
2025-01-24 23:10:23 +01:00
Stefan Kangas
cda78edc7d ; Fix typos 2025-01-23 03:14:37 +01:00
Stefan Kangas
9878092d2b Minor copyedits in internals.texi
* doc/lispref/internals.texi (Writing Emacs Primitives): Minor
copyedits.
2025-01-19 14:30:31 +01:00