unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: 11503@debbugs.gnu.org
Subject: bug#11503: 24.0.96; `defvaralias' doc string and alias name not respected by Customize
Date: Thu, 17 May 2012 11:39:04 -0700	[thread overview]
Message-ID: <D9446EA8CB5C4E588B5BF0AA027A95F5@us.oracle.com> (raw)

(defcustom foo  t
  "Non-nil means foo it."
  :type 'boolean :group 'convenience)
 
(defvaralias 'bar 'foo
  "Non-nil means bar it.")
 
`C-h v bar' correctly says that bar is an alias for foo.  And it shows
the doc string for bar and provides a link to the doc string for foo.
It is clear to users what is going on.
 
`M-x customize bar' shows only the same thing as `M-x customize foo'.
 
Like `C-h v', customizing bar should (a) show the correct var name
(bar), (b) mention that it is an alias for foo, and (c) show bar's doc
string.  The mention of foo should include a link to foo's doc.  IOW,
same info that `C-h v' provides.
 
Being able to alias a variable in library toto, with prefix `toto-', to
a user option in library titi, with prefix `titi-', can be helpful for
users.  It can present them with not only a more relevant option name
for library toto, but also more relevant doc.  It can give them a toto
view of the variable.
 
The variable behavior can be described at different levels.  And the
behavior for library toto can be more complex - that is, the variable
value (which is obviously the same) can have toto-specific consequences.
For toto, the variable might do something additional.
 
Yes, it's the same variable/value in the end.  But speaking about it in
toto terms can be more accurate or more meaningful to a user of library
toto.
 

In GNU Emacs 24.0.96.1 (i386-mingw-nt5.1.2600)
 of 2012-04-28 on MARVIN
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.6) --no-opt --enable-checking --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'
 






             reply	other threads:[~2012-05-17 18:39 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-05-17 18:39 Drew Adams [this message]
2012-09-16 23:55 ` bug#11503: 24.0.96; `defvaralias' doc string and alias name not respected by Customize 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=D9446EA8CB5C4E588B5BF0AA027A95F5@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=11503@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).