[Libguestfs] [PATCH 1/4] Sys::Guestfs::Lib: deprecate inspection functions

[Matthew Booth]

On 28/10/10 13:57, Richard W.M. Jones wrote:
> On Thu, Oct 28, 2010 at 01:53:35PM +0100, Matthew Booth wrote:
>> On 28/10/10 13:50, Richard W.M. Jones wrote:
>>> On Thu, Oct 28, 2010 at 01:29:14PM +0100, Matthew Booth wrote:
>>>> On 28/10/10 12:36, Richard W.M. Jones wrote:
>>>>>>  From b3394208522cd993788aa642e0082e6e5296fe02 Mon Sep 17 00:00:00 2001
>>>>> From: Richard W.M. Jones<rjones at redhat.com>
>>>>> Date: Wed, 27 Oct 2010 15:47:45 +0100
>>>>> Subject: [PATCH 1/4] Sys::Guestfs::Lib: deprecate inspection functions (RHBZ#642930).
>>>>>
>>>>> Deprecate the guest inspection functions in this module, remove
>>>>> documentation, and point users at the core API functions instead.
>>>>>
>>>>> However we will keep the code here since it is used by virt-v2v
>>>>> and virt-inspector.
>>>>> ---
>>>>>   perl/lib/Sys/Guestfs/Lib.pm |  419 +++----------------------------------------
>>>>>   1 files changed, 29 insertions(+), 390 deletions(-)
>>>>
>>>> I'm not convinced about this. By all means mark the functions as
>>>> deprecated, but I wouldn't remove the documentation until they're
>>>> actually removed.
>>>
>>> Trouble is, if we leave the documentation there people might use it ...
>>
>> Well, they'll be getting what they deserve when it goes away :) The
>> trouble with removing the documentation for functions which are
>> still in use is that it makes it harder to understand existing code.
>
> Maybe encourages people to rewrite the code :-)
>
> We have to keep the functions here because they're part of RHEL 6, and
> I'll probably import the old virt-inspector code into 6.1 so that it
> doesn't change dramatically.
>
> But could these functions (and documentation, if you like) be copied
> wholesale into virt-v2v?  They are essentially only used by virt-v2v
> now, and it's easier if this code is simply a part of virt-v2v.

I'll just remove them from virt-v2v rather than do this.

I'd mark them deprecated and leave them in place, with documentation, 
for at least a release cycle.

Matt
-- 
Matthew Booth, RHCA, RHCSS
Red Hat Engineering, Virtualisation Team

GPG ID:  D33C3490
GPG FPR: 3733 612D 2D05 5458 8A8A 1600 3441 EA19 D33C 3490