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

12585 commits

Author SHA1 Message Date
Stephen Gildea
a7dffc2ea3 Document 'time-stamp-time-zone' in Emacs Manual
* doc/emacs/files.texi (Time Stamp Customization): Document
time-stamp-time-zone.
2025-05-08 14:48:22 -07:00
Eli Zaretskii
b172a1478c ; * doc/lispref/tips.texi (Library Headers): Fix wording (bug#78253). 2025-05-05 14:51:56 +03:00
Eli Zaretskii
1f998d11a5 ; * doc/misc/ert.texi (erts files): Improve indexing. 2025-05-03 10:34:43 +03:00
Eli Zaretskii
cc5b1a01a2 ; * doc/misc/efaq-w32.texi (Location of init file): Fix a typo. 2025-04-30 14:10:25 +03:00
Eli Zaretskii
80cbd1e31c ; Fix key notation in Introduction to Emacs Lisp
* doc/lispintro/emacs-lisp-intro.texi (Typing Lists)
(Note for Novices): Fix notation of 'M-C-\'.  (Bug#78153)
2025-04-30 09:03:17 +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
Eli Zaretskii
2a8e223b8d ; Mention early-init file in Emacs FAQ for Windows
* doc/misc/efaq-w32.texi (Location of init file, Init file):
Mention the early-init file.  Suggested by David Hedlund
<davidh@gnu.org>.
2025-04-29 09:05:28 +03:00
Sean Whitton
b5967dda32 ; * doc/misc/ert.texi (Introduction): Be more Lisp-specific. 2025-04-27 11:59:17 +08:00
Stephen Gildea
1f520db97b * doc/emacs/files.texi (Time Stamp Customization): Typo. 2025-04-25 18:37:39 -07:00
Sean Whitton
d824b66c24 ; * doc/emacs/search.texi (Isearch Yank): Improve flow. 2025-04-24 20:38:51 +08:00
Eli Zaretskii
49ea1f64c7 ; Improve documentation of 'modifier-bar-mode'
* doc/emacs/custom.texi (Modifier Keys):
* doc/emacs/frames.texi (Tool Bars):
* lisp/tool-bar.el (modifier-bar-mode): Improve documentation of
'modifier-bar-mode'.
2025-04-24 12:32:02 +03:00
Eli Zaretskii
a975232c0f ; * doc/emacs/programs.texi (Matching): Fix wording (bug#78021). 2025-04-24 12:07:56 +03:00
Eli Zaretskii
29142dab31 ; * doc/misc/efaq-w32.texi (MinGW-w64): Fix punctuation (bug#78005). 2025-04-23 16:18:26 +03:00
Sean Whitton
b901290ae7 * doc/lispref/text.texi (Margins): Grammar fix.
Author:
2025-04-18 14:31:50 +08:00
Eli Zaretskii
6509cc20a9 Improve documentation of 'user-emacs-directory'
* doc/emacs/custom.texi (Find Init): Document the effect of
'user-emacs-directory' on native compilation.  Advise against
changing the value of 'user-emacs-directory' in init files.
(Bug#77745)
2025-04-12 09:52:04 +03: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
e966ff9759 ; * doc/emacs/files.texi (Image Mode): Fix a typo (bug#77723). 2025-04-11 11:33:26 +03:00
Stephen Berman
ae7f65f3f9 Fix obsolete documentation of desktop library
* doc/emacs/misc.texi (Saving Emacs Sessions): Replace
documentation of the long-deleted user option
'desktop-clear-preserve-buffers-regexp' with documentation of
'desktop-clear-preserve-buffers'.
2025-04-03 16:53:35 +02:00
Michael Albinus
1e865a2f28 Explain, how to suppress Tramp warnings
* doc/misc/tramp.texi (Frequently Asked Questions): Remove double item.
(Traces and Profiles): Mention `warning-suppress-types'.  (Bug#77422)
2025-04-02 18:37:22 +02:00
Stephen Gildea
a096207474 printed manuals: xrefs in and out of "Preparing Patches"
Fix two cases of links where the on-line manual is one document but the
manual is split into separate documents for printing:

* doc/emacs/package.texi (Fetching Package Sources): fix printed link to
"Preparing Patches" to point to separate document.
* doc/emacs/vc1-xtra.texi (Preparing Patches): fix printed link to
"Directory Variables" to point to separate document.
2025-04-01 09:02:08 -07:00
Stephen Gildea
43c9eb3df6 Backport expansion of Time Stamp documentation
* doc/emacs/files.texi (Time Stamps): Add examples of enabling
time stamping with add-hook, setting time-stamp-pattern as a
file-local variable, and showing a time stamp at the end of a
file.  Divide into three sections.
* doc/emacs/emacs.texi: Add new nodes to menu.
* lisp/info.el (Info-file-list-for-emacs): Remove entry that
points Info at time-stamp discussion in the Autotype document.
* lisp/time-stamp.el (time-stamp-format, time-stamp-active,
time-stamp-count, time-stamp-pattern, time-stamp, time-stamp-string):
Expand doc strings.  Include Info cross-references.

Cherry picked from commits on the main branch.
Do not merge to master.
2025-03-30 11:39:53 -07:00
Eli Zaretskii
38fec86281 ; Improve the documentation of 'slice' display spec (bug#77384). 2025-03-30 19:27:22 +03:00
Michael Albinus
10991877c8 Sync with Tramp 2.7.3-pre
* doc/misc/tramp.texi: Use @dots{} where appropriate.
(External methods): Precise remark on rsync speed.
(Customizing Methods): Add incus-tramp.
(Password handling): Mention expiration of cached passwords when a
session timeout happens.
(Predefined connection information): Mention also "androidsu" as
special case of "tmpdir".
(Ad-hoc multi-hops, Frequently Asked Questions):
Improve description how ad-hoc multi-hop file names can be made
persistent.  (Bug#65039, Bug#76457)
(Remote processes): Signals are not delivered to remote direct
async processes.  Say, that there are restrictions for transfer of
binary data to remote direct async processes.
(Bug Reports): Explain bisecting.
(Frequently Asked Questions): Improve index.  Speak about
fingerprint readers.  Recommend `small-temporary-file-directory'
for ssh sockets.
(External packages): Rename subsection "Timers, process filters,
process sentinels, redisplay".
(Extension packages): New node.
(Top, Files directories and localnames): Add it to @menu.

* doc/misc/trampver.texi:
* lisp/net/trampver.el (tramp-version): Adapt Tramp versions.
(tramp-repository-branch, tramp-repository-version):
Remove ;;;###tramp-autoload cookie.

* lisp/net/tramp-adb.el:
* lisp/net/tramp-androidsu.el:
* lisp/net/tramp-cache.el:
* lisp/net/tramp-cmds.el:
* lisp/net/tramp-compat.el:
* lisp/net/tramp-container.el:
* lisp/net/tramp-crypt.el:
* lisp/net/tramp-ftp.el:
* lisp/net/tramp-fuse.el:
* lisp/net/tramp-gvfs.el:
* lisp/net/tramp-integration.el:
* lisp/net/tramp-message.el:
* lisp/net/tramp-rclone.el:
* lisp/net/tramp-sh.el:
* lisp/net/tramp-smb.el:
* lisp/net/tramp-sshfs.el:
* lisp/net/tramp-sudoedit.el:
* lisp/net/tramp.el: Use `when-let*', `if-let*' and `and-let*'
consequently.  (Bug#73441)

* lisp/net/tramp-adb.el (tramp-adb-maybe-open-connection):
Move setting of sentinel up.

* lisp/net/tramp-archive.el (tramp-archive-file-name-p):
Add ;;;###tramp-autoload cookie.
(tramp-archive-local-file-name): New defun.

* lisp/net/tramp-cache.el (tramp-connection-properties): Add link
to the Tramp manual in the docstring.
(tramp-get-connection-property, tramp-set-connection-property):
Don't raise a debug message for the `tramp-cache-version' key.
(with-tramp-saved-connection-property)
(with-tramp-saved-connection-properties): Add traces.
(tramp-dump-connection-properties): Don't save connection property
"pw-spec".

* lisp/net/tramp-cmds.el (tramp-repository-branch)
(tramp-repository-version): Declare.

* lisp/net/tramp-gvfs.el (tramp-gvfs-do-copy-or-rename-file):
(tramp-gvfs-do-copy-or-rename-file): Don't use the truename.
Handle symlinks.
(tramp-gvfs-local-file-name): New defun.

* lisp/net/tramp-message.el (tramp-repository-branch)
(tramp-repository-version): Declare.
(tramp-error-with-buffer, tramp-user-error): Don't redisplay in
`sit-for'.  (Bug#73718)
(tramp-warning): Fix `lwarn' call.

* lisp/net/tramp.el (tramp-read-passwd):
* lisp/net/tramp-sh.el (tramp-maybe-open-connection):
* lisp/net/tramp-sudoedit.el (tramp-sudoedit-send-command):
Rename connection property "password-vector" to "pw-vector".

* lisp/net/tramp-sh.el (tramp-methods) <pscp, psftp>:
Adapt `tramp-copy-args' argument.
(tramp-get-remote-pipe-buf, tramp-actions-before-shell):
Use `tramp-fingerprint-prompt-regexp'.
(tramp-sh-handle-copy-directory):
Apply `tramp-do-copy-or-rename-file-directly' if possible.
(tramp-do-copy-or-rename-file): Refactor.  Handle symlinks.
(Bug#76678)
(tramp-plink-option-exists-p): New defun.
(tramp-ssh-or-plink-options): Rename from
`tramp-ssh-controlmaster-options'.  Adapt further plink options.
(tramp-do-copy-or-rename-file-out-of-band)
(tramp-maybe-open-connection): Adapt calls.
(tramp-sh-handle-make-process): Don't set connection property
"remote-pid", it's unused.
(tramp-sh-handle-process-file): Do proper quoting.
(tramp-vc-file-name-handler): Add `file-directory-p', which is
used in `vc-find-root'.  (Bug#74026)
(tramp-maybe-open-connection): Use connection property "hop-vector".
(tramp-get-remote-pipe-buf): Make it more robust.

* lisp/net/tramp-smb.el (tramp-smb-errors): Add string.
(tramp-smb-handle-copy-directory): Don't check existence of
DIRNAME, this is done in `tramp-skeleton-copy-directory' already.
(tramp-smb-handle-copy-file, tramp-smb-handle-rename-file): Refactor.

* lisp/net/tramp-sshfs.el (tramp-sshfs-handle-process-file):
STDERR is not implemented.

* lisp/net/tramp-sudoedit.el (tramp-sudoedit-do-copy-or-rename-file):
Don't use the truename.  Handle symlinks.

* lisp/net/tramp.el (tramp-mode): Set to nil on MS-DOS.
(tramp-otp-password-prompt-regexp): Add TACC HPC prompt.
(tramp-wrong-passwd-regexp): Add fingerprint messages.
(tramp-fingerprint-prompt-regexp, tramp-use-fingerprint):
New defcustoms.
(tramp-string-empty-or-nil-p):
Declare `tramp-suppress-trace' property.
(tramp-barf-if-file-missing): Accept also symlinks.
(tramp-skeleton-file-exists-p)
(tramp-handle-file-directory-p): Protect against cyclic symlinks.
(tramp-skeleton-make-symbolic-link): Drop volume letter when flushing.
(tramp-skeleton-process-file): Raise a warning if STDERR is not
implemented.
(tramp-skeleton-set-file-modes-times-uid-gid): Fix typo.
(tramp-compute-multi-hops): Check for
`tramp-sh-file-name-handler-p', it works only for this.
(tramp-handle-shell-command):
Respect `async-shell-command-display-buffer'.
(tramp-action-password, tramp-process-actions): Use connection
property "hop-vector".
(tramp-action-fingerprint, tramp-action-show-message): New defuns.
(tramp-action-show-and-confirm-message): Start check at (point-min).
(tramp-wait-for-regexp): Don't redisplay in `sit-for'.  (Bug#73718)
(tramp-convert-file-attributes): Don't cache
"file-attributes-ID-FORMAT".
(tramp-read-passwd, tramp-clear-passwd): Rewrite.  (Bug#74105)

* test/lisp/net/tramp-tests.el (auth-source-cache-expiry)
(ert-batch-backtrace-right-margin): Set them to nil.
(vc-handled-backends): Suppress if noninteractive.
(tramp--test-enabled): Cleanup also
`tramp-compat-temporary-file-directory'.
(tramp-test11-copy-file, tramp-test12-rename-file)
(tramp-test18-file-attributes, tramp--test-deftest-with-stat)
(tramp--test-deftest-with-perl, tramp--test-deftest-with-ls)
(tramp--test-deftest-without-file-attributes)
(tramp-test21-file-links, tramp-test28-process-file)
(tramp-test32-shell-command, tramp-test36-vc-registered)
(tramp-test39-make-lock-file-name, tramp--test-check-files)
(tramp-test42-utf8, tramp-test43-file-system-info)
(tramp-test44-file-user-group-ids, tramp-test47-read-password):
Adapt tests.
(tramp-test47-read-fingerprint): New test.
2025-03-30 15:53:47 +02: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
9a07d64f5c ; Minor update in ack.texi
* doc/emacs/ack.texi (Acknowledgments): Mention eglot in entry for João
Távora.
2025-03-26 01:09:54 +01: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
dc80a8f050 ; Add index entry "code completion" to user manual
* doc/emacs/programs.texi (Symbol Completion): Improve indexing by
adding "code completion".  This is the name that this feature goes by
elsewhere, so users are likely to look for it.
2025-03-22 09:05:08 +01:00
Eli Zaretskii
0d9b14ed05 ; * doc/emacs/programs.texi (Program Modes): Add info about Eglot. 2025-03-22 09:04:48 +02:00
Eli Zaretskii
2d12754ee2 ; Add indexing for Eglot in user manual
* doc/emacs/programs.texi (Imenu, Programming Language Doc)
(Symbol Completion):
* doc/emacs/maintaining.texi (Xref): Index Eglot-related
functionalities.
2025-03-20 10:41:26 +02:00
Stefan Kangas
a30b9b640b ; Change some instances of cl to cl-lib in docs
* doc/misc/cl.texi (Overview):
* doc/misc/eieio.texi (CLOS compatibility, Wish List): Change 'cl' to
'cl-lib' where appropriate.
2025-03-20 02:05:55 +01:00
Stefan Kangas
b681d62436 ; Improve introduction to use-package manual
* doc/misc/use-package.texi (Top): Improve introduction.
2025-03-19 21:29:26 +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
Stefan Kangas
227db70db9 ; * doc/misc/ede.texi (Top): Improve introduction. 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
Jeremy Bryant
f729828bcf ; Add texinfo reference to GNU Coding Standards.
* doc/emacs/trouble.texi (Coding Standards): Add texinfo reference to
GNU Coding Standards manual.  (Bug#76901)
2025-03-13 07:12:26 +01: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
7d0d61d854 Rewrite ERT manual introduction
* doc/misc/ert.texi (Top): Rewrite for clarity.  Don't give such
prominent mention to to TDD or JUnit, references which now seem dated.
2025-03-09 19:38:54 +01:00
Po Lu
1b80bc67aa ; * doc/emacs/android.texi (Android Software): Minor markup nits. 2025-03-04 14:30:31 +08:00
Po Lu
b09bbf22af Document requirements respecting XDG MIME databases on Android
* doc/emacs/android.texi (Android Software): State that librsvg
requires a MIME database to display embedded images, and how to
acquire such a database.
2025-03-04 14:29:37 +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
44a770b871 ; Improve documentation of 'rmail-movemail-program'
* lisp/mail/rmail.el (rmail-movemail-program):
* doc/emacs/rmail.texi (Movemail): Document how to change the
value of 'rmail-movemail-program' safely.  (Bug#76595)
2025-03-01 15:45:57 +02: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