unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: 10475@debbugs.gnu.org
Subject: bug#10475: 24.0.92; `C-h v' displays `*' indicating user option
Date: Tue, 10 Jan 2012 14:08:51 -0800	[thread overview]
Message-ID: <18E370DBB9F14AD7AAE6181C1CB116B7@us.oracle.com> (raw)

(defcustom foo nil
  "*A foobar function or nil."
  :type '(choice (const :tag "None" nil) function)
  :group 'convenience)
 
Then `C-h v foo'.  The `*' indicating that this is a user variable
(e.g. usable by `set-variable') is printed as if it were part of the
doc.  It should be removed.
 
The fix is trivial:
(when (eq ?* (elt doc 0))  (setq doc  (substring doc 1)))
 
Yes, Emacs no longer requires a `*' as a doc-string prefix with
`defcustom'.  But `describe-variable' should still DTRT with doc strings
from code that is designed to work also with older Emacs versions.
 
In addition, `user-variable-p' is the test used for functions such as
`set-variable', and it`user-variable-p' recognizes the `*' as defining a
user variable.  This is correct behavior.  The only problem is that
`describe-variable' should not treat this `*' as if it were part of the
doc text.
 
In GNU Emacs 24.0.92.1 (i386-mingw-nt5.1.2600) of 2012-01-05 on MARVIN
 Windowing system distributor `Microsoft Corp.', version 5.1.2600
 configured using `configure --with-gcc (4.6) --no-opt --cflags
 -ID:/devel/emacs/libs/libXpm-3.5.8/include
 -ID:/devel/emacs/libs/libXpm-3.5.8/src
 -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
 -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
 -ID:/devel/emacs/libs/giflib-4.1.4-1/include
 -ID:/devel/emacs/libs/jpeg-6b-4/include
 -ID:/devel/emacs/libs/tiff-3.8.2-1/include
 -ID:/devel/emacs/libs/gnutls-3.0.9/include --ldflags
 -LD:/devel/emacs/libs/gnutls-3.0.9/lib'
 






             reply	other threads:[~2012-01-10 22:08 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-01-10 22:08 Drew Adams [this message]
2016-04-28 12:01 ` bug#10475: 24.0.92; `C-h v' displays `*' indicating user option Lars Ingebrigtsen
2016-04-28 14:16   ` Drew Adams
2016-04-28 16:50     ` Drew Adams

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=18E370DBB9F14AD7AAE6181C1CB116B7@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=10475@debbugs.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).