Re: [libvirt] [PATCH] virDomain{Get, Set}PerfEvents: Tweak documentation

These API already support VIR_DOMAIN_AFFECT_* flags. But the documentation does not mention it. Eww. Signed-off-by: Michal Privoznik <mprivozn(a)redhat.com&gt; --- src/libvirt-domain.c | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index 3e144b6..4f473c9 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -9695,11 +9695,13 @@ virDomainOpenChannel(virDomainPtr dom, * @domain: a domain object * @params: where to store perf events setting * @nparams: number of items in @params - * @flags: extra flags; not used yet, so callers should always pass 0 + * @flags: bitwise-OR of virDomainModificationImpact * - * Get all perf events setting. Possible fields returned in @params are - * defined by VIR_DOMAIN_PERF_* macros and new fields will likely be - * introduced in the future. + * Get all Linux perf events setting. Possible fields returned in + * @params are defined by VIR_PERF_EVENT_* macros and new fields + * will likely be introduced in the future. + * + * Linux perf events are performance analyzing tool in Linux. * * Returns -1 in case of failure, 0 in case of success. */ @@ -9743,9 +9745,13 @@ int virDomainGetPerfEvents(virDomainPtr domain, * @params: pointer to perf events parameter object * @nparams: number of perf event parameters (this value can be the same * less than the number of parameters supported) - * @flags: extra flags; not used yet, so callers should always pass 0 + * @flags: bitwise-OR of virDomainModificationImpact * - * Enable or disable the particular list of perf events you care about. + * Enable or disable the particular list of Linux perf events you + * care about. The @params argument should contain any subset of + * VIR_PERF_EVENT_ macros. + * + * Linux perf events are performance analyzing tool in Linux. * * Returns -1 in case of error, 0 in case of success. */