Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit c83fa7f2 authored by Adrian Hunter's avatar Adrian Hunter Committed by Arnaldo Carvalho de Melo
Browse files

perf evlist: Fix perf_evlist__mmap comments 



Put the comments into the correct kernel-doc format and correct
reference to perf_evlist__read_on_cpu() which should be
perf_evlist__mmap_read().

Signed-off-by: default avatarAdrian Hunter <adrian.hunter@intel.com>
Cc: David Ahern <dsahern@gmail.com>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Mike Galbraith <efault@gmx.de>
Cc: Namhyung Kim <namhyung@gmail.com>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Cc: Stephane Eranian <eranian@google.com>
Link: http://lkml.kernel.org/r/1382099356-4918-16-git-send-email-adrian.hunter@intel.com


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 2100f778

tools/perf/util/evlist.c

+9 −12
Original line number Diff line number Diff line
@@ -738,20 +738,17 @@ int perf_evlist__parse_mmap_pages(const struct option *opt, const char *str, 
	return 0;

}



/** perf_evlist__mmap - Create per cpu maps to receive events

 *

 * @evlist - list of events

 * @pages - map length in pages

 * @overwrite - overwrite older events?

 *

 * If overwrite is false the user needs to signal event consuption using:

 *

 *	struct perf_mmap *m = &evlist->mmap[cpu];

 *	unsigned int head = perf_mmap__read_head(m);

/**

 * perf_evlist__mmap - Create mmaps to receive events.

 * @evlist: list of events

 * @pages: map length in pages

 * @overwrite: overwrite older events?

 *

 *	perf_mmap__write_tail(m, head)

 * If @overwrite is %false the user needs to signal event consumption using

 * perf_mmap__write_tail().  Using perf_evlist__mmap_read() does this

 * automatically.

 *

 * Using perf_evlist__read_on_cpu does this automatically.

 * Return: %0 on success, negative error code otherwise.

 */

int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,

		      bool overwrite)