[jira] Commented: (DERBY-220) Javadoc build should include a timestamp and/or the svn revision number in a visible location.

     [ 
http://issues.apache.org/jira/browse/DERBY-220?page=comments#action_65687 ]
     
Samuel Andrew McIntyre commented on DERBY-220:
----------------------------------------------

For the svn revision, it should be the svn revision of the view from which the 
javadoc was built. This represents most closely the state of the javadoc at the 
time it is built. The svn revision can be retrieved using the svnversion 
command. See the jar build for an example of how the changenumber property is 
set. In fact, you could probably just reuse the initjars target to set the 
changenumber.

For the timestamp, I suggest using Ant's internal timestamp properties. the 
<tstamp> task is called to set these properties in the init target. It's just a 
matter of using them.

So, all that might need to be done is to call the right init targets before the 
build, and add ${tstamp} and ${changenumber} to the footer text.

As for using the Subversion keywords in the java source files, I suppose it's 
probably most useful for determining who last changed the particular file, but 
I think for purposes of dating the build, putting the timestamp and revision in 
the footer achieves the same thing much less intrusively.

> Javadoc build should include a timestamp and/or the svn revision number in a 
> visible location.
> ----------------------------------------------------------------------------------------------
>
>          Key: DERBY-220
>          URL: http://issues.apache.org/jira/browse/DERBY-220
>      Project: Derby
>         Type: Improvement
>   Components: Build tools
>     Versions: 10.1.0.0
>     Reporter: Samuel Andrew McIntyre
>     Priority: Minor
>      Fix For: 10.1.0.0

>
> In order to easily identify when a specific set of javadoc was built, and 
> from what source, it would be useful to include a timestamp and/or the svn 
> revision number at the time the javadoc is built. The footer is an excellent 
> location to place this information, as it is visible on every generated page.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira