* lisp/net/tramp.el (tramp-signal-hook-function): Extend docstring.

This commit is contained in:
Michael Albinus 2026-02-22 10:33:40 +01:00
parent 2ae21d78ec
commit b1f24b3589

View file

@ -2148,10 +2148,11 @@ does not exist, otherwise propagate the error."
(tramp-error ,vec 'file-missing ,filename))
(signal (car ,err) (cdr ,err)))))))
;; This function provides traces in case of errors not triggered by
;; Tramp functions.
(defun tramp-signal-hook-function (error-symbol data)
"Function to be called via `signal-hook-function'."
"Function to be called via `signal-hook-function'.
It provides traces in case of errors not triggered by Tramp functions.
If there is an error which should not appear in Tramp traces, let-bind
`signal-hook-function' to nil around the respective code."
;; `custom-initialize-*' functions provoke `void-variable' errors.
;; We don't want to see them in the backtrace.
(declare (tramp-suppress-trace t))