bug#10806: 24.0.93; `cancel-edebug-on-entry': many tiny problems

bug#10806: 24.0.93; `cancel-edebug-on-entry': many tiny problems

[Michael Heerdegen]

1. It is a user command, but is has no docstring.

2. The user can't find it easily: it doesn't start with "edebug".  I
needed to consult the source to find it.  Can we at least add
something like

  (defalias 'edebug-cancel-edebug-on-entry #'cancel-edebug-on-entry)

3. The prompt string "Edebug on entry to: " should include the word
"cancel".

4. Wouldn't it be better to limit the input to functions that are
instrumented?


Thanks,

Michael.


In GNU Emacs 24.0.93.1 (i486-pc-linux-gnu, GTK+ Version 3.2.3)
 of 2012-02-08 on zelenka, modified by Debian
 (emacs-snapshot package, version 2:20120208-1)
Windowing system distributor `The X.Org Foundation', version 11.0.11103901
Configured using:
 `configure '--build' 'i486-linux-gnu' '--host' 'i486-linux-gnu'
 '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib'
 '--localstatedir=/var' '--infodir=/usr/share/info'
 '--mandir=/usr/share/man' '--with-pop=yes'
 '--enable-locallisppath=/etc/emacs-snapshot:/etc/emacs:/usr/local/share/emacs/24.0.93/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/24.0.93/site-lisp:/usr/share/emacs/site-lisp'
 '--without-compress-info' '--with-crt-dir=/usr/lib/i386-linux-gnu/'
 '--with-x=yes' '--with-x-toolkit=gtk3' '--with-imagemagick=yes'
 'build_alias=i486-linux-gnu' 'host_alias=i486-linux-gnu'
 'CFLAGS=-DDEBIAN -DSITELOAD_PURESIZE_EXTRA=5000 -g -O2''

bug#10806: 24.0.93; `cancel-edebug-on-entry': many tiny problems

[Stefan Monnier]

> 1. It is a user command, but is has no docstring.
> 2. The user can't find it easily: it doesn't start with "edebug".  I
> needed to consult the source to find it.  Can we at least add
> something like

>   (defalias 'edebug-cancel-edebug-on-entry #'cancel-edebug-on-entry)

Yes.

> 3. The prompt string "Edebug on entry to: " should include the word
> "cancel".

Yes.

> 4. Wouldn't it be better to limit the input to functions that are
> instrumented?

Yes (or we could also consider making edebug-on-entry into a toggle).

Patch welcome for 24.2,


        Stefan

bug#10806: 24.0.93; `cancel-edebug-on-entry': many tiny problems

[Lars Ingebrigtsen]

Michael Heerdegen <michael_heerdegen@web.de> writes:

> 1. It is a user command, but is has no docstring.
>
> 2. The user can't find it easily: it doesn't start with "edebug".  I
> needed to consult the source to find it.  Can we at least add
> something like
>
>   (defalias 'edebug-cancel-edebug-on-entry #'cancel-edebug-on-entry)
>
> 3. The prompt string "Edebug on entry to: " should include the word
> "cancel".
>
> 4. Wouldn't it be better to limit the input to functions that are
> instrumented?

It looks like these things have been fixed in the years since -- except
that it looks like it's had a doc string since at least 2005, and the
prompt has mentioned "cancel" since that time, too?

But the alias hasn't been added -- Stefan OK'd it, though, so I've now
added it in Emacs 27, and I'm closing this bug report.

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

bug#10806: 24.0.93; `cancel-edebug-on-entry': many tiny problems

[Lars Ingebrigtsen]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> It looks like these things have been fixed in the years since -- except
> that it looks like it's had a doc string since at least 2005, and the
> prompt has mentioned "cancel" since that time, too?
>
> But the alias hasn't been added -- Stefan OK'd it, though, so I've now
> added it in Emacs 27, and I'm closing this bug report.

I was confused -- I was looking at cancel-debug-on-entry, not
cancel-edebug-on-entry.

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

bug#10806: 24.0.93; `cancel-edebug-on-entry': many tiny problems

[Lars Ingebrigtsen]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> Lars Ingebrigtsen <larsi@gnus.org> writes:
>
>> It looks like these things have been fixed in the years since -- except
>> that it looks like it's had a doc string since at least 2005, and the
>> prompt has mentioned "cancel" since that time, too?
>>
>> But the alias hasn't been added -- Stefan OK'd it, though, so I've now
>> added it in Emacs 27, and I'm closing this bug report.
>
> I was confused -- I was looking at cancel-debug-on-entry, not
> cancel-edebug-on-entry.

I've now fixed the things the bug report mentioned in Emacs 27.

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

bug#10806: 24.0.93; `cancel-edebug-on-entry': many tiny problems

[Michael Heerdegen]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> I've now fixed the things the bug report mentioned in Emacs 27.

Thanks!

Two comments:

(1)

> +  (unless functions
> +    (error "No functions have `edebug-on-entry'."))

Should this better be a `user-error' (and I guess the error message
should not end with a period)?

(2) Would it make sense to make the default behavior analog to that of
`cancel-debug-on-entry': remove edebug-on-entry property of all
functions?


Regards,

Michael.

bug#10806: 24.0.93; `cancel-edebug-on-entry': many tiny problems

[Lars Ingebrigtsen]

Michael Heerdegen <michael_heerdegen@web.de> writes:

>> +  (unless functions
>> +    (error "No functions have `edebug-on-entry'."))
>
> Should this better be a `user-error' (and I guess the error message
> should not end with a period)?

Yup; fixed now.

> (2) Would it make sense to make the default behavior analog to that of
> `cancel-debug-on-entry': remove edebug-on-entry property of all
> functions?

Hm...  Good idea.  I've now made this change.

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