Subject: bug#63875: closed (Re: [External] : Re: bug#63875: 26.3; Doc of `dired-guess-shell-alist-user')

From: [email-masked] (GNU bug Tracking System)
Date: Sat, 03 Jun 2023 16:24:01 +0000

Your bug report

#63875: 26.3; Doc of `dired-guess-shell-alist-user'

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
63875: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=63875
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: [External] : Re: bug#63875: 26.3; Doc of `dired-guess-shell-alist-user'
From: Eli Zaretskii <[email-masked]>
To: Drew Adams <[email-masked]>
Cc: [email-masked]
Date: Sat, 03 Jun 2023 19:24:39 +0300
List-Id: <debbugs-submit.debbugs.gnu.org>

> From: Drew Adams <[email-masked]>
> CC: "[email-masked]" <[email-masked]>
> Date: Sat, 3 Jun 2023 16:21:55 +0000
> 
> > > The doc string doesn't say what REGEXP is, e.g., what it's intended to
> > > match.  It should say that up front and explicitly.
> > 
> > ???The doc string says:
> > 
> >   Each element of this list looks like
> > 
> >       (REGEXP COMMAND...)
> > 
> >   COMMAND will be used if REGEXP matches the file to be processed.
> >   If several files are to be processed, REGEXP has to match all the
> >   files.
> > 
> > "REGEXP matches the file to be processed".  What else needs to be
> > said?
> 
> Apologies.  The bug report was from Emacs 26.  I see
> now that the doc string was improved since then to
> what you quote.
> 
> In Emacs 26, it says only this:
> 
>  Each element of this list looks like
> 
>      (REGEXP COMMAND...)
> 
>  where each COMMAND can either be a string or a Lisp
>  expression that evaluates to a string.
> 
> Feel free to close the bug.  Thx.

Closing.

Subject: 26.3; Doc of `dired-guess-shell-alist-user'
From: Drew Adams <[email-masked]>
To: "[email-masked]" <[email-masked]>
Date: Sat, 3 Jun 2023 16:08:11 +0000
List-Id: <debbugs-submit.debbugs.gnu.org>

The doc string doesn't say what REGEXP is, e.g., what it's intended to
match.  It should say that up front and explicitly.

Manual (dired-x) `Shell Command Guessing' sort of says it, if you read
carefully and guess a bit.

Please say explicitly that REGEXP is a regexp that's used to match file
names.  And say how the alist entries are used.  All that's said, so
far, is that this is a "User-defined alist of rules for suggested
commands."

Rules used how?  What does matching file names have to do with using a
command?  Again, the manual does say this somewhat, but not the doc
string.

The doc refers to `dired-guess-shell-alist-default', but the doc for
that variable doesn't explain anything, so it doesn't help with the
missing info for `dired-guess-shell-alist-user'.

FWIW, the comment in file dired-x.el that introduces these variables
describes them better than the doc in some ways: what they're for, how
they're used.

In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
 of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.19045
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''