From e27ec0e41442067e88d58459fbc9814429f1d3dc Mon Sep 17 00:00:00 2001
From: "Basil L. Contovounesios" <contovob@tcd.ie>
Date: Fri, 22 Sep 2023 11:27:29 +0200
Subject: [PATCH] Improve remote-file-name-inhibit-cache :type
* lisp/files.el (remote-file-name-inhibit-cache)
(shell-highlight-undef-remote-file-name-inhibit-cache): Avoid
duplicated :tag string. Try to clarify wording and
formatting (bug#66150).
* lisp/shell.el (shell--highlight-undef-exec-cache): Reference
correct user option in docstring.
---
lisp/files.el | 8 ++++----
lisp/shell.el | 16 ++++++++--------
2 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/lisp/files.el b/lisp/files.el
index 32c39a8cacb..b72f141c0ee 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -1318,10 +1318,10 @@ consecutive checks. For example:
:group 'files
:version "24.1"
:type '(choice
- (const :tag "Do not inhibit file name cache" nil)
- (const :tag "Do not use file name cache" t)
- (integer :tag "Do not use file name cache"
- :format "Do not use file name cache older then %v seconds"
+ (const :tag "Do not cache remote file attributes" t)
+ (const :tag "Cache remote file attributes" nil)
+ (integer :tag "Cache remote file attributes with expiration"
+ :format "Cache expiry in seconds: %v"
:value 10)))
(defun file-local-name (file)
diff --git a/lisp/shell.el b/lisp/shell.el
index f844e0496b0..2bdf094088d 100644
--- a/lisp/shell.el
+++ b/lisp/shell.el
@@ -1587,15 +1587,15 @@ Returns t if successful."
"Whether to inhibit cache for fontifying shell commands in remote buffers.
When fontification of non-existent commands is enabled in a
remote shell buffer, use a cache to speed up searching for
-executable files on the remote machine. This options is used to
-control expiry of this cache. See `remote-file-name-inhibit-cache'
-for description."
+executable files on the remote machine. This option controls
+expiry of the cache. See `remote-file-name-inhibit-cache' for
+a description of the possible options."
:group 'faces
:type '(choice
- (const :tag "Do not inhibit file name cache" nil)
- (const :tag "Do not use file name cache" t)
- (integer :tag "Do not use file name cache"
- :format "Do not use file name cache older than %v seconds"
+ (const :tag "Do not cache remote executables" t)
+ (const :tag "Cache remote executables" nil)
+ (integer :tag "Cache remote executables with expiration"
+ :format "Cache expiry in seconds: %v"
:value 10))
:version "29.1")
@@ -1608,7 +1608,7 @@ EXECUTABLES is a hash table with keys being the base-names of
executable files.
Cache expiry is controlled by the user option
-`remote-file-name-inhibit-cache'.")
+`shell-highlight-undef-remote-file-name-inhibit-cache'.")
(defvar shell--highlight-undef-face 'shell-highlight-undef-defined-face)
--
2.39.5