External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-10 14:57:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

libvirt.c: Fix wording and grammar in virDomainFSTrim

Browse Source 
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.
This commit is contained in:
Michal Privoznik 2012-11-29 09:30:58 +01:00
parent 33f49f211a
commit 5049b53689
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/libvirt.c
View File

@ -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.
*/