This is the mail archive of the
systemtap@sourceware.org
mailing list for the systemtap project.
[Bug translator/5679] New: inline documentation for scripts/tapsets
- From: "fche at redhat dot com" <sourceware-bugzilla at sourceware dot org>
- To: systemtap at sources dot redhat dot com
- Date: 26 Jan 2008 02:36:37 -0000
- Subject: [Bug translator/5679] New: inline documentation for scripts/tapsets
- Reply-to: sourceware-bugzilla at sourceware dot org
We need a way to embed documentation inside scripts and especially tapsets,
to permit:
- man pages to be generated
- more helpful error messages (typo correction suggestions)
One possible syntax was outlined at the bottom of this message:
http://sourceware.org/ml/systemtap/2007-q3/msg00466.html
The implementation could result in adding a documentation-string
field to certain staptree.h objects (perhaps just classes probe,
functiondecl, vardecl).
Bug #2949 (probe listing command line option) should use the
results of this work. Other probe types (e.g. dwarf, markers)
can synthesize/extend documentation strings from data they pull
out of debuginfo/etc. files.
--
Summary: inline documentation for scripts/tapsets
Product: systemtap
Version: unspecified
Status: NEW
Severity: normal
Priority: P2
Component: translator
AssignedTo: systemtap at sources dot redhat dot com
ReportedBy: fche at redhat dot com
OtherBugsDependingO 2949
nThis:
http://sourceware.org/bugzilla/show_bug.cgi?id=5679
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.