forked from torvalds/linux
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tools lib traceevent: Man page for get/set cpus APIs
Create man pages for libtraceevent APIs: tep_get_cpus(), tep_set_cpus() Signed-off-by: Tzvetomir Stoyanov <[email protected]> Cc: Andrew Morton <[email protected]> Cc: Jiri Olsa <[email protected]> Cc: Namhyung Kim <[email protected]> Cc: [email protected] Link: http://lore.kernel.org/linux-trace-devel/[email protected] Link: http://lkml.kernel.org/r/[email protected] Signed-off-by: Steven Rostedt (VMware) <[email protected]> Signed-off-by: Arnaldo Carvalho de Melo <[email protected]>
- Loading branch information
1 parent
3d2626b
commit ba28fab
Showing
1 changed file
with
77 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
libtraceevent(3) | ||
================ | ||
|
||
NAME | ||
---- | ||
tep_get_cpus, tep_set_cpus - Get / set the number of CPUs, which have a tracing | ||
buffer representing it. Note, the buffer may be empty. | ||
|
||
SYNOPSIS | ||
-------- | ||
[verse] | ||
-- | ||
*#include <event-parse.h>* | ||
|
||
int *tep_get_cpus*(struct tep_handle pass:[*]_tep_); | ||
void *tep_set_cpus*(struct tep_handle pass:[*]_tep_, int _cpus_); | ||
-- | ||
|
||
DESCRIPTION | ||
----------- | ||
The _tep_get_cpus()_ function gets the number of CPUs, which have a tracing | ||
buffer representing it. The _tep_ argument is trace event parser context. | ||
|
||
The _tep_set_cpus()_ function sets the number of CPUs, which have a tracing | ||
buffer representing it. The _tep_ argument is trace event parser context. | ||
The _cpu_ argument is the number of CPUs with tracing data. | ||
|
||
RETURN VALUE | ||
------------ | ||
The _tep_get_cpus()_ functions returns the number of CPUs, which have tracing | ||
data recorded. | ||
|
||
EXAMPLE | ||
------- | ||
[source,c] | ||
-- | ||
#include <event-parse.h> | ||
... | ||
struct tep_handle *tep = tep_alloc(); | ||
... | ||
tep_set_cpus(tep, 5); | ||
... | ||
printf("We have tracing data for %d CPUs", tep_get_cpus(tep)); | ||
-- | ||
|
||
FILES | ||
----- | ||
[verse] | ||
-- | ||
*event-parse.h* | ||
Header file to include in order to have access to the library APIs. | ||
*-ltraceevent* | ||
Linker switch to add when building a program that uses the library. | ||
-- | ||
|
||
SEE ALSO | ||
-------- | ||
_libtraceevent(3)_, _trace-cmd(1)_ | ||
|
||
AUTHOR | ||
------ | ||
[verse] | ||
-- | ||
*Steven Rostedt* <[email protected]>, author of *libtraceevent*. | ||
*Tzvetomir Stoyanov* <[email protected]>, author of this man page. | ||
-- | ||
REPORTING BUGS | ||
-------------- | ||
Report bugs to <[email protected]> | ||
|
||
LICENSE | ||
------- | ||
libtraceevent is Free Software licensed under the GNU LGPL 2.1 | ||
|
||
RESOURCES | ||
--------- | ||
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git |