From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Luc Teirlinck Newsgroups: gmane.emacs.devel Subject: Re: Double hyphens in variable names. Date: Fri, 3 Oct 2003 11:18:51 -0500 (CDT) Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <200310031618.h93GIpw14398@raven.dms.auburn.edu> References: <200310021318.h92DIWW05772@raven.dms.auburn.edu> NNTP-Posting-Host: deer.gmane.org X-Trace: sea.gmane.org 1065198433 32546 80.91.224.253 (3 Oct 2003 16:27:13 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Fri, 3 Oct 2003 16:27:13 +0000 (UTC) Cc: epameinondas@gmx.de, emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Fri Oct 03 18:27:10 2003 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1A5Slq-0002yw-00 for ; Fri, 03 Oct 2003 18:27:10 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1A5Slq-0002c9-00 for ; Fri, 03 Oct 2003 18:27:10 +0200 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.24) id 1A5Sk6-0002A1-27 for emacs-devel@quimby.gnus.org; Fri, 03 Oct 2003 12:25:22 -0400 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.24) id 1A5Sjn-00028q-3W for emacs-devel@gnu.org; Fri, 03 Oct 2003 12:25:03 -0400 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.24) id 1A5SjH-00021y-AT for emacs-devel@gnu.org; Fri, 03 Oct 2003 12:25:02 -0400 Original-Received: from [199.232.41.8] (helo=mx20.gnu.org) by monty-python.gnu.org with esmtp (TLSv1:DES-CBC3-SHA:168) (Exim 4.24) id 1A5SjH-0001zK-2d for emacs-devel@gnu.org; Fri, 03 Oct 2003 12:24:31 -0400 Original-Received: from [131.204.53.104] (helo=manatee.dms.auburn.edu) by mx20.gnu.org with esmtp (Exim 4.24) id 1A5Shv-0006g9-Ti for emacs-devel@gnu.org; Fri, 03 Oct 2003 12:23:08 -0400 Original-Received: from raven.dms.auburn.edu (raven.dms.auburn.edu [131.204.53.29]) by manatee.dms.auburn.edu (8.12.10/8.12.10) with ESMTP id h93GMiAJ025931; Fri, 3 Oct 2003 11:22:44 -0500 (CDT) Original-Received: (from teirllm@localhost) by raven.dms.auburn.edu (8.11.6+Sun/8.11.6) id h93GIpw14398; Fri, 3 Oct 2003 11:18:51 -0500 (CDT) X-Authentication-Warning: raven.dms.auburn.edu: teirllm set sender to teirllm@dms.auburn.edu using -f Original-To: Lute.Kamstra@cwi.nl In-reply-to: (message from Lute Kamstra on Fri, 03 Oct 2003 10:39:47 +0200) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.2 Precedence: list List-Id: Emacs development discussions. List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:16908 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:16908 Lute Kamstra wrote: Imenu's functionality can be easily explained without referring to imenu--info-alist, so I think I'll do that. I guess you really mean imenu--index-alist. If I understand correctly, (elisp)Imenu explains how a major mode author can help construct imenu--index-alist in various ways. The major mode author is not supposed to play around with imenu--index-alist directly. But is taking a look at imenu--index-alist not useful for the author to check his work? Also could knowing about the alist he is trying to construct with the other functions not be useful in understanding those other functions? (Assuming my above interpretation of the facts is correct). I saw you removed the documentation for the variable. If you really think it ought to be removed, then that is OK. I am not necessarily contesting that removal. You know the node better than I do. I just took a quick look at it. However, as a solution to the double dash problem, removal seems a little bit too radical. I believe the following works in all situations, main text and index of both Info and printed output: @defvar {imenu-@--index-alist} OK this is ugly, but you could mention in the Texinfo source in a comment that the ugliness is a work-around for a bug in Texinfo. The @- allows for a discretionary hyphen, but the text is short, so no problem. The braces around the entire name prevent the Info index from just listing `imenu-'. This will work even if the user does not have makeinfo 4.7 or higher. The current problems in Info need to be fixed, but any such fix will require the user to install make-info version 4.7 or higher. (I believe 4.6 is still the latest released version.) Sincerely, Luc.