History

perf: Fix typos in sample code in the perf_event.h header

struct perf_event_mmap_page has members called "index" and "cap_user_rdpmc". Spell them correctly in the examples.

Andy Lutomirski committed 12 years ago

Commit b438b1a1 parent c719f561 file · +7 −7Browse files

Showing the changes to include/uapi/linux (1 of 1 file). Show all

Unified · Split

include/uapi/linux/perf_event.h+7−7
@@ -364,7 +364,7 @@ struct perf_event_mmap_page { · 363 unmodified lines
364364 /*
365365 * Bits needed to read the hw events in user-space.
366366 *
367− * u32 seq, time_mult, time_shift, idx, width;
367+ * u32 seq, time_mult, time_shift, index, width;
368368 * u64 count, enabled, running;
369369 * u64 cyc, time_offset;
370370 * s64 pmc = 0;
@@ -383,11 +383,11 @@ struct perf_event_mmap_page { · 12 unmodified lines
383383 * time_shift = pc->time_shift;
384384 * }
385385 *
386− * idx = pc->index;
386+ * index = pc->index;
387387 * count = pc->offset;
388− * if (pc->cap_usr_rdpmc && idx) {
388+ * if (pc->cap_user_rdpmc && index) {
389389 * width = pc->pmc_width;
390− * pmc = rdpmc(idx - 1);
390+ * pmc = rdpmc(index - 1);
391391 * }
392392 *
393393 * barrier();
@@ -415,7 +415,7 @@ struct perf_event_mmap_page { · 21 unmodified lines
415415 };
416416
417417 /*
418− * If cap_usr_rdpmc this field provides the bit-width of the value
418+ * If cap_user_rdpmc this field provides the bit-width of the value
419419 * read using the rdpmc() or equivalent instruction. This can be used
420420 * to sign extend the result like:
421421 *
@@ -439,10 +439,10 @@ struct perf_event_mmap_page { · 17 unmodified lines
439439 *
440440 * Where time_offset,time_mult,time_shift and cyc are read in the
441441 * seqcount loop described above. This delta can then be added to
442− * enabled and possible running (if idx), improving the scaling:
442+ * enabled and possible running (if index), improving the scaling:
443443 *
444444 * enabled += delta;
445− * if (idx)
445+ * if (index)
446446 * running += delta;
447447 *
448448 * quot = count / running;