From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jim Porter Newsgroups: gmane.emacs.bugs Subject: bug#54190: 29.0.50; [PATCH] Incorrect/missing documentation for some Eshell "$" syntaxes Date: Sun, 27 Feb 2022 13:34:26 -0800 Message-ID: <0c3898ff-23ac-51bc-2211-770302d7d00e@gmail.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="------------621208421B5428A95558A3F5" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="4331"; mail-complaints-to="usenet@ciao.gmane.io" To: 54190@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Feb 27 22:35:20 2022 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 1nORCK-0000yf-Fd for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 27 Feb 2022 22:35:20 +0100 Original-Received: from localhost ([::1]:35620 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nORCJ-0003qd-Hq for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 27 Feb 2022 16:35:19 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:41834) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nORC2-0003p8-UC for bug-gnu-emacs@gnu.org; Sun, 27 Feb 2022 16:35:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:37285) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nORC2-00066E-Kr for bug-gnu-emacs@gnu.org; Sun, 27 Feb 2022 16:35:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nORC2-0008P3-IJ for bug-gnu-emacs@gnu.org; Sun, 27 Feb 2022 16:35:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Jim Porter Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 27 Feb 2022 21:35:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 54190 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.164599767532263 (code B ref -1); Sun, 27 Feb 2022 21:35:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 27 Feb 2022 21:34:35 +0000 Original-Received: from localhost ([127.0.0.1]:59415 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nORBb-0008OI-9c for submit@debbugs.gnu.org; Sun, 27 Feb 2022 16:34:35 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:53446) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nORBZ-0008OA-8h for submit@debbugs.gnu.org; Sun, 27 Feb 2022 16:34:33 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:41720) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nORBZ-0003D5-31 for bug-gnu-emacs@gnu.org; Sun, 27 Feb 2022 16:34:33 -0500 Original-Received: from [2607:f8b0:4864:20::434] (port=33712 helo=mail-pf1-x434.google.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nORBW-00062z-5P for bug-gnu-emacs@gnu.org; Sun, 27 Feb 2022 16:34:31 -0500 Original-Received: by mail-pf1-x434.google.com with SMTP id d17so9351215pfl.0 for ; Sun, 27 Feb 2022 13:34:29 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:subject:to:message-id:date:mime-version:content-language; bh=nKjQbQq5mtozgCkmYKY5yU7iVfuSgNjoPGVz7aqk+lw=; b=PfA6Pvs8+0t53wnFQn7KyTCu0D+z0ZgvEKu0ovalbrDvtWZxHGGLetWUcd6YaqAQKD SzUXfkCBdwwZ4Sf9jpWBTnQVGGucc1/E3fAj3Widzzlq5JPP++SIb934Ee1Gb7EtNixY Yt8ct5RP289nrzYmY+OVO0aIqCu/mdLrWpxOdJUuqJ3R64dSvNigAKrg+3MlWy/5kOBX nzEaxRakpv3QjspxktVAdkwFZJLsMkFtnT+JcZgluM06F8axJBiT3H6NftlZkL0Fqs4X AOZLKwFx+LrgdYDorJhOiJHP/JbWfqEnCovcXHVe/VLSonp7ZgySYP19iBdidKm9PqpG ukag== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:subject:to:message-id:date:mime-version :content-language; bh=nKjQbQq5mtozgCkmYKY5yU7iVfuSgNjoPGVz7aqk+lw=; b=HfjZWSAUCDoEL/LVcBWtNv4svpnt0yqEfIK3GbO3HbzHWmeu8Cfs53OuBrtOs+EjRG AIQplxNRY3EayMK+jOG9PaVkJm2GSxGyJPhY4d0//kDHfCG12nFb0bS86GJmPcDB3m/Y mzceZYUxz9WBng4iiEl3WqO2CSc8V8/DAyimIhJZ6Yk7rCbeuWyos51jpDzGs0G+XE9a nXwWVgoZEkqy/UoXUInZPMf+A54cvN0yhuGbYqR4cAQhh4WxE0yO+Z3ffUe3+ULAY49z 522VBiqxRMn8KA8YAk6xOgCDbz40Ou0O/D6C/tT1rp3GbI7S8y7oAjfjQKbaKM+A7YgE iStw== X-Gm-Message-State: AOAM530DrwBkdkT3ptl8Nfcx25+nYw1W3XBXQ3L4HFJ8egHwbaB/Pkfh t+kkGAtM/Wx/sdXpmXAqQMDpSbOHHFI= X-Google-Smtp-Source: ABdhPJyZ3E24avll2jucwFE1jctSHxe8HPuIizbHtA2aTAPBG3tDFuC/BserHTYjcdMUmawsC6a95A== X-Received: by 2002:a63:2361:0:b0:378:af21:1d79 with SMTP id u33-20020a632361000000b00378af211d79mr1148760pgm.363.1645997668444; Sun, 27 Feb 2022 13:34:28 -0800 (PST) Original-Received: from [192.168.1.2] (cpe-76-168-148-233.socal.res.rr.com. [76.168.148.233]) by smtp.googlemail.com with ESMTPSA id d13-20020a17090ac24d00b001bcd7c2b2c3sm9485878pjx.16.2022.02.27.13.34.26 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sun, 27 Feb 2022 13:34:26 -0800 (PST) X-Mozilla-News-Host: news://news.gmane.org:119 Content-Language: en-US X-Host-Lookup-Failed: Reverse DNS lookup failed for 2607:f8b0:4864:20::434 (failed) Received-SPF: pass client-ip=2607:f8b0:4864:20::434; envelope-from=jporterbugs@gmail.com; helo=mail-pf1-x434.google.com X-Spam_score_int: -6 X-Spam_score: -0.7 X-Spam_bar: / X-Spam_report: (-0.7 / 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, PDS_HP_HELO_NORDNS=0.659, RCVD_IN_DNSWL_NONE=-0.0001, RDNS_NONE=0.793, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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" Xref: news.gmane.io gmane.emacs.bugs:227746 Archived-At: This is a multi-part message in MIME format. --------------621208421B5428A95558A3F5 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit In the documentation for lisp/eshell/esh-var.el (and `eshell-parse-variable-ref' in that file), it says that "$" is a way of accessing the value of the variable FOO to disambiguate the length of the variable name, sort of like "${FOO}" in ordinary shells. However, that's not actually true. The correct syntax for that is: $"FOO" ;; or... $'FOO' In fact, what "$" does is to run FOO as a subcommand, writing its stdout to a temp file, and returning that file's name. This is (very!) subtly implied in the Eshell manual in the "Bugs and ideas" section, where it says: `grep python $' doesn't work, but using `*grep' does This happens because the `grep' Lisp function returns immediately, and then the asynchronous `grep' process expects to examine the temporary file, which has since been deleted. Attached is a patch which updates the documentation to correctly describe the current behavior. Note: since this is just a documentation change, it might be worth pushing to the 28 branch. --------------621208421B5428A95558A3F5 Content-Type: text/plain; charset=UTF-8; name="0001-Improve-correct-documentation-about-Eshell-variable-.patch" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename*0="0001-Improve-correct-documentation-about-Eshell-variable-.pa"; filename*1="tch" RnJvbSBlYzUyYjQ0ZjY5NGYyNTE1YmIzNjczZjk5OGU2ZWE4MGQyZDMxZTA4IE1vbiBTZXAg MTcgMDA6MDA6MDAgMjAwMQpGcm9tOiBKaW0gUG9ydGVyIDxqcG9ydGVyYnVnc0BnbWFpbC5j b20+CkRhdGU6IFN1biwgMjcgRmViIDIwMjIgMTM6MjA6NTEgLTA4MDAKU3ViamVjdDogW1BB VENIXSBJbXByb3ZlL2NvcnJlY3QgZG9jdW1lbnRhdGlvbiBhYm91dCBFc2hlbGwgdmFyaWFi bGUgZXhwYW5zaW9uCgoqIGxpc3AvZXNoZWxsL2VzaC12YXIuZWw6IENvcnJlY3QgZG9jdW1l bnRhdGlvbiBjb21tZW50LgooZXNoZWxsLXBhcnNlLXZhcmlhYmxlLXJlZik6IENvcnJlY3Qg ZG9jc3RyaW5nLgoKKiBkb2MvbWlzYy9lc2hlbGwudGV4aSAoRG9sbGFycyBFeHBhbnNpb24p OiBBZGQgZG9jdW1lbnRhdGlvbiBmb3IKJCJ2YXIiLyQndmFyJyBhbmQgJDxjb21tYW5kPiBz eW50YXhlcy4KLS0tCiBkb2MvbWlzYy9lc2hlbGwudGV4aSAgIHwgMTEgKysrKysrKysrKysK IGxpc3AvZXNoZWxsL2VzaC12YXIuZWwgfCAxNSArKysrKysrKysrKystLS0KIDIgZmlsZXMg Y2hhbmdlZCwgMjMgaW5zZXJ0aW9ucygrKSwgMyBkZWxldGlvbnMoLSkKCmRpZmYgLS1naXQg YS9kb2MvbWlzYy9lc2hlbGwudGV4aSBiL2RvYy9taXNjL2VzaGVsbC50ZXhpCmluZGV4IDI2 MWU4OGQwMGMuLjg4YTdkN2IxMzAgMTAwNjQ0Ci0tLSBhL2RvYy9taXNjL2VzaGVsbC50ZXhp CisrKyBiL2RvYy9taXNjL2VzaGVsbC50ZXhpCkBAIC0xMDE2LDYgKzEwMTYsMTIgQEAgRG9s bGFycyBFeHBhbnNpb24KIEV4cGFuZHMgdG8gdGhlIHZhbHVlIGJvdW5kIHRvIEBjb2Rle3Zh cn0uICBUaGlzIGlzIHRoZSBtYWluIHdheSB0byB1c2UKIHZhcmlhYmxlcyBpbiBjb21tYW5k IGludm9jYXRpb25zLgogCitAaXRlbSAkInZhciIKK0BpdGVtICQndmFyJworRXhwYW5kcyB0 byB0aGUgdmFsdWUgYm91bmQgdG8gQGNvZGV7dmFyfS4gIFRoaXMgaXMgdXNlZnVsIHRvCitk aXNhbWJpZ3VhdGUgdGhlIHZhcmlhYmxlIG5hbWUgd2hlbiBjb25jYXRlbmF0aW5nIGl0IHdp dGggYW5vdGhlcgordmFsdWUsIHN1Y2ggYXMgQHNhbXB7JCJ2YXIiLXN1ZmZpeH0uCisKIEBp dGVtICQjdmFyCiBFeHBhbmRzIHRvIHRoZSBsZW5ndGggb2YgdGhlIHZhbHVlIGJvdW5kIHRv IEBjb2Rle3Zhcn0uICBSYWlzZXMgYW4gZXJyb3IKIGlmIHRoZSB2YWx1ZSBpcyBub3QgYSBz ZXF1ZW5jZQpAQCAtMTAzMCw2ICsxMDM2LDExIEBAIERvbGxhcnMgRXhwYW5zaW9uCiBSZXR1 cm5zIHRoZSBvdXRwdXQgb2YgQGNvbW1hbmR7Y29tbWFuZH0sIHdoaWNoIGNhbiBiZSBhbnkg dmFsaWQgRXNoZWxsCiBjb21tYW5kIGludm9jYXRpb24sIGFuZCBtYXkgZXZlbiBjb250YWlu IGV4cGFuc2lvbnMuCiAKK0BpdGVtICQ8Y29tbWFuZD4KK0FzIHdpdGggQHNhbXB7JEB7Y29t bWFuZEB9fSwgZXZhbHVhdGVzIHRoZSBFc2hlbGwgY29tbWFuZCBpbnZvY2F0aW9uCitAY29t bWFuZHtjb21tYW5kfSwgYnV0IHdyaXRlcyB0aGUgb3V0cHV0IHRvIGEgdGVtcG9yYXJ5IGZp bGUgYW5kCityZXR1cm5zIHRoZSBmaWxlIG5hbWUuCisKIEBpdGVtICR2YXJbaV0KIEV4cGFu ZHMgdG8gdGhlIEBjb2Rle2l9dGggZWxlbWVudCBvZiB0aGUgdmFsdWUgYm91bmQgdG8gQGNv ZGV7dmFyfS4gIElmCiB0aGUgdmFsdWUgaXMgYSBzdHJpbmcsIGl0IHdpbGwgYmUgc3BsaXQg YXQgd2hpdGVzcGFjZSB0byBtYWtlIGl0IGEgbGlzdC4KZGlmZiAtLWdpdCBhL2xpc3AvZXNo ZWxsL2VzaC12YXIuZWwgYi9saXNwL2VzaGVsbC9lc2gtdmFyLmVsCmluZGV4IDVjOGRhY2Q5 ODAuLmNmZWZlMTVjOWMgMTAwNjQ0Ci0tLSBhL2xpc3AvZXNoZWxsL2VzaC12YXIuZWwKKysr IGIvbGlzcC9lc2hlbGwvZXNoLXZhci5lbApAQCAtMzQsNyArMzQsOCBAQAogOzsKIDs7ICIt IiBpcyBhIHZhbGlkIHBhcnQgb2YgYSB2YXJpYWJsZSBuYW1lLgogOzsKLTs7ICAgJDxNWVZB Uj4tVE9PCis7OyAgICRcIk1ZVkFSXCItVE9PCis7OyAgICQnTVlWQVInLVRPTwogOzsKIDs7 IE9ubHkgIk1ZVkFSIiBpcyBwYXJ0IG9mIHRoZSB2YXJpYWJsZSBuYW1lIGluIHRoaXMgY2Fz ZS4KIDs7CkBAIC01NSw2ICs1NiwxMSBAQAogOzsgUmV0dXJucyB0aGUgdmFsdWUgb2YgYW4g ZXNoZWxsIHN1YmNvbW1hbmQuICBTZWUgdGhlIG5vdGUgYWJvdmUKIDs7IHJlZ2FyZGluZyBM aXNwIGV2YWx1YXRpb25zLgogOzsKKzs7ICAgJDxjb21tYW5kPgorOzsKKzs7IEV2YWx1YXRl cyBhbiBlc2hlbGwgc3ViY29tbWFuZCwgcmVkaXJlY3RpbmcgdGhlIG91dHB1dCB0byBhCis7 OyB0ZW1wb3JhcnkgZmlsZSwgYW5kIHJldHVybmluZyB0aGUgZmlsZSBuYW1lLgorOzsKIDs7 ICAgJEFOWVZBUlsxMF0KIDs7CiA7OyBSZXR1cm4gdGhlIDEwdGggZWxlbWVudCBvZiBBTllW QVIuICBJZiBBTllWQVIncyB2YWx1ZSBpcyBhIHN0cmluZywKQEAgLTQyMyw5ICs0MjksMTIg QEAgZXNoZWxsLXBhcnNlLXZhcmlhYmxlLXJlZgogUG9zc2libGUgb3B0aW9ucyBhcmU6CiAK ICAgTkFNRSAgICAgICAgICBhbiBlbnZpcm9ubWVudCBvciBMaXNwIHZhcmlhYmxlIHZhbHVl Ci0gIDxMT05HLU5BTUU+ICAgZGlzYW1iaWd1YXRlcyB0aGUgbGVuZ3RoIG9mIHRoZSBuYW1l CisgIFwiTE9ORy1OQU1FXCIgICBkaXNhbWJpZ3VhdGVzIHRoZSBsZW5ndGggb2YgdGhlIG5h bWUKKyAgJ0xPTkctTkFNRScgICBhcyBhYm92ZQogICB7Q09NTUFORH0gICAgIHJlc3VsdCBv ZiBjb21tYW5kIGlzIHZhcmlhYmxlJ3MgdmFsdWUKLSAgKExJU1AtRk9STSkgICByZXN1bHQg b2YgTGlzcCBmb3JtIGlzIHZhcmlhYmxlJ3MgdmFsdWUiCisgIChMSVNQLUZPUk0pICAgcmVz dWx0IG9mIExpc3AgZm9ybSBpcyB2YXJpYWJsZSdzIHZhbHVlCisgIDxDT01NQU5EPiAgICAg d3JpdGUgdGhlIG91dHB1dCBvZiBjb21tYW5kIHRvIGEgdGVtcG9yYXJ5IGZpbGU7CisgICAg ICAgICAgICAgICAgcmVzdWx0IGlzIHRoZSBmaWxlIG5hbWUiCiAgIChjb25kCiAgICAoKGVx IChjaGFyLWFmdGVyKSA/eykKICAgICAobGV0ICgoZW5kIChlc2hlbGwtZmluZC1kZWxpbWl0 ZXIgP1x7ID9cfSkpKQotLSAKMi4yNS4xCgo= --------------621208421B5428A95558A3F5--