From: Michal Privoznik Date: Thu, 29 Nov 2012 08:30:58 +0000 (+0100) Subject: libvirt.c: Fix wording and grammar in virDomainFSTrim X-Git-Tag: CVE-2012-3411~17 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5049b53689128701e5bb72fa578467ac34071be9;p=thirdparty%2Flibvirt.git libvirt.c: Fix wording and grammar in virDomainFSTrim The documentation to this API has some defects from grammar and wording POV. These were raised after I've pushed the patches, so they are in a separate commit. --- diff --git a/src/libvirt.c b/src/libvirt.c index b1854e352a..4581394df1 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -20229,18 +20229,19 @@ error: /** * virDomainFSTrim: * @dom: a domain object - * @mountPoint: which mount point trim + * @mountPoint: which mount point to trim * @minimum: Minimum contiguous free range to discard in bytes * @flags: extra flags, not used yet, so callers should always pass 0 * * Calls FITRIM within the guest (hence guest agent may be * required depending on hypervisor used). Either call it on each * mounted filesystem (@mountPoint is NULL) or just on specified - * @mountPoint. @minimum tell that free ranges smaller than this + * @mountPoint. @minimum hints that free ranges smaller than this * may be ignored (this is a hint and the guest may not respect * it). By increasing this value, the fstrim operation will * complete more quickly for filesystems with badly fragmented * free space, although not all blocks will be discarded. + * If @minimum is not zero, the command may fail. * * Returns 0 on success, -1 otherwise. */