GNU bug report logs - #13455
24.2.91; profiler.el: missing documentation, menu stuff etc

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 13455 in the body.
You can then email your comments to 13455 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.2.91; profiler.el: missing documentation, menu stuff etc
Date: Wed, 16 Jan 2013 02:50:35 +0100

Hi Emacs,


somebody should please take care of some simple things missing, e.g.

(1) Add the main commands to the Emacs-Lisp -> Profiling menu
  (presumably into a new submenu), so that people can find it.

(2) Missing commentary header.  At least say that it's documented in the
  elisp manual.

(3) "If a given line has a `+' symbol at the left-hand side, you can
expand that line by typing <RET>, in order to see the function(s) called
by the higher-level function.  Pressing <RET> again will collapse back
to the original state."

Why not make mouse-1 do this, too?

(4) Add a menu for the profiler report.


This is all not urgent, but should be done some day.


Regards,

Michael.


In GNU Emacs 24.2.91.2 (x86_64-unknown-linux-gnu, GTK+ Version 2.24.10)
 of 2012-12-30 on drachen
Bzr revision: rgm <at> gnu.org-20121230122326-m6gw29pkwjgwqf9d
Windowing system distributor `The X.Org Foundation', version 11.0.10707000
System Description:	Debian GNU/Linux 7.0 (wheezy)

Configured using:
 `configure '--prefix=/usr/local/built/''

Important settings:
  value of $LC_ALL: de_DE.utf8
  value of $LC_TIME: C
  value of $LANG: de_DE.utf8
  locale-coding-system: utf-8-unix
  default enable-multibyte-characters: t

Message #8 received at 13455 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: michael_heerdegen <at> web.de
Cc: 13455 <at> debbugs.gnu.org
Subject: Re: bug#13455: 24.2.91;
	profiler.el: missing documentation, menu stuff etc
Date: Sat, 19 Jan 2013 21:42:04 -0500

Michael Heerdegen wrote:

> (4) Add a menu for the profiler report.

It already has one?

Message #11 received at 13455 <at> debbugs.gnu.org (full text, mbox):

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 13455 <at> debbugs.gnu.org
Subject: Re: bug#13455: 24.2.91;
	profiler.el: missing documentation, menu stuff etc
Date: Sun, 20 Jan 2013 05:17:45 +0100

Glenn Morris <rgm <at> gnu.org> writes:

> > (4) Add a menu for the profiler report.
>
> It already has one?

I tested the emacs-24 branch, where there is none.  You're right, in
trunk, there is indeed a menu.


Regards,

Michael.

Message #14 received at 13455 <at> debbugs.gnu.org (full text, mbox):

From: npostavs <at> users.sourceforge.net
To: Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: 13455 <at> debbugs.gnu.org
Subject: Re: bug#13455: 24.2.91;
 profiler.el: missing documentation, menu stuff etc
Date: Sun, 17 Jul 2016 01:14:16 -0400

[Message part 1 (text/plain, inline)]

tags 13455 patch
quit

Michael Heerdegen <michael_heerdegen <at> web.de> writes:

> (1) Add the main commands to the Emacs-Lisp -> Profiling menu
>   (presumably into a new submenu), so that people can find it.

It seems this was added in 24.4.

>
> (2) Missing commentary header.  At least say that it's documented in the
>   elisp manual.

There is now a comment pointing to the manual.

>
> (4) Add a menu for the profiler report.

As mentioned by Glenn, this is also present.

>
> (3) "If a given line has a `+' symbol at the left-hand side, you can
> expand that line by typing <RET>, in order to see the function(s) called
> by the higher-level function.  Pressing <RET> again will collapse back
> to the original state."
>
> Why not make mouse-1 do this, too?

This is still not the case, though it's easy enough to add.  Also, I'd
like to add mention of prefix arg for profiler-report-toggle-entry, I
was about make a feature request for an expand-all command, until I
realized this already worked.  Here's a patch:

[v1-0001-Make-profiler-a-bit-friendier.patch (text/x-diff, inline)]

