From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#17999: 24.4.50; `define-minor-mode' creates doc-string lines that are far too long Date: Fri, 11 Jul 2014 10:46:50 -0700 (PDT) Message-ID: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1405100917 15149 80.91.229.3 (11 Jul 2014 17:48:37 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 11 Jul 2014 17:48:37 +0000 (UTC) To: 17999@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jul 11 19:48:31 2014 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1X5evs-0002mF-VT for geb-bug-gnu-emacs@m.gmane.org; Fri, 11 Jul 2014 19:48:29 +0200 Original-Received: from localhost ([::1]:46097 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1X5evs-0006p7-IF for geb-bug-gnu-emacs@m.gmane.org; Fri, 11 Jul 2014 13:48:28 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:58271) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1X5evd-0006bg-TY for bug-gnu-emacs@gnu.org; Fri, 11 Jul 2014 13:48:24 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1X5evT-0005PB-Ah for bug-gnu-emacs@gnu.org; Fri, 11 Jul 2014 13:48:13 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:38920) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1X5evT-0005P2-7d for bug-gnu-emacs@gnu.org; Fri, 11 Jul 2014 13:48:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1X5evS-0000C0-F8 for bug-gnu-emacs@gnu.org; Fri, 11 Jul 2014 13:48:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 11 Jul 2014 17:48:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 17999 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.1405100861706 (code B ref -1); Fri, 11 Jul 2014 17:48:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 11 Jul 2014 17:47:41 +0000 Original-Received: from localhost ([127.0.0.1]:53719 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1X5ev3-0000BF-73 for submit@debbugs.gnu.org; Fri, 11 Jul 2014 13:47:41 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:55979) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1X5eux-0000Ai-27 for submit@debbugs.gnu.org; Fri, 11 Jul 2014 13:47:35 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1X5euh-0004fB-Cx for submit@debbugs.gnu.org; Fri, 11 Jul 2014 13:47:25 -0400 Original-Received: from lists.gnu.org ([208.118.235.17]:48730) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1X5euh-0004f5-9W for submit@debbugs.gnu.org; Fri, 11 Jul 2014 13:47:15 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:57548) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1X5euX-0006IX-O2 for bug-gnu-emacs@gnu.org; Fri, 11 Jul 2014 13:47:15 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1X5euN-0004TD-Og for bug-gnu-emacs@gnu.org; Fri, 11 Jul 2014 13:47:05 -0400 Original-Received: from userp1040.oracle.com ([156.151.31.81]:34582) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1X5euN-0004Sx-HR for bug-gnu-emacs@gnu.org; Fri, 11 Jul 2014 13:46:55 -0400 Original-Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id s6BHkr5w015493 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Fri, 11 Jul 2014 17:46:54 GMT Original-Received: from userz7021.oracle.com (userz7021.oracle.com [156.151.31.85]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s6BHkqEg010014 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL) for ; Fri, 11 Jul 2014 17:46:53 GMT Original-Received: from abhmp0015.oracle.com (abhmp0015.oracle.com [141.146.116.21]) by userz7021.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s6BHkpYv025586 for ; Fri, 11 Jul 2014 17:46:52 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6691.5000 (x86)] X-Source-IP: acsinet22.oracle.com [141.146.126.238] 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: GNU/Linux 2.6.x X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:91453 Archived-At: The automatically created doc string for the user option has a line like this, which can easily be far too long (it is unwrapped, though it might appear wrapped in this bug report): See the command `libprefix-the-possibly-long-mode-command-name' for a descr= iption of this minor mode. The line should be split after the command name. Or (better) the line should be automatically filled (wrapped as needed). To save some veribage you can also remove "the" from "the command" and "minor" from "minor mode". As a general rule, any macro that defines a function or variable should take care to create doc strings that are not longer than convention. In GNU Emacs 24.4.50.1 (i686-pc-mingw32) of 2014-06-28 on ODIEONE Bzr revision: 117431 rgm@gnu.org-20140628015517-eku6hj8mpgcvfnso 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''