GNU bug report logs - #63875
26.3; Doc of `dired-guess-shell-alist-user'

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Sat, 3 Jun 2023 16:09:02 UTC

Severity: minor

Found in version 26.3

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#63875: closed (26.3; Doc of `dired-guess-shell-alist-user')
Date: Sat, 03 Jun 2023 16:24:01 +0000
[Message part 1 (text/plain, inline)]
Your message dated Sat, 03 Jun 2023 19:24:39 +0300
with message-id <83wn0k7bug.fsf <at> gnu.org>
and subject line Re: [External] : Re: bug#63875: 26.3; Doc of `dired-guess-shell-alist-user'
has caused the debbugs.gnu.org bug report #63875,
regarding 26.3; Doc of `dired-guess-shell-alist-user'
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
63875: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=63875
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Drew Adams <drew.adams <at> oracle.com>
To: "bug-gnu-emacs <at> gnu.org" <bug-gnu-emacs <at> gnu.org>
Subject: 26.3; Doc of `dired-guess-shell-alist-user'
Date: Sat, 3 Jun 2023 16:08:11 +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.

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''



[Message part 3 (message/rfc822, inline)]
From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 63875-done <at> debbugs.gnu.org
Subject: Re: [External] : Re: bug#63875: 26.3; Doc of
 `dired-guess-shell-alist-user'
Date: Sat, 03 Jun 2023 19:24:39 +0300
> From: Drew Adams <drew.adams <at> oracle.com>
> CC: "63875 <at> debbugs.gnu.org" <63875 <at> debbugs.gnu.org>
> 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.


This bug report was last modified 1 year and 351 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.