1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-04-27 08:43:40 -07:00
Commit graph

12566 commits

Author SHA1 Message Date
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
Stefan Kangas
fa42626a6a ; Fix indentation in cl.texi example 2025-02-26 18:32:32 +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
Po Lu
734986349f ; Minor Android documentation improvements
* doc/emacs/android.texi (Android Startup, Android File System)
(Android Document Providers): Improve phrasing.
2025-02-26 15:10:27 +08:00
Basil L. Contovounesios
02c830ba22 Fix ert-font-lock macro signatures
* doc/misc/ert.texi (Syntax Highlighting Tests):
* test/lisp/emacs-lisp/ert-font-lock-tests.el
(test-line-comment-p--emacs-lisp, test-line-comment-p--shell-script)
(test-line-comment-p--javascript, test-line-comment-p--python)
(test-line-comment-p--c, test-macro-test--correct-highlighting)
(test-macro-test--docstring, test-macro-test--failing)
(test-macro-test--file, test-macro-test--file-no-asserts)
(test-macro-test--file-failing): Reindent macro calls.
(with-temp-buffer-str-mode): Evaluate macro arguments left-to-right.
(ert-font-lock--wrap-begin-end): Use rx for more robust composition.
(test-line-comment-p--php): Require that php-mode is callable, not
already loaded.

* lisp/emacs-lisp/ert-font-lock.el (ert-font-lock-deftest)
(ert-font-lock-deftest-file): NAME is not followed by an empty list
like in ert-deftest, so the optional DOCSTRING is actually the
second argument.  Adapt calling convention in docstring, and debug,
doc-string, and indent properties accordingly (bug#76372).  Fix
docstring grammar, document MAJOR-MODE, and avoid referring to a
file name as a path.
2025-02-25 11:02:55 +01:00
Ulrich Müller
94c0ea39a5 * doc/misc/efaq.texi (New in Emacs 30): Fix typo. (Bug#76518) 2025-02-24 10:32:47 +01: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
Eli Zaretskii
e9c4f642b9 ; * doc/emacs/package.texi (Package Installation): Add omitted index entry. 2025-02-15 12:12:30 +02:00
Eli Zaretskii
8c4294f370 ; Move index entries in user manual
* doc/emacs/package.texi (Packages): Move index entries from here...
(Package Installation): ...to here.  Index entries should be where
the main description of the subject can be found.
2025-02-15 12:08:41 +02:00
Stefan Kangas
b9b9c33dcb Fix (Non)GNU ELPA description in manual
* doc/emacs/package.texi (Packages): Move detailed (Non)GNU ELPA
description...
(Package Installation): ...here, and fix incorrect information.
2025-02-13 16:42:01 +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
Stefan Kangas
6701866be4 Document (Non-)GNU ELPA in emacs manual
* doc/emacs/package.texi (Packages): Document GNU ELPA and NonGNU
ELPA.  (Bug#59609)
2025-02-12 16:40:04 +01:00
Stefan Kangas
19791839cf ; Don't document a complicated default
* doc/misc/message.texi (Superseding): Don't document the default value
of 'message-ignored-supersedes-headers' here; the list was out-of-date,
and is likely to become out-of-date again in the future if updated.
It's also easy enough to look up for users outside of Info.
2025-02-11 16:48:23 +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