bug#52999: 29.0.50; [PATCH v3] `eshell-eval-using-options' should follow POSIX/GNU argument conventions

[Jim Porter]

On 1/5/2022 6:50 AM, Eli Zaretskii wrote:
> > Cc: 52999@debbugs.gnu.org
> > From: Jim Porter <jporterbugs@gmail.com>
> > Date: Tue, 4 Jan 2022 13:09:29 -0800
> >
> > +@item symbol
> > +This element is the name of the Lisp symbol that will be bound to
> > +@var{value}.
>
> Is it a symbol or its name (a string)?  You say "name", but the
> example:
>
> >                If @var{symbol} is @code{nil}, specifying this switch
>
> uses a symbol, not its name.

Good catch. I've fixed this to say that it's the Lisp symbol.

> > +@item :preserve-args
> > +If present, do not pass @var{macro-args} through @code{flatten-tree}
> > +and @code{eshell-stringify-list}.
>
> I think this should explain the effect of that, or the difference
> between using and not using this keyword.

I had to do a bit of digging to figure out what this keyword is supposed 
to do in practice. It seems that it's used when a built-in Eshell 
command wants to be able to accept arbitrary Lisp objects as arguments, 
instead of working with just a flat list of strings. I've added more 
detail to this paragraph.

> > +---
> > +** 'eshell-eval-using-options' now follows POSIX/GNU argument syntax 
> > conventions.
> > +This now accepts command-line options with values passed as a single
>     ^^^^
> "Eshell" instead of "This" will make it more clear what you mean.

Ok, I updated this to refer to "Built-in commands in Eshell".

Thanks for looking over the patch.

0001-Follow-POSIX-GNU-argument-conventions-for-eshell-eva.patch
Description: Text document