From 6623f3daaeecd1ec7cc24f3b0c534fa090b46ee1 Mon Sep 17 00:00:00 2001 From: Ted Zlatanov Date: Sat, 20 Dec 2014 06:14:04 -0500 Subject: [PATCH] * net/tramp-sh.el (tramp-histfile-override): Clarify docstring. --- lisp/ChangeLog | 4 ++++ lisp/net/tramp-sh.el | 10 ++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index b658cc1d0fa..0a76e813641 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,7 @@ +2014-12-20 Teodor Zlatanov + + * net/tramp-sh.el (tramp-histfile-override): Clarify docstring. + 2014-12-19 Artur Malabarba * let-alist.el (let-alist): Enable access to deeper alists by diff --git a/lisp/net/tramp-sh.el b/lisp/net/tramp-sh.el index c639af3c230..e4ba762379f 100644 --- a/lisp/net/tramp-sh.el +++ b/lisp/net/tramp-sh.el @@ -66,8 +66,14 @@ files conditionalize this setup based on the TERM environment variable." ;;;###tramp-autoload (defcustom tramp-histfile-override "/dev/null" - "Whether the HISTFILE should be overridden to something. Set -to nil to disable the override." + "When invoking a shell, override the HISTFILE with this value. +By default, the HISTFILE is set to the \"/dev/null\" value, which +is special on Unix systems and indicates the shell history should +not be logged (this avoids clutter due to Tramp commands). + +If you set this variable to nil, however, the *override* is +disabled, so the history will go to the default storage +location, e.g. \"$HOME/.sh_history\"." :group 'tramp :type '(choice (const :tag "Do not override HISTFILE" nil) (const :tag "Empty the history (/dev/null)" "/dev/null") -- 2.39.2