Edebug-x visual extensions to Edebug

Edebug-x visual extensions to Edebug

[Scott Barnett]

[-- Attachment #1: Type: text/plain, Size: 607 bytes --]

Hi all,

I made a small extension to Edebug that highlights breakpoints, shows a
list of currently instrumented functions and provides a couple of other
extras to make Edebug easier for me to use. A couple of people on #emacs
suggested I tried to get it into Emacs so I am wondering if it is something
that you would be interested in including. The project can be found here:
https://github.com/ScottyB/edebug-x.   From what I understand I have to
sign some forms to say you can keep it which I am fine with.

If this is something that should be included please let me know of the next
steps.

Cheers Scott

[-- Attachment #2: Type: text/html, Size: 784 bytes --]

Re: Edebug-x visual extensions to Edebug

[Xue Fuqiao]

On Tue, 12 Mar 2013 22:56:13 +1100
Scott Barnett <scott.n.barnett@gmail.com> wrote:

> I made a small extension to Edebug that highlights breakpoints, shows a
> list of currently instrumented functions and provides a couple of other
> extras to make Edebug easier for me to use. A couple of people on #emacs
> suggested I tried to get it into Emacs so I am wondering if it is something
> that you would be interested in including. The project can be found here:
> https://github.com/ScottyB/edebug-x.   From what I understand I have to
> sign some forms to say you can keep it which I am fine with.

Thanks for your contribution.  I have read the code roughly.  I have 3
suggestions first:

1. Since its not large (now), it is better to integrate it into
edebug.el.  If it is as large as Dired Extra, it can be separated.

2. There should be two spaces after a sentence in doc string.

3. Please add some comments.

> If this is something that should be included please let me know of the next
> steps.

To include this library, I suggest you:

1. Do copyright assignment if you haven't done it before.

2. Change the use of `cl' to `cl-lib'.

3. Avoid using `defadvice'.

4. Document your changes, then add an item to the NEWS file.

5. Write a ChangeLog entry.  See "Change Log Concepts" node of the GNU Coding Standards.

6. Write a diff to this list or bug-gnu-emacs@gnu.org.

7. IIRC the library `dash' is not distributed with either GNU Emacs or
GNU ELPA, you'd better not use it.

8. Please indent this file using the default indentation parameters.

BTW I have also wrote a minor patch for edebug (and debugger-mode):

http://debbugs.gnu.org/cgi/bugreport.cgi?bug=13777

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

Re: Edebug-x visual extensions to Edebug

[Tassilo Horn]

Scott Barnett <scott.n.barnett@gmail.com> writes:

Hi!

> I made a small extension to Edebug that highlights breakpoints, shows
> a list of currently instrumented functions and provides a couple of
> other extras to make Edebug easier for me to use.

Sounds great!

> If this is something that should be included please let me know of the
> next steps.

Except for the copyright assignment, there are at least two things I can
spot while glancing at the code that hinder its inclusion in emacs
proper.  The first one is that you shouldn't require cl, and the second
is the dependency to the external dash package.

With emacs 24 you can use `cl-restructuring-bind' and `cl-find-if'
instead of the unprefixed versions.

Instead of dash's `-each' you can use `mapc', instead of `-map' you can
use `mapcar', instead of `-remove' you can use `cl-remove-if', and
instead of `-contains?' you can use `member'.

Bye,
Tassilo

Re: Edebug-x visual extensions to Edebug

[Xue Fuqiao]

On Tue, 12 Mar 2013 15:10:23 +0100
Tassilo Horn <tsdh@gnu.org> wrote:

> With emacs 24 you can use `cl-restructuring-bind' and `cl-find-if'
> instead of the unprefixed versions.

> Instead of dash's `-each' you can use `mapc', instead of `-map' you can
> use `mapcar', instead of `-remove' you can use `cl-remove-if', and
> instead of `-contains?' you can use `member'.

I agree.

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

Re: Edebug-x visual extensions to Edebug

[Scott Barnett]

[-- Attachment #1: Type: text/plain, Size: 848 bytes --]

Thanks a lot for your help. I have started making the changes that you
suggested and I will soon start moving the functionality into Edebug.
Should I post the final patch here or to bug-gnu-emacs@gnu.org? How do I
start the copyright assignment process?

Thanks once again for your help,
Scott


On Wed, Mar 13, 2013 at 1:22 AM, Xue Fuqiao <xfq.free@gmail.com> wrote:

> On Tue, 12 Mar 2013 15:10:23 +0100
> Tassilo Horn <tsdh@gnu.org> wrote:
>
> > With emacs 24 you can use `cl-restructuring-bind' and `cl-find-if'
> > instead of the unprefixed versions.
>
> > Instead of dash's `-each' you can use `mapc', instead of `-map' you can
> > use `mapcar', instead of `-remove' you can use `cl-remove-if', and
> > instead of `-contains?' you can use `member'.
>
> I agree.
>
> --
> Best regards, Xue Fuqiao.
> http://www.emacswiki.org/emacs/XueFuqiao
>

[-- Attachment #2: Type: text/html, Size: 1730 bytes --]

Re: Edebug-x visual extensions to Edebug

[Tassilo Horn]

Scott Barnett <scott.n.barnett@gmail.com> writes:

Hi scott,

> Thanks a lot for your help. I have started making the changes that you
> suggested and I will soon start moving the functionality into Edebug.

I'd wait with that until some of the core devs (Stefan, Chong, Eli,
Glenn, Martin, etc.) gives his go.  Maybe they prefer to keep it a
separate ELPA package.

> Should I post the final patch here or to bug-gnu-emacs@gnu.org?

Attach it to a feature request created with M-x report-emacs-bug.

> How do I start the copyright assignment process?

Whoever takes care of the request will guide you through the process.

Bye,
Tassilo

Re: Edebug-x visual extensions to Edebug

[Stefan Monnier]

> I'd wait with that until some of the core devs (Stefan, Chong, Eli,
> Glenn, Martin, etc.) gives his go.  Maybe they prefer to keep it a
> separate ELPA package.

I missed this thread earlier, but it sounds like a nice improvement.

>> Should I post the final patch here or to bug-gnu-emacs@gnu.org?

You can send it to bug-gnu-emacs@gnu.org, yes.
But most likely the "final" patch won't be final, so don't hesitate to
send unfinished version for early review/feedback.  This said, the
current edebug-x.el looks pretty good.

>> How do I start the copyright assignment process?

I'll send you another email about that,


        Stefan


PS: `dolist' is faster and indents better than `mapc'.

Re: Edebug-x visual extensions to Edebug

[Stefan Monnier]

> How do I start the copyright assignment process?

Just fill the form below and send it to the FSF as instructed, so they
can send you the relevant paperwork to sign.
Thank you very much for your contribution,


        Stefan


Please email the following information to assign@gnu.org, and we
will send you the assignment form for your past and future changes.

Please use your full legal name (in ASCII characters) as the subject
line of the message.
----------------------------------------------------------------------
REQUEST: SEND FORM FOR PAST AND FUTURE CHANGES

[What is the name of the program or package you're contributing to?]
Emacs

[Did you copy any files or text written by someone else in these changes?
Even if that material is free software, we need to know about it.]


[Do you have an employer who might have a basis to claim to own
your changes?  Do you attend a school which might make such a claim?]


[For the copyright registration, what country are you a citizen of?]


[What year were you born?]


[Please write your email address here.]


[Please write your postal address here.]





[Which files have you changed so far, and which new files have you written
so far?]