lkml.org 
[lkml]   [2021]   [Oct]   [15]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    Date
    Subject[PATCH v2 11/21] perf metric: Document the internal 'struct metric'
    From
    Add documentation as part of code tidying.

    Acked-by: Andi Kleen <ak@linux.intel.com>
    Signed-off-by: Ian Rogers <irogers@google.com>
    ---
    tools/perf/util/metricgroup.c | 20 ++++++++++++++++++++
    1 file changed, 20 insertions(+)

    diff --git a/tools/perf/util/metricgroup.c b/tools/perf/util/metricgroup.c
    index c96f9fe163f9..632867cedbae 100644
    --- a/tools/perf/util/metricgroup.c
    +++ b/tools/perf/util/metricgroup.c
    @@ -117,14 +117,34 @@ struct metric_ref_node {
    struct list_head list;
    };

    +/**
    + * The metric under construction. The data held here will be placed in a
    + * metric_expr.
    + */
    struct metric {
    struct list_head nd;
    + /**
    + * The expression parse context importantly holding the IDs contained
    + * within the expression.
    + */
    struct expr_parse_ctx *pctx;
    + /** The name of the metric such as "IPC". */
    const char *metric_name;
    + /** The expression to parse, for example, "instructions/cycles". */
    const char *metric_expr;
    + /**
    + * The "ScaleUnit" that scales and adds a unit to the metric during
    + * output.
    + */
    const char *metric_unit;
    + /** The list of metrics referenced by this one. */
    struct list_head metric_refs;
    + /** The size of the metric_refs list. */
    int metric_refs_cnt;
    + /**
    + * Is there a constraint on the group of events? In which case the
    + * events won't be grouped.
    + */
    bool has_constraint;
    };

    --
    2.33.0.1079.g6e70778dc9-goog
    \
     
     \ /
      Last update: 2021-10-15 19:25    [W:4.553 / U:0.016 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site