db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Rick Hillegas (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-4851) Parameterize documentation sources so that release-time variables (like copyright year and release id) can be plugged in when we build a release
Date Wed, 20 Oct 2010 13:45:25 GMT

    [ https://issues.apache.org/jira/browse/DERBY-4851?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12922960#action_12922960
] 

Rick Hillegas commented on DERBY-4851:
--------------------------------------

Thanks for that feedback, Kim. I agree with you on both points, as I said in my checkin comment:

1) The old timestamps were off by a couple weeks, which was goofy.

2) The new timestamps can be off by a couple months, which is goofier.

We could parameterize the whole timestamp or the beginning and ending parts of it, and then
compute the variables when we build the docs:

@TIMESTAMP_PREFIX@:07 EDT @COPYRIGHT_YEAR@

or

@TIMESTAMP@

It would be a small amount of extra work, which I didn't think was worth doing. Not to put
too fine a point on this: I don't think our users will really care. But I defer to your judgment.

> Parameterize documentation sources so that release-time variables (like copyright year
and release id) can be plugged in when we build a release
> ------------------------------------------------------------------------------------------------------------------------------------------------
>
>                 Key: DERBY-4851
>                 URL: https://issues.apache.org/jira/browse/DERBY-4851
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Rick Hillegas
>            Assignee: Rick Hillegas
>         Attachments: derby-4851-01-aa-copyrightYear.diff, derby-4851-02-aa-shortVersionNumber.diff,
derby-4851-03-aa-longReleaseID-and-subversionRevision.diff
>
>
> Right now there are a number of strings which have to be updated in the user guides every
time that we cut a branch or generate a release candidate. We should parameterize these strings
so that the build script can fill them in. Probably we will have to use the ant substitution
task for this because there is no obvious way to do this via DITA.
> These are the variables I am aware of. Please let me know if there are others:
> Latest copyright year (currently 2010)
> 2 part version number (e.g., 10.7) (this is plugged into the ij script output, among
other uses)
> 4 part version number (e.g. 10.7.1.0)
> subversion revision number (e.g. 1000400)

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message