You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Dyre Tjeldvoll (JIRA)" <de...@db.apache.org> on 2005/05/18 17:09:56 UTC
[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_65663 ]
Dyre Tjeldvoll commented on DERBY-220:
--------------------------------------
I've thought a bit about this, and I'm wondering about exactly which revision and timestamp you want:
a) Do you want the most recent revision for the repository, or the most recent revision in which something (in Derby) changed? The first one is already available as the changeversion property, and could easily be added to the javadoc footer.
(I guess that, ideally, one would want the revision in which something that affects the javadoc was changed. But I don't think that's feasible...)
b) About the timestamp; do you mean the the time when the javadoc command was run, or the time when the revision in a) was committed to the repository?
Consider the output from "svn info", standing in trunk:
dt136804@atum10~/local/d_rby-220$ svn info
Path: .
URL: https://svn.apache.org/repos/asf/incubator/derby/code/trunk
Repository UUID: 13f79535-47bb-0310-9956-ffa450edef68
Revision: 170751
--> This is the same as the "changedversion" property
Node Kind: directory
Schedule: normal
Last Changed Author: bandaram
Last Changed Rev: 170695
--> This is the last revision in which something in trunk changed
Last Changed Date: 2005-05-18 03:15:14 +0200 (Wed, 18 May 2005)
--> And this is the corresponding date
Properties Last Updated: 2005-05-13 16:10:24 +0200 (Fri, 13 May 2005)
------------------------
It is fairly simple to add the raw output from "svn info" to the javadoc footer, but this is probably overkill. It also clutters up the footer and takes up quite a bit of screen real-estate. It would be trivial to write a shell-script that filters the output, but this would not be portable. One could let a java program to do the filtering, but one would still be relying on the output from "svn info" being stable... I don't know if it is.
A different approach would be to include the Subversion keywords (LastChangedRevision and LastChangedDate or Id) in the javadoc description for each class. You would have to change every file (and remember to set the svn:keyword property), but this could be done by a script. The diff would be huge, though...
Does the reporter (or anyone else) have any comments on this?
> 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