Hi,
attached you can find two patches from Vincent Danjean and me that fix a
few typos and hyphenation problems in the manpage and the event
descriptions. These were discovered by the 'lintian' tool while
packaging libpfm4 for Debian.
Andreas
>From 5a32d85b443fb4dd63c3173bac148e4deadd245c Mon Sep 17 00:00:00 2001
From: Vincent Danjean <vincent.danj...@ens-lyon.org>
Date: Sun, 3 Mar 2013 21:51:02 +0100
Subject: [PATCH 1/2] fix typos and hyphenation in manpages
---
docs/man3/pfm_get_event_encoding.3 | 2 +-
docs/man3/pfm_get_event_next.3 | 10 +++++-----
docs/man3/pfm_strerror.3 | 2 +-
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/docs/man3/pfm_get_event_encoding.3 b/docs/man3/pfm_get_event_encoding.3
index dce196b..10187c7 100644
--- a/docs/man3/pfm_get_event_encoding.3
+++ b/docs/man3/pfm_get_event_encoding.3
@@ -59,7 +59,7 @@ specific man page.
The raw encoding means the encoding as mandated by the underlying PMU model. It may not be directly suitable
to pass to a kernel API. You may want to use API-specific library calls to ensure the correct encoding is passed.
-If \fBfstr\fR is not NULL, it will point to the fully qualified event string upon succesful return. The string
+If \fBfstr\fR is not NULL, it will point to the fully qualified event string upon successful return. The string
contains the event name, any umask set, and the value of all the modifiers. It reflects what the encoding will
actually measure. The function allocates the memory to store the string. The caller must eventually free the
string.
diff --git a/docs/man3/pfm_get_event_next.3 b/docs/man3/pfm_get_event_next.3
index da0be17..3a14af6 100644
--- a/docs/man3/pfm_get_event_next.3
+++ b/docs/man3/pfm_get_event_next.3
@@ -12,7 +12,7 @@ Events are uniquely identified with opaque integer identifiers.
There is no guaranteed order within identifiers. Thus, to list
all the events, it is necessary to use iterators.
-Events are grouped in tables within the libary. A table usually
+Events are grouped in tables within the library. A table usually
corresponds to a PMU model or family. The library contains support
for multiple PMU models, thus it has multiple tables. Based on the
host hardware and software environments, tables get activated when
@@ -30,7 +30,7 @@ is usually obainted via \fBpfm_get_pmu_info()\fR.
The \fBpfm_get_event_next()\fR function returns the identifier of
next supported event after the one passed in \fBidx\fR. This iterator
stops when the last event for the PMU is passed as argument, in which
-case the function returns -1.
+case the function returns \-1.
.sp
.nf
void list_pmu_events(pfm_pmu_t pmu)
@@ -49,7 +49,7 @@ void list_pmu_events(pfm_pmu_t pmu)
if (ret != PFM_SUCCESS)
errx(1, "cannot get pmu info");
- for (i = pinfo.first_event; i != -1; i = pfm_get_event_next(i)) {
+ for (i = pinfo.first_event; i != \-1; i = pfm_get_event_next(i)) {
ret = pfm_get_event_info(i, &info);
if (ret != PFM_SUCCESS)
errx(1, "cannot get event info");
@@ -63,11 +63,11 @@ void list_pmu_events(pfm_pmu_t pmu)
.SH RETURN
The function returns the identifier of the next
-supported event. It returns -1 when the argument is already the last
+supported event. It returns \-1 when the argument is already the last
event for the PMU.
.SH ERRORS
-No error code, besides -1, is returned by this function.
+No error code, besides \-1, is returned by this function.
.SH SEE ALSO
pfm_find_event(3)
.SH AUTHOR
diff --git a/docs/man3/pfm_strerror.3 b/docs/man3/pfm_strerror.3
index 5853d68..85ef404 100644
--- a/docs/man3/pfm_strerror.3
+++ b/docs/man3/pfm_strerror.3
@@ -12,7 +12,7 @@ This function returns a string which describes the libpfm error
value in \fBcode\fR. The string returned by the call is \fBread-only\fR.
The function must \fBonly\fR be used with libpfm calls documented to return
-specific error codes. The value -1 is not considered a specific error code.
+specific error codes. The value \-1 is not considered a specific error code.
Strings and \fBpfm_pmu_t\fR return values cannot be used with this function.
Typically \fBNULL\fR is returned in case of error for string values, and
\fBPFM_PMU_NONE\fR is returned for \fBpfm_pmu_t\fR values.
--
1.8.4.4
>From 4bb0d129c9d9875e99997e61e62c19419b52b3c4 Mon Sep 17 00:00:00 2001
From: Andreas Beckmann <a.beckm...@fz-juelich.de>
Date: Tue, 23 Apr 2013 17:03:56 +0200
Subject: [PATCH 2/2] fix typos in event descriptions
---
lib/events/arm_cortex_a8_events.h | 2 +-
lib/events/arm_cortex_a9_events.h | 2 +-
lib/events/intel_netburst_events.h | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/lib/events/arm_cortex_a8_events.h b/lib/events/arm_cortex_a8_events.h
index 467813e..2b61dda 100644
--- a/lib/events/arm_cortex_a8_events.h
+++ b/lib/events/arm_cortex_a8_events.h
@@ -82,7 +82,7 @@ static const arm_entry_t arm_cortex_a8_pe []={
},
{.name = "PC_WRITE",
.code = 0x0c,
- .desc = "Software change of PC. Equivelant to branches"
+ .desc = "Software change of PC. Equivalent to branches"
},
{.name = "PC_IMM_BRANCH",
.code = 0x0d,
diff --git a/lib/events/arm_cortex_a9_events.h b/lib/events/arm_cortex_a9_events.h
index 4f56fac..c034bd3 100644
--- a/lib/events/arm_cortex_a9_events.h
+++ b/lib/events/arm_cortex_a9_events.h
@@ -82,7 +82,7 @@ static const arm_entry_t arm_cortex_a9_pe []={
},
{.name = "PC_WRITE",
.code = 0x0c,
- .desc = "Software change of PC. Equivelant to branches"
+ .desc = "Software change of PC. Equivalent to branches"
},
{.name = "PC_IMM_BRANCH",
.code = 0x0d,
diff --git a/lib/events/intel_netburst_events.h b/lib/events/intel_netburst_events.h
index 73f58da..e24f22f 100644
--- a/lib/events/intel_netburst_events.h
+++ b/lib/events/intel_netburst_events.h
@@ -396,7 +396,7 @@ static const netburst_entry_t netburst_events[] = {
.desc = "Number of entries (clipped at 15) in the IOQ that are "
"active. An allocated entry can be a sector (64 bytes) "
"or a chunk of 8 bytes. This event must be programmed in "
- "conjuction with IOQ_allocation. All 'TYPE_BIT*' event-masks "
+ "conjunction with IOQ_allocation. All 'TYPE_BIT*' event-masks "
"together are treated as a single 5-bit value",
.event_select = 0x1A,
.escr_select = 0x6,
--
1.8.4.4
------------------------------------------------------------------------------
Rapidly troubleshoot problems before they affect your business. Most IT
organizations don't have a clear picture of how application performance
affects their revenue. With AppDynamics, you get 100% visibility into your
Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics Pro!
http://pubads.g.doubleclick.net/gampad/clk?id=84349351&iu=/4140/ostg.clktrk
_______________________________________________
perfmon2-devel mailing list
perfmon2-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/perfmon2-devel
