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@redhat.com>
This commit is contained in:
Michal Privoznik 2016-03-31 11:09:56 +02:00
parent 510991b65a
commit 905d1846cb

View File

@ -9695,11 +9695,13 @@ virDomainOpenChannel(virDomainPtr dom,
* @domain: a domain object * @domain: a domain object
* @params: where to store perf events setting * @params: where to store perf events setting
* @nparams: number of items in @params * @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 * Get all Linux perf events setting. Possible fields returned in
* defined by VIR_DOMAIN_PERF_* macros and new fields will likely be * @params are defined by VIR_PERF_EVENT_* macros and new fields
* introduced in the future. * 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. * 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 * @params: pointer to perf events parameter object
* @nparams: number of perf event parameters (this value can be the same * @nparams: number of perf event parameters (this value can be the same
* less than the number of parameters supported) * 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. * Returns -1 in case of error, 0 in case of success.
*/ */