DO NOT REPLY [Bug 29462] New: - Add "what" information to source files

[bu...@apache.org]

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=29462>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=29462

Add "what" information to source files

           Summary: Add "what" information to source files
           Product: Cocoon 2
           Version: Current CVS 2.1
          Platform: Other
        OS/Version: Other
            Status: NEW
          Severity: Normal
          Priority: Other
         Component: core
        AssignedTo: dev@cocoon.apache.org
        ReportedBy: bdelacretaz@codeconsult.ch


This was discussed in
http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=108667813326352&w=2

The idea is to add "what" ID strings to source files, containing the Subversion
URL that allows one to retrieve the appropriate version of the source file, for
example:

public static final String 
  WHAT_ID = "@(#) SomeFile.java http://subversion-url-here";

Then, the "what" command (http://www.hmug.org/man/1/what.html) can be used to
extract this info from source files, or from jar files:

  unzip -p somejar.jar | what

will print the WHAT_IDs contained in the jar.

This will allow users to know exactly which versions of source files have been
used to build jars that they're using (assuming the files have been committed to
SVN before compiling).

A script or ant task will be needed to make sure all source files contain this info.