Task #8835

Remove @version annotation from FLOW3 classes

Added by Bastian Waidelich over 10 years ago. Updated over 10 years ago.

Status:
Resolved
Priority:
Should have
Category:
-
Start date:
2010-07-13
Due date:
% Done:

100%

Estimated time:
Sprint:
PHP Version:
Has patch:
Complexity:

Description

Currently each PHP class contains the following line

 * @version $Id: $

That is replaced by SVN clients (if configured correctly) before comitting.
With the move to Git that won't be the case any longer, so we should get rid of these annotations.
AFAIK there is no corresponding feature in Git, but IMO we don't need the revision in the file or have any of you ever counted on the @version annotation? Besides, it makes backporting a very tedious job.

Note: If we decide to remove this annotation, we'll have to adjust the CGL document on http://flow3.typo3.org/documentation/coding-guidelines/ too


Related issues

Related to TYPO3.Flow - Task #9296: Replace $Revision$ keyword in Bootstrap.phpResolvedKarsten Dambekalns2010-08-13

Actions
#1

Updated by Manuel Strausz over 10 years ago

A related issue seems to be the $Revision keyword expansion, which is set in the Bootstrap:

    /**
     * FLOW3's Subversion revision
     */
    const REVISION = '$Revision: 4443 $';

I only saw this in use for the Configurations-Cache include (e.g. in 'Configurations/Production/ProductionConfigurations.php'), where it is used to make sure no obsolete cache is loaded when the framework revision changed, so this would have to be solved in a different way.

#2

Updated by Bastian Waidelich over 10 years ago

Manuel Strausz wrote:

A related issue seems to be the $Revision keyword expansion, which is set in the Bootstrap:

Good catch! We'll have to find a new mechanism for that.

#3

Updated by Karsten Dambekalns over 10 years ago

  • Status changed from New to Accepted
  • Assignee set to Karsten Dambekalns
  • Target version set to 1.0 alpha 11

Assigning this to me, as it needs to be done with the Git move anyway... :)

#4

Updated by Karsten Dambekalns over 10 years ago

Some helper, for the record:

find ./ -name '*.php' -exec perl -i.bak -ne 'print unless /\@version/' {} \;

#5

Updated by Karsten Dambekalns over 10 years ago

  • Status changed from Accepted to Resolved
  • % Done changed from 0 to 100

Applied in changeset r4969.

Also available in: Atom PDF