Improve Tramp documentation on direct async processes
authorMichael Albinus <michael.albinus@gmx.de>
Sun, 3 Nov 2024 14:48:19 +0000 (15:48 +0100)
committerMichael Albinus <michael.albinus@gmx.de>
Sun, 3 Nov 2024 14:48:19 +0000 (15:48 +0100)
* doc/misc/tramp.texi (Remote processes): Add another example
enabling direct async processes based on method name.  (Bug#74105)

* etc/NEWS: Rephrase Tramp entry on direct async processes.

doc/misc/tramp.texi
etc/NEWS

index 69572a139ffb2b503b85d9fd306c045fc5bb1892..9895b3c6fce4bf30e040efae0d8f97674e1b7daf 100644 (file)
@@ -4549,6 +4549,18 @@ which must be set to a non-@code{nil} value.  Example:
 @end group
 @end lisp
 
+This enables direct async processes for the host @samp{remotehost}.
+If you want to enable direct async processes for all remote hosts
+connected via the same method (e.g., @option{ssh}), use instead
+
+@lisp
+@group
+(connection-local-set-profiles
+ '(:application tramp :protocol "ssh")
+ 'remote-direct-async-process)
+@end group
+@end lisp
+
 Using direct asynchronous processes in @value{tramp} is not possible,
 if the remote host is connected via multiple hops
 (@pxref{Multi-hops}).  In this case, @value{tramp} falls back to its
index ebb9d49d560633e65639e516ffedcc2a92bf90d7..fbc29206039df8ec29ec37825d1f22252417fef8 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1413,10 +1413,12 @@ method but "sudo" can be configured with user option
 +++
 *** Direct asynchronous processes are indicated by a connection-local variable.
 If direct asynchronous processes shall be used, set the connection-local
-variable 'tramp-direct-async-process' to a non-nil value.  This has been
-changed, in previous Emacs versions this was indicated by the now
-deprecated connection property "direct-async-process".  See the Tramp
-manual "(tramp) Improving performance of asynchronous remote processes".
+variable 'tramp-direct-async-process' to a non-nil value.  In previous
+Emacs versions this was indicated by the connection property
+"direct-async-process".  That connection property (though not connection
+properties and 'tramp-connection-properties' in general) is now
+deprecated.  See the Tramp manual "(tramp) Improving performance of
+asynchronous remote processes".
 
 ---
 *** Direct asynchronous processes use 'tramp-remote-path'.