[libvirt] [PATCH] Minor comment changes.

[Daniel P. Berrange]

On Sun, Aug 30, 2009 at 04:06:45PM -0400, Laine Stump wrote:
> Fix some minor grammer (and one other) nits in comments that end up in
> generated API reference documentation. No functional/binary differences.
> ---
>  src/libvirt.c |   24 ++++++++++++------------
>  1 files changed, 12 insertions(+), 12 deletions(-)
> 
> diff --git a/src/libvirt.c b/src/libvirt.c
> index ca8e003..ce3d6ba 100644
> --- a/src/libvirt.c
> +++ b/src/libvirt.c
> @@ -592,9 +592,9 @@ virRegisterNetworkDriver(virNetworkDriverPtr driver)
>  
>  /**
>   * virRegisterInterfaceDriver:
> - * @driver: pointer to a interface driver block
> + * @driver: pointer to an interface driver block
>   *
> - * Register a interface virtualization driver
> + * Register an interface virtualization driver
>   *
>   * Returns the driver priority or -1 in case of error.
>   */
> @@ -5365,7 +5365,7 @@ error:
>  /**
>   * virNetworkGetXMLDesc:
>   * @network: a network object
> - * @flags: and OR'ed set of extraction flags, not used yet
> + * @flags: an OR'ed set of extraction flags, not used yet
>   *
>   * Provide an XML description of the network. The description may be reused
>   * later to relaunch the network with virNetworkCreateXML().
> @@ -5545,7 +5545,7 @@ error:
>  
>  /**
>   * virInterfaceGetConnect:
> - * @iface: pointer to a interface
> + * @iface: pointer to an interface
>   *
>   * Provides the connection pointer associated with an interface.  The
>   * reference counter on the connection is not increased by this
> @@ -5819,7 +5819,7 @@ error:
>  
>  /**
>   * virInterfaceGetName:
> - * @iface: a interface object
> + * @iface: an interface object
>   *
>   * Get the public name for that interface
>   *
> @@ -5842,9 +5842,9 @@ virInterfaceGetName(virInterfacePtr iface)
>  
>  /**
>   * virInterfaceGetMACString:
> - * @iface: a interface object
> + * @iface: an interface object
>   *
> - * Get the MAC for a interface as string. For more information about
> + * Get the MAC for an interface as string. For more information about
>   * MAC see RFC4122.
>   *
>   * Returns a pointer to the MAC address (in null-terminated ASCII
> @@ -5867,11 +5867,11 @@ virInterfaceGetMACString(virInterfacePtr iface)
>  
>  /**
>   * virInterfaceGetXMLDesc:
> - * @iface: a interface object
> - * @flags: and OR'ed set of extraction flags, not used yet
> + * @iface: an interface object
> + * @flags: an OR'ed set of extraction flags, not used yet
>   *
>   * Provide an XML description of the interface. The description may be reused
> - * later to recreate the interface with virInterfaceCreateXML().
> + * later to redefine the interface with virInterfaceDefineXML().
>   *
>   * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
>   *         the caller must free() the returned value.
> @@ -6100,7 +6100,7 @@ error:
>   * This method is typically useful for applications where multiple
>   * threads are using a connection, and it is required that the
>   * connection remain open until all threads have finished using
> - * it. ie, each new thread using a interface would increment
> + * it. ie, each new thread using an interface would increment
>   * the reference count.
>   *
>   * Returns 0 in case of success, -1 in case of failure.
> @@ -6121,7 +6121,7 @@ virInterfaceRef(virInterfacePtr iface)
>  
>  /**
>   * virInterfaceFree:
> - * @iface: a interface object
> + * @iface: an interface object
>   *
>   * Free the interface object. The interface itself is unaltered.
>   * The data structure is freed and should not be used thereafter.
> -- 

ACK


Daniel
-- 
|: Red Hat, Engineering, London   -o-   http://people.redhat.com/berrange/ :|
|: http://libvirt.org  -o-  http://virt-manager.org  -o-  http://ovirt.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: GnuPG: 7D3B9505  -o-  F3C9 553F A1DA 4AC2 5648 23C1 B3DF F742 7D3B 9505 :|