[libvirt] [PATCH] correct typo: s/VIR_MIGRATE_TUNNELLED/VIR_MIGRATE_TUNNELED/, ...

[Chris Lalancette]

On 05/18/2010 01:15 PM, Jim Meyering wrote:
> Daniel P. Berrange wrote:
>> On Tue, May 18, 2010 at 06:30:34PM +0200, Jim Meyering wrote:
>>> I noticed a typo in a public interface.
>>> IMHO it's well worth fixing, so propose this:
>>> (imagine someone searching for all occurrences of "tunneled"
>>> with the proper spelling.  They would miss this symbol.)
>>
>> I don't think we should make this kind of change. It has
>> no functional gain for app developers, but adds the downside
>> that anyone using this new symbol has needlessly made their
>> code incompatible with libvirt 0.7.5, 0.8.0, 0.8.1, etc, etc
> 
> There are plenty of new features that people will be using
> that will render their code incompatible with previous releases.
> 
> However, if you insist, let's at least mark it as a known error
> so that searches for the properly spelled symbol will turn up
> the misspelled one:
> 
>>From 8ae4cc7d25efaab531f5045940c13ec3bb36497f Mon Sep 17 00:00:00 2001
> From: Jim Meyering <meyering at redhat.com>
> Date: Tue, 18 May 2010 19:13:20 +0200
> Subject: [PATCH] note a typo: VIR_MIGRATE_TUNNELLED should be VIR_MIGRATE_TUNNELED,
> 
> so that searches for properly spelled "TUNNELED" will turn up
> the misspelled symbol name.
> * include/libvirt/libvirt.h.in: Add a comment.
> ---
>  include/libvirt/libvirt.h.in |    4 +++-
>  1 files changed, 3 insertions(+), 1 deletions(-)
> 
> diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in
> index 838028d..5cb23b3 100644
> --- a/include/libvirt/libvirt.h.in
> +++ b/include/libvirt/libvirt.h.in
> @@ -4,7 +4,7 @@
>   * Description: Provides the interfaces of the libvirt library to handle
>   *              virtualized domains
>   *
> - * Copy:  Copyright (C) 2005,2006 Red Hat, Inc.
> + * Copy:  Copyright (C) 2005,2006,2010 Red Hat, Inc.
>   *
>   * See COPYING.LIB for the License of this software
>   *
> @@ -407,6 +407,8 @@ typedef enum {
>  typedef enum {
>      VIR_MIGRATE_LIVE              = (1 << 0), /* live migration */
>      VIR_MIGRATE_PEER2PEER         = (1 << 1), /* direct source -> dest host control channel */
> +    /* note the spelling error that we're stuck with:
> +       VIR_MIGRATE_TUNNELLED should be VIR_MIGRATE_TUNNELED */

TUNNELLED is not wrong:

http://www.thefreedictionary.com/tunnelled

It's an acceptable alternate spelling.

-- 
Chris Lalancette