GNU bug report logs - #17567
24.4.50; doc string of `define-derived-mode'

Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.

Package: emacs; Severity: minor; Reported by: Drew Adams <drew.adams@HIDDEN>; merged with #20531; dated Fri, 23 May 2014 19:17:02 UTC; Maintainer for emacs is bug-gnu-emacs@HIDDEN.
Forcibly Merged 17567 20531. Request was from Lars Ingebrigtsen <larsi@HIDDEN> to control <at> debbugs.gnu.org. Full text available.

Message received at 17567 <at> debbugs.gnu.org:


Received: (at 17567) by debbugs.gnu.org; 23 May 2014 19:36:09 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Fri May 23 15:36:09 2014
Received: from localhost ([127.0.0.1]:58209 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.80)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1WnvGD-0001x6-6w
	for submit <at> debbugs.gnu.org; Fri, 23 May 2014 15:36:09 -0400
Received: from aserp1040.oracle.com ([141.146.126.69]:25896)
 by debbugs.gnu.org with esmtp (Exim 4.80)
 (envelope-from <drew.adams@HIDDEN>) id 1WnvG9-0001wU-Ng
 for 17567 <at> debbugs.gnu.org; Fri, 23 May 2014 15:36:06 -0400
Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238])
 by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id
 s4NJZwdB032090
 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK)
 for <17567 <at> debbugs.gnu.org>; Fri, 23 May 2014 19:35:59 GMT
Received: from userz7022.oracle.com (userz7022.oracle.com [156.151.31.86])
 by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s4NJZvCm000632
 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO)
 for <17567 <at> debbugs.gnu.org>; Fri, 23 May 2014 19:35:58 GMT
Received: from abhmp0003.oracle.com (abhmp0003.oracle.com [141.146.116.9])
 by userz7022.oracle.com (8.14.5+Sun/8.14.4) with ESMTP id s4NJZsrb028577
 for <17567 <at> debbugs.gnu.org>; Fri, 23 May 2014 19:35:56 GMT
MIME-Version: 1.0
Message-ID: <8e27e542-96e8-4342-a761-8c066fe3d307@default>
Date: Fri, 23 May 2014 12:35:53 -0700 (PDT)
From: Drew Adams <drew.adams@HIDDEN>
To: 17567 <at> debbugs.gnu.org
Subject: RE: bug#17567: 24.4.50; doc string of `define-derived-mode'
References: <ab3ae2a9-1af0-4851-a2be-0267491138a3@default>
In-Reply-To: <ab3ae2a9-1af0-4851-a2be-0267491138a3@default>
X-Priority: 3
X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8  (707110) [OL
 12.0.6691.5000 (x86)]
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: quoted-printable
X-Source-IP: acsinet22.oracle.com [141.146.126.238]
X-Spam-Score: -3.0 (---)
X-Debbugs-Envelope-To: 17567
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <http://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <http://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <http://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.0 (---)

Also, the doc string should state the types of the values of
keywords :group, :syntax-table, and :abbrev-table.

And it says that the mode runs the hook constructed by function
`derived-mode-hook-name'.  Constructed how?  What does constructed
mean here?

And the doc string of `derived-mode-hook-name' is no help here:
"Construct a mode-hook name based on a MODE name."

The arg is MODE.  What is it?  What data type?  And what is
its "name"?  What does it mean to construct a hook name?
And how is that name constructed from the "MODE name"?

And what about the contradiction between the doc string of
`define-derived-mode' and that of `derived-mode-hook-name'?
The former says that `d-m-h-name' constructs a _hook_.  The
latter says that it constructs a hook _name_.

Far clearer for `derived-mode-hook-name' would be to just
say what it really does:

  Return a symbol whose name is "-hook" appended to the
  `symbol-name' of MODE.

That also makes it clear that MODE is expected to be a symbol.

(Similarly, for the other `defsubst's in derived.el.)




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#17567; Package emacs. Full text available.

Message received at submit <at> debbugs.gnu.org:


Received: (at submit) by debbugs.gnu.org; 23 May 2014 19:16:18 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Fri May 23 15:16:18 2014
Received: from localhost ([127.0.0.1]:58200 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.80)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1Wnux0-0000B3-4A
	for submit <at> debbugs.gnu.org; Fri, 23 May 2014 15:16:18 -0400
