From: tip-bot for Adrian Hunter <tipbot@zytor.com>
To: linux-tip-commits@vger.kernel.org
Cc: acme@redhat.com, linux-kernel@vger.kernel.org,
eranian@google.com, paulus@samba.org, mingo@redhat.com,
hpa@zytor.com, mingo@kernel.org, a.p.zijlstra@chello.nl,
efault@gmx.de, namhyung@gmail.com, jolsa@redhat.com,
fweisbec@gmail.com, adrian.hunter@intel.com, dsahern@gmail.com,
tglx@linutronix.de
Subject: [tip:perf/core] perf evlist: Fix perf_evlist__mmap comments
Date: Wed, 23 Oct 2013 00:54:12 -0700 [thread overview]
Message-ID: <tip-c83fa7f2549cb60bc4d429de31096546f659ce6d@git.kernel.org> (raw)
In-Reply-To: <1382099356-4918-16-git-send-email-adrian.hunter@intel.com>
Commit-ID: c83fa7f2549cb60bc4d429de31096546f659ce6d
Gitweb: http://git.kernel.org/tip/c83fa7f2549cb60bc4d429de31096546f659ce6d
Author: Adrian Hunter <adrian.hunter@intel.com>
AuthorDate: Fri, 18 Oct 2013 15:29:12 +0300
Committer: Arnaldo Carvalho de Melo <acme@redhat.com>
CommitDate: Mon, 21 Oct 2013 11:19:43 -0300
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: Adrian 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: Arnaldo Carvalho de Melo <acme@redhat.com>
---
tools/perf/util/evlist.c | 21 +++++++++------------
1 file changed, 9 insertions(+), 12 deletions(-)
diff --git a/tools/perf/util/evlist.c b/tools/perf/util/evlist.c
index 07ba0a4..acef94a 100644
--- a/tools/perf/util/evlist.c
+++ b/tools/perf/util/evlist.c
@@ -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)
next prev parent reply other threads:[~2013-10-23 7:54 UTC|newest]
Thread overview: 54+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-10-18 12:28 [PATCH 00/19] perf tools: fixes and tweaks Adrian Hunter
2013-10-18 12:28 ` [PATCH 01/19] perf evsel: Add missing 'mmap2' from debug print Adrian Hunter
2013-10-23 7:53 ` [tip:perf/core] " tip-bot for Adrian Hunter
2013-10-18 12:28 ` [PATCH 02/19] perf evsel: Add a debug print if perf_event_open fails Adrian Hunter
2013-10-18 12:29 ` [PATCH 03/19] perf record: Improve write_output error message Adrian Hunter
2013-10-20 20:43 ` Jiri Olsa
2013-10-21 6:07 ` Adrian Hunter
2013-10-21 8:48 ` Jiri Olsa
2013-10-23 7:53 ` [tip:perf/core] " tip-bot for Adrian Hunter
2013-10-18 12:29 ` [PATCH 04/19] perf evsel: Add missing decrement in id sample parsing Adrian Hunter
2013-10-20 20:44 ` Jiri Olsa
2013-10-23 7:53 ` [tip:perf/core] " tip-bot for Adrian Hunter
2013-10-18 12:29 ` [PATCH 05/19] perf session: Add missing sample flush for piped events Adrian Hunter
2013-10-20 20:45 ` Jiri Olsa
2013-10-23 7:53 ` [tip:perf/core] " tip-bot for Adrian Hunter
2013-10-18 12:29 ` [PATCH 06/19] perf session: Add missing members to perf_event__attr_swap() Adrian Hunter
2013-10-20 20:47 ` Jiri Olsa
2013-10-23 7:53 ` [tip:perf/core] " tip-bot for Adrian Hunter
2013-10-18 12:29 ` [PATCH 07/19] perf script: Set up output options for in-stream attributes Adrian Hunter
2013-10-18 13:30 ` David Ahern
2013-10-18 14:32 ` Arnaldo Carvalho de Melo
2013-10-22 7:35 ` Adrian Hunter
2013-10-18 12:29 ` [PATCH 08/19] perf inject: Do not repipe attributes to a perf.data file Adrian Hunter
2013-10-18 12:29 ` [PATCH 09/19] perf tools: Fix 32-bit cross build Adrian Hunter
2013-10-20 20:42 ` Jiri Olsa
2013-10-21 5:53 ` Adrian Hunter
2013-10-21 8:46 ` Jiri Olsa
2013-10-21 9:02 ` Adrian Hunter
2013-10-21 14:12 ` Arnaldo Carvalho de Melo
2013-10-21 18:29 ` Adrian Hunter
2013-10-18 12:29 ` [PATCH 10/19] perf evlist: Fix 32-bit build error Adrian Hunter
2013-10-23 7:53 ` [tip:perf/core] " tip-bot for Adrian Hunter
2013-10-18 12:29 ` [PATCH 11/19] perf tools: Fix test_on_exit for 32-bit build Adrian Hunter
2013-10-23 7:53 ` [tip:perf/core] " tip-bot for Adrian Hunter
2013-10-18 12:29 ` [PATCH 12/19] perf tools: Fix bench/numa.c " Adrian Hunter
2013-10-23 7:54 ` [tip:perf/core] " tip-bot for Adrian Hunter
2013-10-18 12:29 ` [PATCH 13/19] perf tools: Fix libunwind build and feature detection " Adrian Hunter
2013-10-20 20:43 ` Jiri Olsa
2013-10-21 14:14 ` Arnaldo Carvalho de Melo
2013-10-22 7:40 ` Adrian Hunter
2013-10-18 12:29 ` [PATCH 14/19] perf evlist: Add a debug print if event buffer mmap fails Adrian Hunter
2013-10-20 20:43 ` Jiri Olsa
2013-10-18 12:29 ` [PATCH 15/19] perf tools: fix perf_evlist__mmap comments Adrian Hunter
2013-10-23 7:54 ` tip-bot for Adrian Hunter [this message]
2013-10-18 12:29 ` [PATCH 16/19] perf tools: factor out duplicated evlist mmap code Adrian Hunter
2013-10-23 7:54 ` [tip:perf/core] perf evlist: Factor out duplicated " tip-bot for Adrian Hunter
2013-10-18 12:29 ` [PATCH 17/19] perf script: print addr by default for BTS Adrian Hunter
2013-10-18 18:20 ` David Ahern
2013-10-23 7:54 ` [tip:perf/core] perf script: Print " tip-bot for Adrian Hunter
2013-10-18 12:29 ` [PATCH 18/19] perf record: add an option to force per-cpu mmaps Adrian Hunter
2013-10-18 12:29 ` [PATCH 19/19] perf tools: allow non-matching sample types Adrian Hunter
2013-10-18 14:25 ` David Ahern
2013-10-18 14:50 ` Adrian Hunter
2013-10-18 15:03 ` David Ahern
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=tip-c83fa7f2549cb60bc4d429de31096546f659ce6d@git.kernel.org \
--to=tipbot@zytor.com \
--cc=a.p.zijlstra@chello.nl \
--cc=acme@redhat.com \
--cc=adrian.hunter@intel.com \
--cc=dsahern@gmail.com \
--cc=efault@gmx.de \
--cc=eranian@google.com \
--cc=fweisbec@gmail.com \
--cc=hpa@zytor.com \
--cc=jolsa@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-tip-commits@vger.kernel.org \
--cc=mingo@kernel.org \
--cc=mingo@redhat.com \
--cc=namhyung@gmail.com \
--cc=paulus@samba.org \
--cc=tglx@linutronix.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).