From mboxrd@z Thu Jan  1 00:00:00 1970
Path: main.gmane.org!not-for-mail
From: Juanma Barranquero <lektu@terra.es>
Newsgroups: gmane.emacs.devel
Subject: Re: mentioning variable aliases in `describe-variable'
Date: Fri, 12 Jul 2002 12:17:48 +0200
Sender: emacs-devel-admin@gnu.org
Message-ID: <20020712121334.2E82.LEKTU@terra.es>
References: <200207111925.g6BJPuO03928@rum.cs.yale.edu> <E17SoJv-0001fs-00@bundalo.shootybangbang.com>
NNTP-Posting-Host: localhost.gmane.org
Mime-Version: 1.0
Content-Type: text/plain; charset="US-ASCII"
Content-Transfer-Encoding: 7bit
X-Trace: main.gmane.org 1026469177 2462 127.0.0.1 (12 Jul 2002 10:19:37 GMT)
X-Complaints-To: usenet@main.gmane.org
NNTP-Posting-Date: Fri, 12 Jul 2002 10:19:37 +0000 (UTC)
Cc: monnier+gnu/emacs@rum.cs.yale.edu, emacs-devel@gnu.org
Return-path: <emacs-devel-admin@gnu.org>
Original-Received: from quimby.gnus.org ([80.91.224.244])
	by main.gmane.org with esmtp (Exim 3.33 #1 (Debian))
	id 17SxWT-0000db-00
	for <emacs-devel@main.gmane.org>; Fri, 12 Jul 2002 12:19:37 +0200
Original-Received: from fencepost.gnu.org ([199.232.76.164])
	by quimby.gnus.org with esmtp (Exim 3.12 #1 (Debian))
	id 17SxgJ-0005T5-00
	for <emacs-devel@quimby.gnus.org>; Fri, 12 Jul 2002 12:29:47 +0200
Original-Received: from localhost ([127.0.0.1] helo=fencepost.gnu.org)
	by fencepost.gnu.org with esmtp (Exim 3.35 #1 (Debian))
	id 17SxW4-0002vG-00; Fri, 12 Jul 2002 06:19:12 -0400
Original-Received: from [62.22.27.141] (helo=mail.peoplecall.com)
	by fencepost.gnu.org with esmtp (Exim 3.35 #1 (Debian))
	id 17SxV1-0002tQ-00
	for <emacs-devel@gnu.org>; Fri, 12 Jul 2002 06:18:08 -0400
Original-Received: from [62.22.27.143] (jbarranquero.ofi.peoplecall.com [62.22.27.143])
	by mail.peoplecall.com (8.11.6/8.11.6) with ESMTP id g6CAHmM03478;
	Fri, 12 Jul 2002 12:17:48 +0200
Original-To: John Paul Wallington <jpw@shootybangbang.com>
In-Reply-To: <E17SoJv-0001fs-00@bundalo.shootybangbang.com>
X-Mailer: Becky! ver. 2.05
Errors-To: emacs-devel-admin@gnu.org
X-BeenThere: emacs-devel@gnu.org
X-Mailman-Version: 2.0.11
Precedence: bulk
List-Help: <mailto:emacs-devel-request@gnu.org?subject=help>
List-Post: <mailto:emacs-devel@gnu.org>
List-Subscribe: <http://mail.gnu.org/mailman/listinfo/emacs-devel>,
	<mailto:emacs-devel-request@gnu.org?subject=subscribe>
List-Id: Emacs development discussions. <emacs-devel.gnu.org>
List-Unsubscribe: <http://mail.gnu.org/mailman/listinfo/emacs-devel>,
	<mailto:emacs-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <http://mail.gnu.org/pipermail/emacs-devel/>
Xref: main.gmane.org gmane.emacs.devel:5700
X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:5700

On Fri, 12 Jul 2002 01:30:03 +0100, John Paul Wallington <jpw@shootybangbang.com> wrote:

> I like your suggestion.  How about this:

I like it near the top, too. Much cleaner, IMHO. Also it would make
sense to show the documentation for the aliased variable when describing
the alias. Now, for example:

> automatic-hscrolling's value is t
> 
> Documentation:
> Not documented as a variable.
> 
> This variable is an alias for `auto-hscroll-mode'.
> 
> Defined in `frame'.

but

> auto-hscroll-mode's value is t
> 
> Documentation:
> *Allow or disallow automatic scrolling windows horizontally.
> If non-nil, windows are automatically scrolled horizontally to make
> point visible.
> 
> You can customize this variable.
> 
> Defined in `frame'.

It's not very helpful to mention the aliased variable in the alias
description without the documentation, because that forces the user to
do another describe-variable. And `defvaralias' does not allow
introducing any new documentation for the alias, so there's no
posibility of conflict.

                                                           /L/e/k/t/u