emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Remove * characters from the front of variable docstrings


From: Tino Calancha
Subject: Re: Remove * characters from the front of variable docstrings
Date: Fri, 23 Sep 2016 19:32:52 +0900 (JST)
User-agent: Alpine 2.20 (DEB 67 2015-01-07)


This is about discussion in:
https://lists.gnu.org/archive/html/emacs-devel/2012-04/msg00788.html

On Thu, 26 Apr 2012, Stefan Monnier wrote:

On Thu, 26 Apr 2012, Glenn Morris wrote:
However, hasn't some information been lost in the process?

Yup.  It should only have been applied to defcustoms.

Shouldn't it (and other defvars with *s) have been converted to
defcustoms?

They should be converted to defcustoms, indeed, and only after that can
the * be removed.

How about updating `shell-command-default-error-buffer' to a defcustom?
See patch below:

PD: There are more cases in commit fb7ada5f: defvar's
having before doc strings starting with '*', and not being now a defcustom.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
From f10d2c98c2d3c6e0e5caf6b970c27c59176036a3 Mon Sep 17 00:00:00 2001
From: Tino Calancha <address@hidden>
Date: Fri, 23 Sep 2016 19:16:00 +0900
Subject: [PATCH] * lisp/simple.el (shell-command-default-error-buffer): Make a
 defcustom.

---
 lisp/simple.el | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/lisp/simple.el b/lisp/simple.el
index 7e68baa..196361d 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -3152,11 +3152,16 @@ shell-command-history
 (defvar shell-command-switch (purecopy "-c")
   "Switch used to have the shell execute its command line argument.")

-(defvar shell-command-default-error-buffer nil
+(defcustom shell-command-default-error-buffer nil
"Buffer name for `shell-command' and `shell-command-on-region' error output.
 This buffer is used when `shell-command' or `shell-command-on-region'
 is run interactively.  A value of nil means that output to stderr and
-stdout will be intermixed in the output stream.")
+stdout will be intermixed in the output stream."
+  :type '(choice
+          (const :tag "None" nil)
+          (string "*Shell Command Error*"))
+  :group 'shell
+  :version "25.2")

 (declare-function mailcap-file-default-commands "mailcap" (files))
(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
--
2.9.3


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

In GNU Emacs 25.2.50.1 (x86_64-pc-linux-gnu, GTK+ Version 3.22.0)
 of 2016-09-23
Repository revision: 65dc67c87553bec4c8b36432246b13f09d653118




reply via email to

[Prev in Thread] Current Thread [Next in Thread]