[MERGE] LockDir.lock_write() shouldn't require an email address

[John Arbash Meinel]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Richard Wilbur wrote:
> On Wed, 2006-10-04 at 11:11 +1000, Martin Pool wrote:
>> On 04/10/2006, at 00:39 , Richard Wilbur wrote:
>>
>>>> Because of inheritance, we don't need to do a deprecation phase,  
>>>> because
>>>> NoEmailInUsername is a child of BzrError.
>>>>
>>> John,
>>>
>>> I searched the bazaar-vcs.org site for "deprecation phase" and it
>>> returns with 0 pages/2344.  I searched for "deprecation" and it  
>>> returned
>>> five pages of which two mentioned bzr code.  BzrHistory under version
>>> 0.7 speaks of bzrlib.symbol_versioning being able to add is_deprecated
>>> flag to methods, change their doc strings, and cause them to issue
>>> DeprecationWarnings when called.
>>>
>>> Is this related to the "deprecation phase" you mention above  
>>> (albeit not
>>> needed in this case)?  Where could I read a description of this  
>>> practice
>>> ("deprecation phase")?
>> Hi Richard,
>>
>> Good question.
>>
>> Yes, "deprecation phase" just means "period when it's deprecated",  
>> nothing more.  Normally when we want to remove an interface we will  
>> make it deprecated for one or more release cycles, when using it will  
>> give a warning.  Then it's removed altogether.  John is saying it's  
>> not needed here.
>>
>> Cheers
> 
> Martin,
> 
> Thank you for the clarification.  Do you think "deprecation phase" is
> worthy of a BzrGlossary entry on the wiki?
> 
> <entry>
> <a href="/DeprecationPhase">deprecation phase</a> - Period during which
> an interface declared obsolete is being discouraged from use in the code
> by run time warnings.
> </entry>
> 
> <page>DeprecationPhase
> An interface that is deemed obsolete will . . .
> 1.  have its references in the code refactored to use other interfaces.
> 2.  generate warnings when used.
> 3.  be declared so on the development mailing list and in notes for one
> or two releases.
> 
> This time period is known as the "deprecation phase" for that interface,
> after which its implementation will be removed from the code.
> </page>
> 
> Sincerely,
> 
> Richard

I would change it slightly to read:

A public interface that is deemed obsolete will

...

2. Generate warnings when used. When possible, the warning will include
information about what should be done to avoid using this interface.
(Alternative interface, etc)

3. All public interfaces will be preserved for at least one full release
since they have been deprecated. Often they will be preserved for much
longer.

4. Disk formats will be supported for at least 6 months after they have
been deprecated.

Otherwise, go ahead and update the wiki.

John
=:->
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (Darwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFFJFUOJdeBCYSNAAMRAs7fAJ41kYcIgNQ3BABAqzzyAsDGb1qgSQCeJGZk
EScOyYpx38Wcm7tHANlPxn8=
=OAvf
-----END PGP SIGNATURE-----