From unknown Thu Sep 11 10:04:33 2025 X-Loop: help-debbugs@gnu.org Subject: bug#55761: 28.1; improvement on doc string Resent-From: Ikumi Keita Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 02 Jun 2022 11:55:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 55761 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: 55761@debbugs.gnu.org X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.165417085025064 (code B ref -1); Thu, 02 Jun 2022 11:55:02 +0000 Received: (at submit) by debbugs.gnu.org; 2 Jun 2022 11:54:10 +0000 Received: from localhost ([127.0.0.1]:52965 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nwjOz-0006WC-Px for submit@debbugs.gnu.org; Thu, 02 Jun 2022 07:54:10 -0400 Received: from lists.gnu.org ([209.51.188.17]:59416) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nwjOx-0006W4-Kp for submit@debbugs.gnu.org; Thu, 02 Jun 2022 07:54:08 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:45928) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nwjOx-0004mw-AJ for bug-gnu-emacs@gnu.org; Thu, 02 Jun 2022 07:54:07 -0400 Received: from smtp1a.inetd.co.jp ([210.129.88.11]:51100) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nwjOu-0000FA-J0 for bug-gnu-emacs@gnu.org; Thu, 02 Jun 2022 07:54:07 -0400 Received: from localhost (61-24-175-238.rev.home.ne.jp [61.24.175.238]) by smtp1a.inetd.co.jp (Postfix) with ESMTPA id 06C742D7 for ; Thu, 2 Jun 2022 20:53:57 +0900 (JST) From: Ikumi Keita X-Mailer: MH-E 8.6+git; nmh 1.7.1; GNU Emacs 28.1 MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Date: Thu, 02 Jun 2022 20:53:56 +0900 Message-ID: <2170.1654170836@localhost> Received-SPF: pass client-ip=210.129.88.11; envelope-from=ikumi@ikumi.que.jp; helo=smtp1a.inetd.co.jp X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.3 (-) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) --=-=-= Content-Type: text/plain I'd like to propose the attached patch. Here is a portion of output of C-h f find-file RET: ,---- | Switch to a buffer visiting file FILENAME, | [...] | type M-x next-history-element to pull it into the minibuffer. | | The first time M-x next-history-element is used after Emacs prompts for | [...] | current directory to be available on first M-x next-history-element | request. `---- The appearances of "M-x next-history-element" don't look nice to me. I hope the attached patch to be a starting point for revising the doc strings of `find-file' and its cousins. Regards, Ikumi Keita #StandWithUkraine #StopWarInUkraine --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=patch Content-Description: tentative porposal for revising doc srings diff --git a/lisp/files.el b/lisp/files.el --- a/lisp/files.el +++ b/lisp/files.el @@ -1706,7 +1706,7 @@ (defun find-file (filename &optional wildcards) "Edit file FILENAME. -Switch to a buffer visiting file FILENAME, +\\Switch to a buffer visiting file FILENAME, creating one if none already exists. Interactively, the default if you just type RET is the current directory, but the visited file name is available through the minibuffer history: @@ -1731,7 +1731,7 @@ expand wildcards (if any) and visit multiple files. You can suppress wildcard expansion by setting `find-file-wildcards' to nil. -To visit a file without any kind of conversion and without +\\To visit a file without any kind of conversion and without automatically choosing a major mode, use \\[find-file-literally]." (interactive (find-file-read-args "Find file: " @@ -1747,6 +1747,7 @@ Like \\[find-file] (which see), but creates a new window or reuses an existing one. See the function `display-buffer'. +\\\ Interactively, the default if you just type RET is the current directory, but the visited file name is available through the minibuffer history: type \\[next-history-element] to pull it into the minibuffer. @@ -1779,6 +1780,7 @@ Like \\[find-file] (which see), but creates a new frame or reuses an existing one. See the function `display-buffer'. +\\\ Interactively, the default if you just type RET is the current directory, but the visited file name is available through the minibuffer history: type \\[next-history-element] to pull it into the minibuffer. --=-=-= Content-Type: text/plain In GNU Emacs 28.1 (build 1, x86_64-unknown-freebsd13.0, GTK+ Version 3.24.33, cairo version 1.17.4) of 2022-05-10 built on freebsd.vmware Windowing system distributor 'The X.Org Foundation', version 11.0.12014000 System Description: 13.1-RELEASE Configured using: 'configure --with-canna --with-canna-includes=/usr/local/canna/include --with-canna-libraries=/usr/local/canna/lib --without-xim --disable-largefile --without-modules --with-sound=yes --with-file-notification=yes CFLAGS=-O3' Configured features: ACL CAIRO DBUS FREETYPE GIF GLIB GNUTLS GSETTINGS HARFBUZZ JPEG JSON LCMS2 LIBXML2 NOTIFY KQUEUE PDUMPER PNG RSVG SOUND THREADS TIFF TOOLKIT_SCROLL_BARS X11 XDBE XIM XPM GTK3 ZLIB Important settings: value of $EMACSLOADPATH: /home/keita/elisp: value of $LANG: ja_JP.eucJP locale-coding-system: japanese-iso-8bit-unix Major mode: Lisp Interaction Minor modes in effect: global-git-commit-mode: t magit-auto-revert-mode: t shell-dirtrack-mode: t tooltip-mode: t global-eldoc-mode: t eldoc-mode: t show-paren-mode: t mouse-wheel-mode: t tool-bar-mode: t menu-bar-mode: t file-name-shadow-mode: t global-font-lock-mode: t font-lock-mode: t blink-cursor-mode: t auto-composition-mode: t auto-encryption-mode: t auto-compression-mode: t line-number-mode: t indent-tabs-mode: t transient-mark-mode: t Load-path shadows: /home/keita/.emacs.d/elpa/transient-20220406.1156/transient hides /usr/local/share/emacs/28.1/lisp/transient ~/elisp/reftex-parse hides /usr/local/share/emacs/28.1/lisp/textmodes/reftex-parse /home/keita/.emacs.d/elpa/soap-client-3.2.1/soap-inspect hides /usr/local/share/emacs/28.1/lisp/net/soap-inspect /home/keita/.emacs.d/elpa/soap-client-3.2.1/soap-client hides /usr/local/share/emacs/28.1/lisp/net/soap-client Features: (shadow emacsbug misearch multi-isearch vc-dispatcher vc-hg bug-reference face-remap magit-submodule magit-obsolete magit-blame magit-stash magit-reflog magit-bisect magit-push magit-pull magit-fetch magit-clone magit-remote magit-commit magit-sequence magit-notes magit-worktree magit-tag magit-merge magit-branch magit-reset magit-files magit-refs magit-status magit magit-repos magit-apply magit-wip magit-log magit-diff smerge-mode diff diff-mode git-commit rx log-edit easy-mmode pcvs-util add-log magit-core magit-autorevert autorevert filenotify magit-margin magit-transient magit-process with-editor shell pcomplete comint ring server ansi-color magit-mode transient cl-extra help-mode magit-git magit-base magit-section format-spec dash mh-thread mh-identity mh-letter mh-comp sendmail mh-search smiley qp mm-archive mail-extr mh-mime mh-gnus mh-alias multi-prompt crm mh-show goto-addr thingatpt gnus-cite gnus-art mm-uu mml2015 mm-view mml-smime smime dig gnus-sum shr kinsoku svg dom gnus-group gnus-undo gnus-start gnus-dbus dbus xml gnus-cloud nnimap nnmail mail-source utf7 netrc nnoo parse-time iso8601 gnus-spec gnus-int message rmc puny dired dired-loaddefs rfc822 mml mml-sec epa derived epg rfc6068 epg-config mm-decode mm-bodies mm-encode mail-parse rfc2231 gmm-utils mailheader gnus-win gnus-range gnus nnheader wid-edit mh-seq mh-inc hl-line mh-tool-bar mh-xface mh-utils mh-folder which-func imenu gnus-util rmail rmail-loaddefs rfc2047 rfc2045 ietf-drums mm-util mail-prsvr mail-utils text-property-search time-date mh-scan mh-e mh-compat mailabbrev mh-buffers mh-loaddefs edmacro kmacro preview-latex auto-loads tex-site canna-im info package browse-url url url-proxy url-privacy url-expand url-methods url-history url-cookie url-domsuf url-util mailcap url-handlers url-parse auth-source cl-seq eieio eieio-core cl-macs eieio-loaddefs password-cache json subr-x map url-vars seq byte-opt gv bytecomp byte-compile cconv cl-loaddefs cl-lib japan-util iso-transl tooltip eldoc paren electric uniquify ediff-hook vc-hooks lisp-float-type elisp-mode mwheel term/x-win x-win term/common-win x-dnd tool-bar dnd fontset image regexp-opt fringe tabulated-list replace newcomment text-mode lisp-mode prog-mode register page tab-bar menu-bar rfn-eshadow isearch easymenu timer select scroll-bar mouse jit-lock font-lock syntax font-core term/tty-colors frame minibuffer cl-generic cham georgian utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek romanian slovak czech european ethiopic indian cyrillic chinese composite emoji-zwj charscript charprop case-table epa-hook jka-cmpr-hook help simple abbrev obarray cl-preloaded nadvice button loaddefs faces cus-face macroexp files window text-properties overlay sha1 md5 base64 format env code-pages mule custom widget hashtable-print-readable backquote threads dbusbind kqueue lcms2 dynamic-setting system-font-setting font-render-setting cairo move-toolbar gtk x-toolkit x multi-tty make-network-process emacs) Memory information: ((conses 16 205085 24404) (symbols 48 20631 1) (strings 32 71045 3014) (string-bytes 1 2427748) (vectors 16 46873) (vector-slots 8 1135485 57410) (floats 8 231 166) (intervals 56 674 176) (buffers 992 18)) --=-=-=-- From unknown Thu Sep 11 10:04:33 2025 X-Loop: help-debbugs@gnu.org Subject: bug#55761: 28.1; improvement on doc string Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 02 Jun 2022 12:31:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 55761 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: To: Ikumi Keita Cc: 55761@debbugs.gnu.org Received: via spool by 55761-submit@debbugs.gnu.org id=B55761.165417304932085 (code B ref 55761); Thu, 02 Jun 2022 12:31:02 +0000 Received: (at 55761) by debbugs.gnu.org; 2 Jun 2022 12:30:49 +0000 Received: from localhost ([127.0.0.1]:53037 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nwjyS-0008L9-Ps for submit@debbugs.gnu.org; Thu, 02 Jun 2022 08:30:49 -0400 Received: from quimby.gnus.org ([95.216.78.240]:50460) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nwjyP-0008BM-JV for 55761@debbugs.gnu.org; Thu, 02 Jun 2022 08:30:47 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date: References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=E3X/WtjNrbXJWo6oe2DrNIZV8pgrBDju8Jt3yR1mEz4=; b=UdFJf1ofZ7kPBBUYpnNF9VpvZV DFwNr67WCq+PilkkyIFzhSNNVufI03Vq9sYZPjkDhZKg4vxIPlxTR/1mEgVP3MoPh3N9T2jEmSkT6 f6LVHdPVBXb8KBptE27MVBBTGx0WnxipVndfL36Ov5RCxeOXNycJku5d+IpNO71ORhY8=; Received: from [84.212.220.105] (helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nwjyD-0007VL-F0; Thu, 02 Jun 2022 14:30:36 +0200 From: Lars Ingebrigtsen References: <2170.1654170836@localhost> Date: Thu, 02 Jun 2022 14:30:30 +0200 In-Reply-To: <2170.1654170836@localhost> (Ikumi Keita's message of "Thu, 02 Jun 2022 20:53:56 +0900") Message-ID: <87leufxn6h.fsf@gnus.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see @@CONTACT_ADDRESS@@ for details. Content preview: Ikumi Keita writes: > I'd like to propose the attached patch. > > Here is a portion of output of C-h f find-file RET: > ,---- > | Switch to a buffer visiting file FILENAME, > | [...] > | type M-x next-history-element to [...] Content analysis details: (-2.9 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] X-Spam-Score: -2.3 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) Ikumi Keita writes: > I'd like to propose the attached patch. > > Here is a portion of output of C-h f find-file RET: > ,---- > | Switch to a buffer visiting file FILENAME, > | [...] > | type M-x next-history-element to pull it into the minibuffer. > | > | The first time M-x next-history-element is used after Emacs prompts for > | [...] > | current directory to be available on first M-x next-history-element > | request. > `---- > The appearances of "M-x next-history-element" don't look nice to me. I > hope the attached patch to be a starting point for revising the doc > strings of `find-file' and its cousins. Thanks; applied to Emacs 28. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no From debbugs-submit-bounces@debbugs.gnu.org Thu Jun 02 08:30:53 2022 Received: (at control) by debbugs.gnu.org; 2 Jun 2022 12:30:53 +0000 Received: from localhost ([127.0.0.1]:53040 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nwjyX-0008Pc-1l for submit@debbugs.gnu.org; Thu, 02 Jun 2022 08:30:53 -0400 Received: from quimby.gnus.org ([95.216.78.240]:50474) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nwjyU-0008Hh-V8 for control@debbugs.gnu.org; Thu, 02 Jun 2022 08:30:51 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Subject:From:To:Message-Id:Date:Sender:Reply-To:Cc: MIME-Version:Content-Type:Content-Transfer-Encoding:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=jU/s7j83peQKNBqHSek2/UT2CEjri7UzhtbZQ0Sl3OM=; b=j+JxnGqLBG4rV2PALGI+p+o3uW GIMH8w1xLDcufYrLOa3oi18VzEa+fiqiv2+ZQ10WcYaPUjegUv47u0miLJRrAa3iUoXor3TuT+iM9 i0T8mAXeSR7QBp3TpMmZHtoxG3NZOnI+pCih2bBIK8fsFGr1pKpr36vAAQbrKG4VR9pk=; Received: from [84.212.220.105] (helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nwjyN-0007VU-18 for control@debbugs.gnu.org; Thu, 02 Jun 2022 14:30:45 +0200 Date: Thu, 02 Jun 2022 14:30:40 +0200 Message-Id: <87k09zxn67.fsf@gnus.org> To: control@debbugs.gnu.org From: Lars Ingebrigtsen Subject: control message for bug #55761 X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see @@CONTACT_ADDRESS@@ for details. Content preview: close 55761 28.2 quit Content analysis details: (-2.9 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP -1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1% [score: 0.0000] X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) close 55761 28.2 quit