bug#13934: Minor bug in `command-line-functions'

bug#13934: Minor bug in `command-line-functions'

[Xue Fuqiao]

In the doc string of `command-line-functions':
  Each function should access the dynamically bound variables `argi'
  (the current argument) and `command-line-args-left' (the remaining
  arguments).

But in startup.el:

  (internal-make-var-non-special 'argi)

Originally posted in:
http://lists.gnu.org/archive/html/help-gnu-emacs/2013-03/msg00145.html



In GNU Emacs 24.3.50.1 (x86_64-unknown-linux-gnu, GTK+ Version 3.6.0)
 of 2013-03-10 on Emacs
Bzr revision: 111984 rgm@gnu.org-20130309202227-7xolc8f5fagp712b
Windowing system distributor `The X.Org Foundation', version 11.0.11300000
System Description:	Ubuntu 12.10

Configured using:
 `configure --enable-link-time-optimization'

Important settings:
  value of $LANG: en_US.UTF-8
  value of $XMODIFIERS: @im=fcitx
  locale-coding-system: utf-8-unix
  default enable-multibyte-characters: t

Major mode: Lisp Interaction

Minor modes in effect:
  tooltip-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  transient-mark-mode: t

Recent input:
<menu> r e - e m - b u g <tab> <return>

Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.

Load-path shadows:
None found.

Features:
(shadow sort gnus-util mail-extr emacsbug message format-spec rfc822 mml
easymenu mml-sec mm-decode mm-bodies mm-encode mail-parse rfc2231
mailabbrev gmm-utils mailheader sendmail rfc2047 rfc2045 ietf-drums
mm-util mail-prsvr mail-utils time-date tooltip ediff-hook vc-hooks
lisp-float-type mwheel x-win x-dnd tool-bar dnd fontset image regexp-opt
fringe tabulated-list newcomment lisp-mode register page menu-bar
rfn-eshadow timer select scroll-bar mouse jit-lock font-lock syntax
facemenu font-core frame cham georgian utf-8-lang misc-lang vietnamese
tibetan thai tai-viet lao korean japanese hebrew greek romanian slovak
czech european ethiopic indian cyrillic chinese case-table epa-hook
jka-cmpr-hook help simple abbrev minibuffer loaddefs button faces
cus-face macroexp files text-properties overlay sha1 md5 base64 format
env code-pages mule custom widget hashtable-print-readable backquote
make-network-process dbusbind inotify dynamic-setting
system-font-setting font-render-setting move-toolbar gtk x-toolkit x
multi-tty emacs)

-- 
Best regards, Xue Fuqiao.
http://www.emacswiki.org/emacs/XueFuqiao

bug#13934: Minor bug in `command-line-functions'

[Lars Ingebrigtsen]

Xue Fuqiao <xfq.free@gmail.com> writes:

> In the doc string of `command-line-functions':
>   Each function should access the dynamically bound variables `argi'
>   (the current argument) and `command-line-args-left' (the remaining
>   arguments).
>
> But in startup.el:
>
>   (internal-make-var-non-special 'argi)
>
> Originally posted in:
> http://lists.gnu.org/archive/html/help-gnu-emacs/2013-03/msg00145.html

Stefan says that it's a doc bug:

---
List of functions to process unrecognized command-line arguments.
Each function should access the dynamically bound variables
‘argi’ (the current argument) and ‘command-line-args-left’ (the remaining
arguments).  The function should return non-nil only if it recognizes and
processes ‘argi’.  If it does so, it may consume successive arguments by
altering ‘command-line-args-left’ to remove them.
---

But...  if `argi' isn't dynamic, then just about everything here is
incorrect, surely.  So should `command-line-functions' just do whatever
they like and never refer to `argi'?  And consume
`command-line-args-left' however they like?

It's rather confusing, especially with the:

(with-no-warnings
  (defvar argi nil
    "Current command-line argument."))
(internal-make-var-non-special 'argi)


-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#13934: Minor bug in `command-line-functions'

[Lars Ingebrigtsen]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> It's rather confusing, especially with the:
>
> (with-no-warnings
>   (defvar argi nil
>     "Current command-line argument."))
> (internal-make-var-non-special 'argi)

I tested with

(setq command-line-functions '((lambda () (message "argi %s" argi))))

and `argi' is indeed dynamically bound when 

                     ;; We have almost exhausted our options. See if the
                     ;; user has made any other command-line options available
                     (let ((hooks command-line-functions)
                           (did-hook nil))
                       (while (and hooks
                                   (not (setq did-hook (funcall (car hooks)))))
                         (setq hooks (cdr hooks)))

is executed...  so is argi dynamic in the startup.el file, but not
elsewhere in Emacs?  In which case there is really nothing to fix in the
doc string?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#13934: Minor bug in `command-line-functions'

[Eli Zaretskii]

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Date: Wed, 14 Aug 2019 23:06:05 -0700
> Cc: 13934@debbugs.gnu.org
> 
> (setq command-line-functions '((lambda () (message "argi %s" argi))))
> 
> and `argi' is indeed dynamically bound when 
> 
>                      ;; We have almost exhausted our options. See if the
>                      ;; user has made any other command-line options available
>                      (let ((hooks command-line-functions)
>                            (did-hook nil))
>                        (while (and hooks
>                                    (not (setq did-hook (funcall (car hooks)))))
>                          (setq hooks (cdr hooks)))
> 
> is executed...  so is argi dynamic in the startup.el file, but not
> elsewhere in Emacs?  In which case there is really nothing to fix in the
> doc string?

Yes, I think so.  Stefan?

bug#13934: Minor bug in `command-line-functions'

[Stefan Monnier]

>> (setq command-line-functions '((lambda () (message "argi %s" argi))))
>> 
>> and `argi' is indeed dynamically bound when 
>> 
>>                      ;; We have almost exhausted our options. See if the
>>                      ;; user has made any other command-line options available
>>                      (let ((hooks command-line-functions)
>>                            (did-hook nil))
>>                        (while (and hooks
>>                                    (not (setq did-hook (funcall (car hooks)))))
>>                          (setq hooks (cdr hooks)))
>> 
>> is executed...  so is argi dynamic in the startup.el file, but not
>> elsewhere in Emacs?  In which case there is really nothing to fix in the
>> doc string?
>
> Yes, I think so.  Stefan?

Indeed, it's dynamically scoped in startup.el but not elsewhere.


        Stefan

bug#13934: Minor bug in `command-line-functions'

[Lars Ingebrigtsen]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> Indeed, it's dynamically scoped in startup.el but not elsewhere.

So I think the doc string is pretty accurate here:

--
Each function should access the dynamically bound variables
`argi' (the current argument) and `command-line-args-left' (the remaining
arguments).
--

The functions should access these dynamically bound variables...  even
if argi isn't in other contexts, and I'm closing thing bug report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no