From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 3 Nov 2023 07:41:11 +0000 (+0200)
Subject: ; Fix recent changes in documentation
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=12d1f33ceb37a2d0399af7e4054024c60a465ab8;p=emacs.git

; Fix recent changes in documentation

* lisp/man.el (Man-header-file-path, man): Doc fix.

* etc/NEWS: Fix wording.
---

diff --git a/etc/NEWS b/etc/NEWS
index 1390cb1cf6f..e29a787a0cc 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -693,10 +693,10 @@ asynchronously (which is the default behavior).
 
 +++
 *** New user option 'Man-support-remote-systems'.
-This option controls whether the man page is taken from the remote
-system when the current buffer is remote.  You can invoke the 'man'
-command with a prefix argument to reverse the value of this option
-only for the current invocation.
+This option controls whether the man page is formatted on the remote
+system when the current buffer's default-directory is remote.  You can
+invoke the 'man' command with a prefix argument to countermand the
+value of this option for the current invocation of 'man'.
 
 ** DocView
 
diff --git a/lisp/man.el b/lisp/man.el
index 28c71ba1e06..f18e2f50b7c 100644
--- a/lisp/man.el
+++ b/lisp/man.el
@@ -583,10 +583,11 @@ Otherwise, the value is whatever the function
       "/bin/sh"))
 
 (defun Man-header-file-path ()
-  "Return the C header file search path that Man uses.
+  "Return the C header file search path that Man should use.
 Normally, this is the value of the user option `Man-header-file-path',
-but when the man page is retrieved from a remote system this
-function tries to find the C header path on that system."
+but when the man page is formatted on a remote system (see
+`Man-support-remote-systems'), this function tries to figure out the
+list of directories where the remote system has the C header files."
   (let ((remote-id (file-remote-p default-directory)))
     (if (null remote-id)
         ;; The local case.
@@ -1091,7 +1092,7 @@ to auto-complete your input based on the installed manual pages.
 If `default-directory' is remote, and `Man-support-remote-systems'
 is non-nil, this command formats the man page on the remote system.
 A prefix argument reverses the value of `Man-support-remote-systems'
-for the current call."
+for the current invocation."
 
   (interactive
    (list (let* ((default-entry (Man-default-man-entry))