From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Michael Albinus via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#71854: 31.0.50; with-editor typos Date: Sun, 30 Jun 2024 11:48:29 +0200 Message-ID: <87msn23gnm.fsf@gmx.de> Reply-To: Michael Albinus Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="8571"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Jonas Bernoulli To: 71854@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Jun 30 11:49:24 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1sNrBU-00020P-2C for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 30 Jun 2024 11:49:24 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sNrBO-0000C5-6C; Sun, 30 Jun 2024 05:49:18 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sNrBA-0000BP-MI for bug-gnu-emacs@gnu.org; Sun, 30 Jun 2024 05:49:07 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sNrBA-00089r-De for bug-gnu-emacs@gnu.org; Sun, 30 Jun 2024 05:49:04 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sNrB8-0005s4-18; Sun, 30 Jun 2024 05:49:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Michael Albinus Original-Sender: "Debbugs-submit" Resent-CC: jonas@bernoul.li, bug-gnu-emacs@gnu.org Resent-Date: Sun, 30 Jun 2024 09:49:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 71854 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org X-Debbugs-Original-Xcc: Jonas Bernoulli Original-Received: via spool by submit@debbugs.gnu.org id=B.171974092622543 (code B ref -1); Sun, 30 Jun 2024 09:49:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 30 Jun 2024 09:48:46 +0000 Original-Received: from localhost ([127.0.0.1]:55139 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sNrAs-0005rW-6n for submit@debbugs.gnu.org; Sun, 30 Jun 2024 05:48:46 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:57014) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sNrAr-0005rP-5R for submit@debbugs.gnu.org; Sun, 30 Jun 2024 05:48:45 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sNrAh-00009h-DF for bug-gnu-emacs@gnu.org; Sun, 30 Jun 2024 05:48:38 -0400 Original-Received: from mout.gmx.net ([212.227.15.15]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sNrAf-00082T-2j for bug-gnu-emacs@gnu.org; Sun, 30 Jun 2024 05:48:35 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmx.de; s=s31663417; t=1719740910; x=1720345710; i=michael.albinus@gmx.de; bh=Loy16jf40OWYS3AvHYpRyebVUuar973ROzrdFLq2QSA=; h=X-UI-Sender-Class:From:To:Subject:Date:Message-ID:MIME-Version: Content-Type:cc:content-transfer-encoding:content-type:date:from: message-id:mime-version:reply-to:subject:to; b=Hb1EtuVeLgC3TpyBWa6aSO02aF6Nxk8dMLF2aCq8t57jom1MpLO0a+5ZoW4czqN8 YD7sieKasbEXlXx3h+Ekz02h7FjCjV8gcUYZ6b2Ixx2kYhuz/YLt0YcBr0md5ALOh sUJK1LR6I8GYXTRhtgJPu9w6BiPYOCnckL0c9998JHDS+VDq3mtjILJ3Pr6UjIDvX Zc1xh1ArVpGZ/CSiY7VjcEQ15gw5klJKH5ZtItjPS/8zSoKo98RJIBPqB0sEb6QBK oH/T5Ec4oxLS7fw/6TUkM4wvHAy9q2ujFiN3jM6PJMbXlLD7bv6BLLhHVEqS40vWc xbsBHbvp73V0PstKhg== X-UI-Sender-Class: 724b4f7f-cbec-4199-ad4e-598c01a50d3a Original-Received: from gandalf.gmx.de ([185.89.38.155]) by mail.gmx.net (mrgmx004 [212.227.17.190]) with ESMTPSA (Nemesis) id 1MwfWa-1sDciS0ANW-00yVd4 for ; Sun, 30 Jun 2024 11:48:30 +0200 X-Provags-ID: V03:K1:Ppvcg6sCLuiEFzwDEbeTdr5ZPFu0zNTYKv6RVh+XWEPOktHkEZ5 CaeCejh2N6kQC7apy9ZCQneu3rwuJzZ54W8SVGLvQSQtJXaA8EP+OuUIZvb6vRzNtTsduA7 diZJpU4R3aaVp5kvCd5vCwR0OcuhcCD/om2rk+golBDXKfeJWbA5SsZmmoau28XLDpEFjiR kT/rK4uzqUBihc1h9NprA== UI-OutboundReport: notjunk:1;M01:P0:isMh6kyX5NI=;1vu09FlJ5iPn/3t+/vM/d6Moi8/ 6AwLJ38F/QTYFi2qh0+KlbY4kS+jOf04vERhClerzVQYYhzUUFbvy8CPDUqn21b7cwTyzUQme ToVV8fSpZIq6pw13w1u+e8MX0LWOylgyv1iJwupdjEzlSiddGVoi8yU9ic+NpH2V1LqFNmJHw aZjoxB8hjv6eKflSXFL5P8X870tnzra+Fkm6oJcHtzhaEbeYiw8XQlhd6+IGI+tkO05kTA7QQ 9j/jnNamYVwravh/RQY7JsYUFrt+4k+B4Rs874N57WkRJg8hjbN4OmnIuk6bzzqqX7ggQyIYl cvrKIbX7ZLFv7oXWTjYVVsmWvFvPQPL7hfq9LZbp7Yxtse4OFFQBWaf7erjZdkXZjlfVgKe4C nMe79x+dTk5PPuKaqpg2nXwsLk1/OfvA+KgOzi6kBwoG9NMHQnJOaGvz7W6R/Nb1IulGkAi9h yVzx4ZuuvUj8h3WFebDUPNFvX14ZQ/3PKES0vbG+wQ+JLWnWY7CmhebaWPMoUBsc2psbvQd1v hvlQOq8EQz7BEWiAukKZ88TaLsyCmnYf8zNdgjfGUNmpMxQG6d0/ATFTJ6ULBGh2M1twQm8+s pDadyUgiJk7sCHT4nRwnJWySwnxSkThDfoVzzRvkRJPB23DY5iPYpYnHqtKm3gmDpcolPvmYr PQVJ5XEqVxOBR/F60xfa655WPyRNub5VW4K/MZ3tVm6vU1ncoxSILR80gJeNFlkjYkWsVh8XZ Kl4XezE4tFYD/L3iPh1EfUcBtSdJYQFxNqCxvACNKqBpvvtnDWfnHCJYrn6Lpf6WvDq9aq9h Received-SPF: pass client-ip=212.227.15.15; envelope-from=michael.albinus@gmx.de; helo=mout.gmx.net X-Spam_score_int: 5 X-Spam_score: 0.5 X-Spam_bar: / X-Spam_report: (0.5 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_SBL_CSS=3.335, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:288181 Archived-At: --=-=-= Content-Type: text/plain Severity: minor --=-=-= Content-Type: text/x-patch Content-Disposition: inline Content-Transfer-Encoding: quoted-printable diff --git a/docs/with-editor.org b/docs/with-editor.org index 1c89fe93b8e..ce13da5d982 100644 =2D-- a/docs/with-editor.org +++ b/docs/with-editor.org @@ -38,7 +38,7 @@ commit messages and rebase sequences. It also provides = some commands and features which are useful by themselves, even if you don't use Magit. -For information about using this library in you own package, see +For information about using this library in your own package, see [[*Using With-Editor as a library]]. ** Configuring With-Editor @@ -52,7 +52,7 @@ and we have to add another kludge to find it anyway. - User Option: with-editor-emacsclient-executable :: - The ~emacsclient~ executable used as the editor by child process of + The ~emacsclient~ executable used as the editor by child processes of this Emacs instance. By using this executable, child processes can call home to their parent process. @@ -65,10 +65,10 @@ and we have to add another kludge to find it anyway. it, then you should consider that a temporary kludge and inform the Magit maintainer as described in [[*Debugging][Debugging]]. - If With-Editor fails to find a suitable ~emacsclient~ on you system, + If With-Editor fails to find a suitable ~emacsclient~ on your system, then this should be fixed for all users at once, by teaching ~with-editor-locate-emacsclient~ how to do so on your system and - system like yours. Doing it this way has the advantage, that you + systems like yours. Doing it this way has the advantage, that you won't have do it again every time you update Emacs, and that other users who have installed Emacs the same way as you have, won't have to go through the same trouble. @@ -77,7 +77,7 @@ and we have to add another kludge to find it anyway. ~nil~ causes the "sleeping editor" described below to be used even for local child processes. Obviously we don't recommend that you use this except in "emergencies", i.e., before we had a change to add a - kludge appropriate for you setup. + kludge appropriate for your setup. - Function: with-editor-locate-emacsclient :: @@ -99,7 +99,7 @@ it receives a signal. The sleeping editor is a shell script used as the editor of child processes when the ~emacsclient~ executable cannot be used. - This fallback is used for asynchronous process started inside the + This fallback is used for asynchronous processes started inside the macro ~with-editor~, when the process runs on a remote machine or for local processes when ~with-editor-emacsclient-executable~ is ~nil~. @@ -107,7 +107,7 @@ it receives a signal. this substitute prints edit requests to its standard output on which a process filter listens for such requests. As such it is not a complete substitute for a proper ~emacsclient~, it can only - be used as ~$EDITOR~ of child process of the current Emacs instance. + be used as ~$EDITOR~ of child processes of the current Emacs instance. Some shells do not execute traps immediately when waiting for a child process, but by default we do use such a blocking child @@ -158,7 +158,7 @@ prompt for an alternative environment variable such as= ~$GIT_EDITOR~. with ~&~ and is therefore run asynchronously, then the current Emacs instance is exported as ~$EDITOR~. -To always use these variants add this to you init file: +To always use these variants add this to your init file: #+begin_src emacs-lisp (keymap-global-set " " @@ -241,7 +241,7 @@ package]]. If BODY begins with a literal string, then that variable is set instead of ~EDITOR~. =2D- Macro: with-editor envvar &rest body :: +- Macro: with-editor* envvar &rest body :: This macro is like ~with-editor~ instead that the ENVVAR argument is required and that it is evaluated at run-time. @@ -253,7 +253,7 @@ package]]. done by wrapping the two filter functions using a lambda, which becomes the actual filter. It calls FILTER first, which may or may not insert the text into the PROCESS's buffer. Then it calls - ~with-editor-process-filter~, passing t as NO-STANDARD-FILTER. + ~with-editor-process-filter~, passing ~t~ as NO-STANDARD-FILTER. * Debugging --=-=-=--