From 6a256b03673beeea1c2d6731d5b680b50778b124 Mon Sep 17 00:00:00 2001 From: jistone Date: Fri, 8 Dec 2006 02:38:05 +0000 Subject: 2006-12-07 Josh Stone PR 3624. * stapprobes.5.in: Document the new begin/end syntax. --- ChangeLog | 1 + stapprobes.5.in | 11 +++++++++++ 2 files changed, 12 insertions(+) diff --git a/ChangeLog b/ChangeLog index 703b3be8..1e94e6e4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -9,6 +9,7 @@ (register_standard_tapsets): Add new begin/end variants. * parse.cxx (parser::parse_literal): Allow negative numeric literals, by checking for a '-' unary operator right before a number. + * stapprobes.5.in: Document the new begin/end syntax. 2006-12-06 Josh Stone diff --git a/stapprobes.5.in b/stapprobes.5.in index 20d340df..d71d038b 100644 --- a/stapprobes.5.in +++ b/stapprobes.5.in @@ -68,6 +68,17 @@ shutdown of a session, such as in the aftermath of an function call, or an interruption from the user. In the case of an error-triggered shutdown, "end" probes are not run. There are no target variables available in either context. +.PP +If the order of execution among "begin" or "end" probes is significant, +then an optional sequence number may be provided: +.SAMPLE +begin(N) +end(N) +.ESAMPLE +The number N may be positive or negative. The probe handlers are run in +increasing order, and the order between handlers with the same sequence +number is unspecified. When "begin" or "end" are given without a +sequence, they are effectively sequence zero. .SS NEVER The probe point -- cgit