unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Tino Calancha <tino.calancha@gmail.com>
To: monnier@iro.umontreal.ca
Cc: rgm@gnu.org, Emacs developers <emacs-devel@gnu.org>,
	bzg@gnu.org, tsdh@gnu.org, eliz@gnu.org, drew.adams@oracle.com
Subject: Re: Remove * characters from the front of variable docstrings
Date: Fri, 23 Sep 2016 19:32:52 +0900 (JST)	[thread overview]
Message-ID: <alpine.DEB.2.20.1609231926480.3880@calancha-pc> (raw)


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 <tino.calancha@gmail.com>
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	other threads:[~2016-09-23 10:32 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-23 10:32 Tino Calancha [this message]
  -- strict thread matches above, loose matches on Subject: below --
2012-04-26 18:08 Remove * characters from the front of variable docstrings Glenn Morris
2012-04-26 18:46 ` Glenn Morris
2012-04-26 18:51   ` Glenn Morris
2012-04-26 19:55     ` Tassilo Horn
2012-04-26 20:48       ` Bastien
2012-04-26 20:51     ` Bastien
2012-04-26 20:14 ` Eli Zaretskii
2012-04-26 20:43   ` Drew Adams
2012-04-26 20:54   ` Glenn Morris
2012-04-26 21:01 ` Stefan Monnier

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=alpine.DEB.2.20.1609231926480.3880@calancha-pc \
    --to=tino.calancha@gmail.com \
    --cc=bzg@gnu.org \
    --cc=drew.adams@oracle.com \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=rgm@gnu.org \
    --cc=tsdh@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).