Re: [libvirt] [PATCHv2] storage: FS: Tweak some comments and fix typos
On 01/13/2014 03:47 AM, Peter Krempa wrote:
---
Notes:
Version 2:
- tweak most of the messages
I'm not going to push this without a review as I'm not a native speaker.
src/storage/storage_backend_fs.c | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
*
- * Starts a directory or FS based storage pool.
- *
- * - If it is a FS based pool, mounts the unlying source device on the pool
+ * Starts a directory or FS based storage pool. If the pool is a FS based
+ * pool the underlying source device will be mounted.
This one is ambiguous:
If 'FS' is pronounced 'filesystem', then it is correct as-is. If it is
pronounced 'eff-ess', then you want:
s/a FS/an FS/
But with some rewording, you can avoid the need for an article, and thus
bypass the pronunciation ambiguity:
Starts a directory or FS based storage pool. The underlying source
device will be mounted for FS based pools.
*
* Returns 0 on success, -1 on error
*/
@@ -739,7 +738,7 @@ error:
* VIR_STORAGE_POOL_BUILD_OVERWRITE is set, mkfs is always executed,
* any existed data on the target device is overwritten unconditionally.
*
- * - If it is a FS based pool, mounts the unlying source device on the pool
+ * If the pool is a FS based pool the underlying source device is mounted.
Same problem, same solution:
The underlying source device is mounted for FS based pools.
- * Stops a FS based storage pool.
+ * Stops a FS based storage pool. If @pool is a FS based pool the underlying
+ * source device is unmounted. All cached data about volumes is released.
Trickier. Also runs into singular/plural agreement ("all" pairs with
"are", "any" with "is"). How about:
Stops a file storage pool. The underlying source device is unmounted
for FS based pools. Any cached data about volumes is released.
--
Eric Blake eblake redhat com +1-919-301-3266
Libvirt virtualization library http://libvirt.org
Attachments:
- signature.asc (application/pgp-signature — 604 bytes)