There's an extraneous newline in this patch. I'll post a revised v2 version.
On 5/19/2010 3:42 PM, Corey Ashford wrote: > Add documentation in the main libpfm man page that makes it clear > that pfm_initialize() needs to be called before any of the other > library functions can be used. > > Signed-off-by: Corey Ashford <cjash...@us.ibm.com> > --- > docs/man3/libpfm.3 | 14 +++++++++----- > 1 files changed, 9 insertions(+), 5 deletions(-) > > diff --git a/docs/man3/libpfm.3 b/docs/man3/libpfm.3 > index 73f6ced..30b34da 100644 > --- a/docs/man3/libpfm.3 > +++ b/docs/man3/libpfm.3 > @@ -1,4 +1,4 @@ > -.TH LIBPFM 4 "September, 2009" "" "Linux Programmer's Manual" > +.TH LIBPFM 4 "May, 2010" "" "Linux Programmer's Manual" > .SH NAME > libpfm \- a helper library to develop monitoring tools > .SH SYNOPSIS > @@ -28,10 +28,14 @@ a user specifies an event to measure as a string and the > library returns > the parameters needed to invoke the kernel API. It is important to realize > that the library does \fBnot\fR make the system call to program the event. > > +\fBNote:\fR You must first call \fBpfm_initialize()\fR in order to use any > of the other > +provided functions in the library. > + > A first part of the library provides an event listing and query > interface. This can be used to discover the events available on a specific > hardware > platform. > > + > The second part of the library provides a set of functions to obtain event > encodings form event strings. Event encoding depends primarily on the > underlying > hardware but also on the kernel API. The library offers a generic API to > address > @@ -41,9 +45,9 @@ must be passed to the kernel to program a specific event. > > .SH EVENT DETECTION > > -When the library is initialize, it first detects the underlying hardware > -and software configuration. Based on this information it enables certain > -PMU support. Multiple events tables may be activated. > +When the library is initialized via \fBpfm_initialize()\fR, it first detects > the > +underlying hardware and software configuration. Based on this information > +it enables certain PMU support. Multiple events tables may be activated. > > It is possible to force activation of a specific PMU (group of events) > using an environment variable. > @@ -114,6 +118,6 @@ Robert Richter <robert.rich...@amd.com> > .SH SEE ALSO > libpfm_amd64(3), libpfm_intel_core(3), libpfm_intel_atom(3), > libpfm_intel_p6(3), libpfm_intel_nhm(3), libpfm_intel_nhm_unc(3), > -pfm_get_perf_event_encoding(3) > +pfm_get_perf_event_encoding(3), pfm_initialize(3) > .sp > Some examples are shipped with the library -- Regards, - Corey Corey Ashford Software Engineer IBM Linux Technology Center, Linux Toolchain Beaverton, OR 503-578-3507 cjash...@us.ibm.com ------------------------------------------------------------------------------ _______________________________________________ perfmon2-devel mailing list perfmon2-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/perfmon2-devel
