From: Eli Zaretskii <eliz@gnu.org>
To: Jim Porter <jporterbugs@gmail.com>
Cc: michael.albinus@gmx.de, 57556@debbugs.gnu.org
Subject: bug#57556: 28.1; Eshell not finding executables in PATH when tramp-integration loaded
Date: Thu, 13 Oct 2022 09:35:55 +0300 [thread overview]
Message-ID: <831qrcb584.fsf@gnu.org> (raw)
In-Reply-To: <10e3d9b6-1fd5-c35f-625b-6dc02aa7de57@gmail.com> (message from Jim Porter on Wed, 12 Oct 2022 21:11:47 -0700)
> Cc: 57556@debbugs.gnu.org
> Date: Wed, 12 Oct 2022 21:11:47 -0700
> From: Jim Porter <jporterbugs@gmail.com>
>
> On 10/9/2022 11:01 AM, Michael Albinus wrote:
> > Jim Porter <jporterbugs@gmail.com> writes:
> >
> >> I attached an updated version of my connection-local.el that tries to
> >> pull out the additions you made into some helpers. What do you think?
> >
> > I gave it a short reading, and in general it looks OK (comments
> > below). Do you want to provide a patch for files-x.el with this?
>
> Thanks for taking a look. I've added a separate patch (0002 in this
> series) for adding these functions (with some improvements over the
> little test script we worked on) to files-x.el. (Patch 0001 just fixes
> an issue in the docs/tests where the :application had an extra quote.)
>
> If you think it would be easier to track, I could file a new bug and put
> patches 0001 and 0002 in there, then come back to this bug once that's
> merged. Either way is fine by me.
>
> The other patches in this series are mostly-unchanged from before,
> except for 0006, which now uses the new 'setq-connection-local' macro.
>
> > This patch shall also extent the "Connection Local Variables" section of
> > the Elisp manual. This section is already quite
> > long (~150 lines), and speaks almost about static setting of
> > connection-local variables. You bring dynamic settings here, maybe a
> > subsection would help to structure. And feel free to restructure the
> > other, long text if you believe it would help.
>
> I added all this to the manual (with an example), and divided the
> Connection Local Variables section into two subsections: one for how to
> initialize profiles and set criteria for them, and another for applying
> the variables. I put the 'setq-connection-local' docs in the second
> section, since it's closely related to 'with-connection-local-variables'.
Thanks. Some general documentation-related comments below.
> +@node Connection Local Profiles
> +@subsection Connection Local Profiles
It is generally a good idea to have a @cindex entry for the main topic
of a section/subsection. Usually, the @cindex entry is just the node
or section name, with all of its words down-cases. For example, here
I'd use
@cindex connect local profiles
And similarly for the other subsection you added.
My other general comment is to never miss an opportunity of adding a
cross-reference when you reference a term or a symbol described
elsewhere in the documentation. Never assume the reader already knows
what all the stuff you reference is about. For example:
> +You can set variables in a few different ways. To set a Lisp
> +variable, you can use the command @samp{setq @var{name} @var{value}},
> +which works much like its Lisp counterpart.
This will benefit from a cross-reference to where 'setq' is described
in the ELisp reference manual.
Please review the documentation changes for more cross-reference
opportunities like this one.
next prev parent reply other threads:[~2022-10-13 6:35 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-03 5:03 bug#57556: 28.1; Eshell not finding executables in PATH when tramp-integration loaded Colton Lewis via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-09-03 12:26 ` Lars Ingebrigtsen
2022-09-18 11:18 ` Michael Albinus
2022-09-18 18:54 ` Jim Porter
2022-09-18 19:07 ` Michael Albinus
2022-09-22 17:23 ` Colton Lewis via Bug reports for GNU Emacs, the Swiss army knife of text editors
2022-09-22 17:55 ` Michael Albinus
2022-09-30 3:54 ` Jim Porter
2022-10-01 20:25 ` Michael Albinus
2022-10-01 22:02 ` Jim Porter
2022-10-02 5:34 ` Jim Porter
2022-10-02 8:48 ` Michael Albinus
2022-10-07 3:19 ` Jim Porter
2022-10-07 18:28 ` Michael Albinus
2022-10-08 22:09 ` Jim Porter
2022-10-09 18:01 ` Michael Albinus
2022-10-13 4:11 ` Jim Porter
2022-10-13 6:35 ` Eli Zaretskii [this message]
2022-10-14 1:29 ` Jim Porter
2022-10-14 6:17 ` Eli Zaretskii
2022-10-14 12:28 ` Michael Albinus
2022-10-14 12:27 ` Michael Albinus
2022-10-14 20:53 ` Jim Porter
2022-10-15 10:38 ` Michael Albinus
2022-10-15 23:33 ` Jim Porter
2022-10-16 17:00 ` Michael Albinus
2022-10-16 23:01 ` Jim Porter
2022-10-16 20:51 ` Richard Stallman
2022-10-16 23:07 ` Jim Porter
2022-10-18 1:51 ` Jim Porter
2022-10-10 9:15 ` Michael Albinus
2022-10-02 8:55 ` Michael Albinus
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=831qrcb584.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=57556@debbugs.gnu.org \
--cc=jporterbugs@gmail.com \
--cc=michael.albinus@gmx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).