From c0100625ce2ab45f6980a221a02c7fc106818218 Mon Sep 17 00:00:00 2001
From: Noam Postavsky <npostavs <at> gmail.com>
Date: Sun, 17 Jul 2016 00:21:42 -0400
Subject: [PATCH v1] Make profiler a bit friendier.

* doc/lispref/debugging.texi (Profiling):
* lisp/profiler.el (profiler-report-toggle-entry): Document use of
prefix argument to expand whole call trees.
(profiler-report-mode-map): Add mouse-1 binding for
profiler-report-toggle-entry (Bug #13455).
---
 doc/lispref/debugging.texi | 5 +++--
 lisp/profiler.el           | 4 +++-
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi
index 98c4705..2f83b40 100644
--- a/doc/lispref/debugging.texi
+++ b/doc/lispref/debugging.texi
@@ -840,8 +840,9 @@ Profiling
 absolute and percentage times since profiling started.  If a given
 line has a @samp{+} symbol at the left-hand side, you can expand that
 line by typing @key{RET}, in order to see the function(s) called by
-the higher-level function.  Pressing @key{RET} again will collapse
-back to the original state.
+the higher-level function.  Use a prefix argument (@key{C-u RET}) to
+see the whole call tree below a function.  Pressing @key{RET} again
+will collapse back to the original state.
 
 Press @kbd{j} or @kbd{mouse-2} to jump to the definition of a function.
 Press @kbd{d} to view a function's documentation.
diff --git a/lisp/profiler.el b/lisp/profiler.el
index 401cae5..dac42fe 100644
--- a/lisp/profiler.el
+++ b/lisp/profiler.el
@@ -534,6 +534,7 @@ profiler-report-mode-map
     (define-key map "\r"    'profiler-report-toggle-entry)
     (define-key map "\t"    'profiler-report-toggle-entry)
     (define-key map "i"     'profiler-report-toggle-entry)
+    (define-key map [mouse-1] 'profiler-report-toggle-entry)
     (define-key map "f"     'profiler-report-find-entry)
     (define-key map "j"     'profiler-report-find-entry)
     (define-key map [mouse-2] 'profiler-report-find-entry)
@@ -692,7 +693,8 @@ profiler-report-collapse-entry
 
 (defun profiler-report-toggle-entry (&optional arg)
   "Expand entry at point if the tree is collapsed,
-otherwise collapse."
+otherwise collapse.  With prefix argument, expand all subentries
+below entry at point."
   (interactive "P")
   (or (profiler-report-expand-entry arg)
       (profiler-report-collapse-entry)))
-- 
2.8.0

Message #19 received at 13455 <at> debbugs.gnu.org (full text, mbox):

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: npostavs <at> users.sourceforge.net
Cc: 13455 <at> debbugs.gnu.org
Subject: Re: bug#13455: 24.2.91;
 profiler.el: missing documentation, menu stuff etc
Date: Wed, 20 Jul 2016 01:42:27 +0200

npostavs <at> users.sourceforge.net writes:

> tags 13455 patch
> quit

> > (3) "If a given line has a `+' symbol at the left-hand side, you can
> > expand that line by typing <RET>, in order to see the function(s)
> > called
> > by the higher-level function.  Pressing <RET> again will collapse back
> > to the original state."
> >
> > Why not make mouse-1 do this, too?
>
> This is still not the case, though it's easy enough to add.  Also, I'd
> like to add mention of prefix arg for profiler-report-toggle-entry, I
> was about make a feature request for an expand-all command, until I
> realized this already worked.  Here's a patch: [...]

Looks good to me, thanks.

Can we install it to master?


Regards,

Michael.

Message #22 received at 13455 <at> debbugs.gnu.org (full text, mbox):

From: npostavs <at> users.sourceforge.net
To: Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: 13455 <at> debbugs.gnu.org
Subject: Re: bug#13455: 24.2.91;
 profiler.el: missing documentation, menu stuff etc
Date: Thu, 28 Jul 2016 20:15:50 -0400

tags 13455 fixed
close 13455 
quit

Michael Heerdegen <michael_heerdegen <at> web.de> writes:
>
> Looks good to me, thanks.
>
> Can we install it to master?

I installed the mouse-1 binding to master (4a5b6e62), and the
documentation additions to emacs-25 (272391f).

Previous Next

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