From unknown Thu Aug 14 21:46:56 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#907 <907@debbugs.gnu.org> To: bug#907 <907@debbugs.gnu.org> Subject: Status: 23.0.60; doc string for dired-do-create-files Reply-To: bug#907 <907@debbugs.gnu.org> Date: Fri, 15 Aug 2025 04:46:56 +0000 retitle 907 23.0.60; doc string for dired-do-create-files reassign 907 emacs submitter 907 "Drew Adams" severity 907 normal thanks From drew.adams@oracle.com Sat Sep 6 15:32:05 2008 X-Spam-Checker-Version: SpamAssassin 3.2.3-bugs.debian.org_2005_01_02 (2007-08-08) on rzlab.ucr.edu X-Spam-Level: X-Spam-Status: No, score=-6.6 required=4.0 tests=AWL,BAYES_00, RCVD_IN_DNSWL_MED,UNPARSEABLE_RELAY autolearn=ham version=3.2.3-bugs.debian.org_2005_01_02 Received: (at submit) by emacsbugs.donarmstrong.com; 6 Sep 2008 22:32:06 +0000 Received: from fencepost.gnu.org (fencepost.gnu.org [140.186.70.10]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id m86MW2EP017201 for ; Sat, 6 Sep 2008 15:32:03 -0700 Received: from mail.gnu.org ([199.232.76.166]:49638 helo=mx10.gnu.org) by fencepost.gnu.org with esmtp (Exim 4.67) (envelope-from ) id 1Kc6IN-0007Dx-LF for emacs-pretest-bug@gnu.org; Sat, 06 Sep 2008 18:30:19 -0400 Received: from Debian-exim by monty-python.gnu.org with spam-scanned (Exim 4.60) (envelope-from ) id 1Kc6Jx-0001gq-59 for emacs-pretest-bug@gnu.org; Sat, 06 Sep 2008 18:32:01 -0400 Received: from rgminet01.oracle.com ([148.87.113.118]:29874) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1Kc6Jw-0001gV-DR for emacs-pretest-bug@gnu.org; Sat, 06 Sep 2008 18:31:56 -0400 Received: from rgmgw2.us.oracle.com (rgmgw2.us.oracle.com [138.1.186.111]) by rgminet01.oracle.com (Switch-3.2.4/Switch-3.1.6) with ESMTP id m86MVr1f020284 for ; Sat, 6 Sep 2008 16:31:54 -0600 Received: from acsmt702.oracle.com (acsmt702.oracle.com [141.146.40.80]) by rgmgw2.us.oracle.com (Switch-3.2.4/Switch-3.2.4) with ESMTP id m86MVqrM017002 for ; Sat, 6 Sep 2008 16:31:52 -0600 Received: from dradamslap1 (/24.23.165.218) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sat, 06 Sep 2008 15:31:52 -0700 From: "Drew Adams" To: Subject: 23.0.60; doc string for dired-do-create-files Date: Sat, 6 Sep 2008 15:31:51 -0700 Message-ID: <000501c91070$5bc6b320$0200a8c0@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: AckQcFtl1AugDqtITgGm63JRzsijQA== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.3350 X-Brightmail-Tracker: AAAAAQAAAAI= X-Brightmail-Tracker: AAAAAQAAAAI= X-Whitelist: TRUE X-Whitelist: TRUE X-detected-kernel: by monty-python.gnu.org: Linux 2.4-2.6 emacs -Q Same problem exists in Emacs 22.2, BTW. The doc string of dired-do-create-files refers several times to `into-dir' (without quotes or uppercase). Nowhere is there any explanation of what is mean by this, however. Presumably, it is either a global variable or an argument? This renders the doc string incomprehensible. About 2/3 of the doc string concerns `into-dir', and it includes a seemingly ridiculously complex explanation of arg HOW-TO, complete with if-then-else-if-then-else-if-then-else-if-then-else (no exaggeration!). Please rewrite the doc string so that it is self-contained and readable. It should not simply mirror the code but should make clear to users what each argument is. In GNU Emacs 23.0.60.1 (i386-mingw-nt5.1.2600) of 2008-08-29 on LENNART-69DE564 Windowing system distributor `Microsoft Corp.', version 5.1.2600 configured using `configure --with-gcc (3.4) --no-opt --cflags -Ic:/g/include -fno-crossjumping' From drew.adams@oracle.com Sat Sep 6 15:56:40 2008 X-Spam-Checker-Version: SpamAssassin 3.2.3-bugs.debian.org_2005_01_02 (2007-08-08) on rzlab.ucr.edu X-Spam-Level: X-Spam-Status: No, score=-8.1 required=4.0 tests=AWL,BAYES_00,HAS_BUG_NUMBER, RCVD_IN_DNSWL_MED,UNPARSEABLE_RELAY autolearn=ham version=3.2.3-bugs.debian.org_2005_01_02 Received: (at submit) by emacsbugs.donarmstrong.com; 6 Sep 2008 22:56:41 +0000 Received: from fencepost.gnu.org (fencepost.gnu.org [140.186.70.10]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id m86Mub9q025758 for ; Sat, 6 Sep 2008 15:56:38 -0700 Received: from mail.gnu.org ([199.232.76.166]:50702 helo=mx10.gnu.org) by fencepost.gnu.org with esmtp (Exim 4.67) (envelope-from ) id 1Kc6gA-00082E-PQ for emacs-pretest-bug@gnu.org; Sat, 06 Sep 2008 18:54:54 -0400 Received: from Debian-exim by monty-python.gnu.org with spam-scanned (Exim 4.60) (envelope-from ) id 1Kc6hl-0004Jm-Jh for emacs-pretest-bug@gnu.org; Sat, 06 Sep 2008 18:56:37 -0400 Received: from rgminet01.oracle.com ([148.87.113.118]:32713) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1Kc6hl-0004DZ-85 for emacs-pretest-bug@gnu.org; Sat, 06 Sep 2008 18:56:33 -0400 Received: from rgmgw2.us.oracle.com (rgmgw2.us.oracle.com [138.1.186.111]) by rgminet01.oracle.com (Switch-3.2.4/Switch-3.1.6) with ESMTP id m86MtT9a032750; Sat, 6 Sep 2008 16:55:29 -0600 Received: from acsmt702.oracle.com (acsmt702.oracle.com [141.146.40.80]) by rgmgw2.us.oracle.com (Switch-3.2.4/Switch-3.2.4) with ESMTP id m86MtR27008145; Sat, 6 Sep 2008 16:55:27 -0600 Received: from dradamslap1 (/24.23.165.218) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sat, 06 Sep 2008 15:55:27 -0700 From: "Drew Adams" To: <907@debbugs.gnu.org>, References: <000501c91070$5bc6b320$0200a8c0@us.oracle.com> Subject: RE: bug#907: 23.0.60; doc string for dired-do-create-files Date: Sat, 6 Sep 2008 15:55:26 -0700 Message-ID: <000601c91073$a7951aa0$0200a8c0@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 In-Reply-To: <000501c91070$5bc6b320$0200a8c0@us.oracle.com> Thread-Index: AckQcFtl1AugDqtITgGm63JRzsijQAAAw2yA X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.3350 X-Brightmail-Tracker: AAAAAQAAAAI= X-Brightmail-Tracker: AAAAAQAAAAI= X-Whitelist: TRUE X-Whitelist: TRUE X-detected-kernel: by monty-python.gnu.org: Linux 2.4-2.6 X-CrossAssassin-Score: 2 I said: > This renders the doc string incomprehensible. About 2/3 of the doc > string concerns `into-dir', and it includes a seemingly ridiculously > complex explanation of arg HOW-TO, complete with > if-then-else-if-then-else-if-then-else-if-then-else (no > exaggeration!). I was a little mistaken. It's both a bit worse and a bit better than I thought. The last if-then-else-if-then-else supposedly explains HOW-TO; the first if-then-else-if-then-else supposedly explains `into-dir' (which is an internal, local variable). This is all backwards and not clear at all. What's needed is a single, straightforward explanation of HOW-TO, with no reference to `into-dir'. Looking at previous Emacs versions, I discovered that this doc string derives from a comment that was in the Emacs 20 code. The comment, which referred to local variable `into-dir', was simply copied to a (then missing) doc string. The rest still applies: > Please rewrite the doc string so that it is self-contained and > readable. It should not simply mirror the code but should make clear > to users what each argument is. From cyd@stupidchicken.com Wed Oct 22 13:21:50 2008 X-Spam-Checker-Version: SpamAssassin 3.2.3-bugs.debian.org_2005_01_02 (2007-08-08) on rzlab.ucr.edu X-Spam-Level: X-Spam-Status: No, score=-3.9 required=4.0 tests=AWL,BAYES_00 autolearn=ham version=3.2.3-bugs.debian.org_2005_01_02 Received: (at 907-done) by emacsbugs.donarmstrong.com; 22 Oct 2008 20:21:50 +0000 Received: from cyd.mit.edu (CYD.MIT.EDU [18.115.2.24]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id m9MKLlNH030064 for <907-done@emacsbugs.donarmstrong.com>; Wed, 22 Oct 2008 13:21:48 -0700 Received: by cyd.mit.edu (Postfix, from userid 1000) id D4D0457E04B; Wed, 22 Oct 2008 16:21:49 -0400 (EDT) From: Chong Yidong To: "Drew Adams" Cc: 907-done@debbugs.gnu.org Subject: Re: 23.0.60; doc string for dired-do-create-files Date: Wed, 22 Oct 2008 16:21:49 -0400 Message-ID: <87wsg0bcte.fsf@cyd.mit.edu> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii > The doc string of dired-do-create-files refers several times to > `into-dir' (without quotes or uppercase). Nowhere is there any > explanation of what is mean by this, however. Presumably, it is either > a global variable or an argument? Fixed, thanks. From unknown Thu Aug 14 21:46:56 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: $requester Subject: Internal Control Message-Id: bug archived. Date: Thu, 20 Nov 2008 15:24:04 +0000 User-Agent: Fakemail v42.6.9 # A New Hope # A log time ago, in a galaxy far, far away # something happened. # # Magically this resulted in the following # action being taken, but this fake control # message doesn't tell you why it happened # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator