[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: Suggestion: linkify revnums and issues in the CHANGES file

From: Branko ─îibej <brane_at_apache.org>
Date: Thu, 13 Sep 2018 12:00:39 +0200

On 13.09.2018 11:18, Johan Corveleyn wrote:
> On Thu, Sep 13, 2018 at 11:01 AM Julian Foad <julianfoad_at_apache.org> wrote:
>> It seems to me rather poor that readers of our CHANGES file have to manually follow references to revision numbers and issue numbers. Examples:
>> [[[
>> - Server-side bugfixes:
>> * svnadmin dump shouldn't canonicalize svn:date (issue #4767)
>> * 'svnadmin verify --keep-going --quiet' shows an error summary (r1837790)
>> ]]]
>> I have shortcuts defined in my browser for going to a revision or an issue by number, but must users don't, so I feel it is pretty unfriendly to them.
>> As the file format is pretty regular, would anyone care to contemplate post-processing it into HTML with the revision numbers and issue numbers as hyperlinks?
>> I would suggest keeping the current file format as the original and posting the processed version somewhere. A static link in the original (text file) could point to the canonical URL of the HTML version. Just a trunk version would be sufficient initially, updated at least at every release and preferably more often.
> I suggest to create a wiki variant (with hyperlinks) on our Confluence
> wiki, rather than just a HTML-ized version. That should be doable to
> automate, to go over the plain text version and replace #4767 into
> [#4767|https://.../SVN-4767] etc.
> (sorry, I'm not volunteering right now, it's just a suggestion -- I
> might find some time in a couple of weeks, but not immediately ... so
> if anyone else feels inclined ...)

Given all the debate we've had about how to edit and merge the CHANGES
file on trunk and release branches ... how about only having the change
log in the wiki, with CHANGES containing only a pointer to the wiki page?

-- Brane
Received on 2018-09-13 12:00:49 CEST

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.