Bug 2949 - need "probe listing" command line option
Summary: need "probe listing" command line option
Status: RESOLVED FIXED
Alias: None
Product: systemtap
Classification: Unclassified
Component: translator (show other bugs)
Version: unspecified
: P2 normal
Target Milestone: ---
Assignee: Unassigned
URL:
Keywords:
Depends on: 5679
Blocks:
  Show dependency treegraph
 
Reported: 2006-07-21 17:54 UTC by Frank Ch. Eigler
Modified: 2008-04-10 19:40 UTC (History)
0 users

See Also:
Host:
Target:
Build:
Last reconfirmed:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Frank Ch. Eigler 2006-07-21 17:54:56 UTC
The stap program should have a command line option that
- lists available probes matching a probe-point wildcard
  (something like "-p2 -e 'probe $PATTERN' {}" but prettier)
- for probe aliases from a tapset, lists their local variables

This should enable tapsets that neglect to document themselves
in stapprobes(5) to still be presentable.
Comment 1 Josh Stone 2006-07-27 16:28:51 UTC
For tapsets, it might be nice if we had inline documentation describing probe
points and local variables, and then a 'stapdoc' command-line could present that
in a nice way.  I would imagine this would work something like a doxygen syntax,
or Perl's POD, or Python's pydoc.
Comment 2 Frank Ch. Eigler 2007-05-05 14:50:43 UTC
Maybe we could kill two birds with one stone.

Many of our tapset functions/probes remain undocumented (and some untested,
but that's another problem).   We could ease the former problem by including
documentation right within the tapset script files, a la the javadoc experiment
in the runtime.

This would enable the translator to parse these documentation bits, and print
them alongside the raw data produced by the future list-probes option.
Comment 3 Frank Ch. Eigler 2008-04-10 19:40:03 UTC
patch committed