From: Michael Albinus <michael.albinus@gmx.de>
To: Jim Porter <jporterbugs@gmail.com>
Cc: 57556@debbugs.gnu.org
Subject: bug#57556: 28.1; Eshell not finding executables in PATH when tramp-integration loaded
Date: Sat, 15 Oct 2022 12:38:05 +0200 [thread overview]
Message-ID: <87k051v0c2.fsf@gmx.de> (raw)
In-Reply-To: <a661c82b-9684-f881-8844-5962cc12b3a8@gmail.com> (Jim Porter's message of "Fri, 14 Oct 2022 13:53:33 -0700")
Jim Porter <jporterbugs@gmail.com> writes:
Hi Jim,
>> @var{} produces already capital letters, so you are more consistent
>> with
>> @var{name}.
>
> My intent was to make that display as all-caps in the HTML
> documentation as well. In that excerpt, 'NAME' should always be an
> environment variable, so I used the capitalization conventions that
> env vars usually use. 'name', on the other hand, could be a Lisp
> variable or an env var.
You use @var{} by side-effect6, which is always problematic. For
example, RMS is looking for a replacement of the texinfo syntax for
documentation, org syntax is a candidate. But whatever is chosen, an
automatic conversion from .texinfo to .<whatever> could be problematic
then.
Use what is offered by texinfo. Say for example
--8<---------------cut here---------------start------------->8---
the @env{PATH} environment variable
--8<---------------cut here---------------end--------------->8---
And in sample code, do not apply further formatting, but say it as you
mean it
--8<---------------cut here---------------start------------->8---
@samp{setq name value}
@samp{export NAME=value}
--8<---------------cut here---------------end--------------->8---
> I adjusted these docs a bit since they seemed unclear to me on a
> second reading (see attached), but kept the all-caps NAME for env
> vars. If you still think that's wrong, I'll change it to lower-case
> before merging.
Otherwise, it LGTM. Somewhere there is only one space after a dot
(should be two spaces), but I didn't marked this during review, and now
I'm too lazy to look for :-)
I'd say just push it to the repo, and if there's something left to do we
can stiil do it.
Best regards, Michael.
next prev parent reply other threads:[~2022-10-15 10:38 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
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 [this message]
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=87k051v0c2.fsf@gmx.de \
--to=michael.albinus@gmx.de \
--cc=57556@debbugs.gnu.org \
--cc=jporterbugs@gmail.com \
/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).