From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: New optional Eshell module: em-elecslash Date: Sat, 16 Apr 2022 22:18:05 +0300 Message-ID: <83ee1wzvki.fsf@gnu.org> References: <87k0bokg98.fsf@melete.silentflame.com> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="31814"; mail-complaints-to="usenet@ciao.gmane.io" Cc: philipk@posteo.net, emacs-devel@gnu.org To: Sean Whitton Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Apr 16 21:19:19 2022 Return-path: Envelope-to: ged-emacs-devel@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 1nfnx1-00087U-3K for ged-emacs-devel@m.gmane-mx.org; Sat, 16 Apr 2022 21:19:19 +0200 Original-Received: from localhost ([::1]:40366 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nfnwz-0000mp-MB for ged-emacs-devel@m.gmane-mx.org; Sat, 16 Apr 2022 15:19:17 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37980) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nfnvy-0008CK-8p for emacs-devel@gnu.org; Sat, 16 Apr 2022 15:18:14 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:36798) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nfnvx-0002yA-VT; Sat, 16 Apr 2022 15:18:13 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=c6dyAaDlXPjfgFjzcEgRakqalWqfG6ISiaWE0XQBThg=; b=k+g1hxtao4ov n223V9OCSXHoOAb1+vLlHTCnKbs8impi3Ip5REN0Ti+DR/W7GqeDVb+phD7pyJhwYYBDd8Qv+X424 +ZuVULr5LJMLhOeCSDForLepbND63+498wHvUoUkzgqGu1rfvJCjAPsrdyhSQrcl1mtGx1trkQk+5 lhOZDzP4X7wsL+w6sowI/XQfI+qlAq2P60DJR+ReLcOlUnD7LHm9QVKylP5FkkG5Mqxx9lU0fZIKm 3AJeMNKMVuaHMZwCnOKxAMPfAuRuaAgiX7fwl7XvdIdeDyKJTfDC22SFPVvqrZxbfJ5ASIr6zbNrw cTI1Qmwh6Ukf/8YptZWf2A==; Original-Received: from [87.69.77.57] (port=4124 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nfnvx-0001lq-C1; Sat, 16 Apr 2022 15:18:13 -0400 In-Reply-To: <87k0bokg98.fsf@melete.silentflame.com> (message from Sean Whitton on Sat, 16 Apr 2022 11:57:55 -0700) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:288503 Archived-At: > From: Sean Whitton > Date: Sat, 16 Apr 2022 11:57:55 -0700 > > Here is my new module, which I'd like to install on master. Thanks, a few comments below regarding the documentation parts. > >From c915c51cd32b6354b951f10fb4d2d3666b3480d2 Mon Sep 17 00:00:00 2001 > From: Sean Whitton > Date: Sat, 16 Apr 2022 08:23:14 -0700 > Subject: [PATCH] New electric forward slash Eshell module > > * lisp/eshell/em-elecslash.el: New module. We use "New file." > +This optional module tries to help with passing absolute paths to GNU Coding Standards frown on using "path" for anything but PATH-style directory lists. In other cases, we use "file name" instead. Please correct this terminology here and elsewhere in the patch. > +passed to Lisp functions must have Tramp's @code{/method:host:} ^^^^^^^^^^^^^^^^^^^^ File names should have the @file markup. > +@noindent and in reviewing the output of the command, you identify a > +file @code{/etc/gnugnu} that should be moved somewhere else. So you ^^^^^^^^^^^^^^^^^^ Likewise (and elsewhere in the patch). > +@noindent But since @code{mv} refers to the local Lisp function ^^^^^^^^^ "mv" is a command, so it should use the @command markup. > +If the @code{eshell-elecslash} module has been added to > +@code{eshell-modules-list}, and @code{default-directory} is remote, > +then when you type the first forward slash of an argument to a Lisp > +function, the Tramp prefix will be filled in for you. A second > +forward slash can be used to undo the insertion, for when you really > +do want to pass a local absolute path, such as when you want to copy a > +remote file to the local machine. And when typing arguments to > +external commands, the Tramp prefix is not filled in. The result is > +that you don't have to think about inserting the Tramp prefix and can > +just type absolute paths in the same way for both types of command. > +The Tramp prefix is additionally filled in when you type @code{~/}. You use passive tense a lot (here and elsewhere), which in many cases makes the text longer, more complicated, and harder to understand. Please try rephrasing without using passive tense so much. > +*** New optional Eshell module to help avoid mistakes when supplying The first line of a NEWS entry is a heading, so it should be a complete sentence, to facilitate reading the outlines. > +;;;###autoload > +(progn > +(defgroup eshell-elecslash nil > + "When `default-directory' is remote thanks to Eshell's TRAMP the first line of a doc string should be a complete sentence, because some Help commands only show that single line. > +(defun eshell-electric-forward-slash () > + "Electric insertion of TRAMP part of `default-directory' in > +remote Eshells. Added to `post-self-insert-hook' when the Likewise.