Received: from eggs.gnu.org ([208.118.235.92]:55222)
 by debbugs.gnu.org with esmtp (Exim 4.80)
 (envelope-from <drew.adams@HIDDEN>) id 1Wnuwx-0000Ai-Tv
 for submit <at> debbugs.gnu.org; Fri, 23 May 2014 15:16:16 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <drew.adams@HIDDEN>) id 1Wnuwi-0006x6-Ei
 for submit <at> debbugs.gnu.org; Fri, 23 May 2014 15:16:10 -0400
X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org
X-Spam-Level: 
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=disabled
 version=3.3.2
Received: from lists.gnu.org ([2001:4830:134:3::11]:34021)
 by eggs.gnu.org with esmtp (Exim 4.71)
 (envelope-from <drew.adams@HIDDEN>) id 1Wnuwi-0006x0-Ag
 for submit <at> debbugs.gnu.org; Fri, 23 May 2014 15:16:00 -0400
Received: from eggs.gnu.org ([2001:4830:134:3::10]:56867)
 by lists.gnu.org with esmtp (Exim 4.71)
 (envelope-from <drew.adams@HIDDEN>) id 1WnuwZ-0006wg-8v
 for bug-gnu-emacs@HIDDEN; Fri, 23 May 2014 15:16:00 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <drew.adams@HIDDEN>) id 1WnuwQ-0006ti-Ia
 for bug-gnu-emacs@HIDDEN; Fri, 23 May 2014 15:15:51 -0400
Received: from aserp1040.oracle.com ([141.146.126.69]:47759)
 by eggs.gnu.org with esmtp (Exim 4.71)
 (envelope-from <drew.adams@HIDDEN>) id 1WnuwQ-0006tX-4X
 for bug-gnu-emacs@HIDDEN; Fri, 23 May 2014 15:15:42 -0400
Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94])
 by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id
 s4NJFeE6010839
 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK)
 for <bug-gnu-emacs@HIDDEN>; Fri, 23 May 2014 19:15:41 GMT
Received: from aserz7021.oracle.com (aserz7021.oracle.com [141.146.126.230])
 by ucsinet22.oracle.com (8.14.5+Sun/8.14.5) with ESMTP id s4NJFdFo009949
 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO)
 for <bug-gnu-emacs@HIDDEN>; Fri, 23 May 2014 19:15:40 GMT
Received: from abhmp0003.oracle.com (abhmp0003.oracle.com [141.146.116.9])
 by aserz7021.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s4NJFdnp017629
 for <bug-gnu-emacs@HIDDEN>; Fri, 23 May 2014 19:15:39 GMT
MIME-Version: 1.0
Message-ID: <ab3ae2a9-1af0-4851-a2be-0267491138a3@default>
Date: Fri, 23 May 2014 12:15:37 -0700 (PDT)
From: Drew Adams <drew.adams@HIDDEN>
To: bug-gnu-emacs@HIDDEN
Subject: 24.4.50; doc string of `define-derived-mode'
X-Priority: 3
X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8  (707110) [OL
 12.0.6691.5000 (x86)]
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: quoted-printable
X-Source-IP: ucsinet22.oracle.com [156.151.31.94]
X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic]
X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address
 (bad octet value).
X-Received-From: 2001:4830:134:3::11
X-Spam-Score: -4.0 (----)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <http://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <http://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <http://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -4.0 (----)

The doc string erroneously says that parameter NAME is "a string
which will appear in the status line".

Emacs does not have a "status line".  That term is used nowhere.

What should be said about NAME is that it defines the value of variable
`mode-name' for mode CHILD.  A user consulting that variable will see
that its value is used in the mode line etc.

In GNU Emacs 24.4.50.1 (i686-pc-mingw32)
 of 2014-05-17 on ODIEONE
Bzr revision: 117119 eggert@HIDDEN
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=3D/c/Devel/emacs/snapshot/trunk
 --enable-checking=3Dyes,glyphs 'CFLAGS=3D-O0 -g3'
 LDFLAGS=3D-Lc:/Devel/emacs/lib 'CPPFLAGS=3D-DGC_MCHECK=3D1
 -Ic:/Devel/emacs/include''




Acknowledgement sent to Drew Adams <drew.adams@HIDDEN>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs@HIDDEN. Full text available.
Report forwarded to bug-gnu-emacs@HIDDEN:
bug#17567; Package emacs. Full text available.
Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.
Last modified: Sat, 30 Apr 2016 19:30:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.