github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-07-27 09:36:22 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

perf auxtrace: Add kernel-doc comment to auxtrace_record__init() function

Browse Source 
Add documentation comment describing the parameters
and return code for auxtrace_record__init() in util/auxtrace.c

Reviewed-by: Adrian Hunter <adrian.hunter@intel.com>
Signed-off-by: Athira Rajeev <atrajeev@linux.ibm.com>
Cc: Hari Bathini <hbathini@linux.vnet.ibm.com>
Cc: Ian Rogers <irogers@google.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Madhavan Srinivasan <maddy@linux.ibm.com>
Cc: Michael Petlan <mpetlan@redhat.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Shivani Nittor <shivani@linux.ibm.com>
Cc: Tanushree.Shah@ibm.com
Cc: Tejas.Manhas1@ibm.com
Cc: Thomas Richter <tmricht@linux.ibm.com>
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
This commit is contained in:
Athira Rajeev 2026-05-04 20:43:21 +05:30 committed by Arnaldo Carvalho de Melo
parent 789d22d778
commit 3ca7f9ef8f
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
tools/perf/util/auxtrace.c
View File

@ -896,6 +896,21 @@ int auxtrace_parse_aux_action(struct evlist *evlist)
return 0;
}
/**
* auxtrace_record__init - Initialize an AUX area tracing record.
* @evlist: The list of events to check for AUX area tracing event.
* @err: Pointer to an integer to store return code.
*
* This function looks through the @evlist to determine which AUX area
* tracing hardware is being used and initializes the auxtrace_record
* structure.
*
* Return:
* a) A pointer to the struct auxtrace_record with @err = 0 on success.
* b) NULL with @err = 0 if no AUX area tracing event is found/supported
* (not considered an error).
* c) NULL with non-zero @err on actual auxtrace_record__init failure.
*/
struct auxtrace_record *__weak
auxtrace_record__init(struct evlist *evlist __maybe_unused, int *err)
{