[PATCH v1 14/14] libperf cpumap: Document perf_cpu_map__nr's behavior

[Arnaldo Carvalho de Melo]

Em Tue, Dec 12, 2023 at 03:20:47PM +0000, James Clark escreveu:
> On 29/11/2023 06:02, Ian Rogers wrote:
> >  LIBPERF_API void perf_cpu_map__put(struct perf_cpu_map *map);
> > +/**
> > + * perf_cpu_map__cpu - get the CPU value at the given index. Returns -1 if index
> > + *                     is invalid.
> > + */
> >  LIBPERF_API struct perf_cpu perf_cpu_map__cpu(const struct perf_cpu_map *cpus, int idx);
> > +/**
> > + * perf_cpu_map__nr - for an empty map returns 1, as perf_cpu_map__cpu returns a
> > + *                    cpu of -1 for an invalid index, this makes an empty map
> > + *                    look like it contains the "any CPU"/dummy value. Otherwise
> > + *                    the result is the number CPUs in the map plus one if the
> > + *                    "any CPU"/dummy value is present.
> 
> Hmmm... I'm not sure whether to laugh or cry at that API.
> 
> Reviewed-by: James Clark <james.clark at arm.com>



Thanks, applied to perf-tools-next.

- Arnaldo