Re: simple generation of the release news items (r18476 - htdocs/trunk/news - Fix unstable version warning)
Am Freitag, 11. Dezember 2009 schrieb Geert Janssens: BTW if you write a svn commit message and quote a bugzilla bug number, I recommend writing bug #1234, i.e. with the hash sign in front of the number. Our trac website is set up to turn those numbers (those with hash) into hyperlinks into bugzilla, just as r123 is turned into hyperlinks to the respective commit log page in trac. I copied the bug title directly from bugzilla and didn't pay attention to the # sign, sorry. No problem. I wanted to correct this with: $ svn propedit --revprop -r18488 svn:log But I am not allowed to do so: svn: Revprop change blocked by pre-revprop-change hook (exit code 1) with output: Sorry [gjanssens], you cannot change [svn:log] Yes, changing existing commit messages is not allowed. Even though this seems unconvenient, there are a whole bunch of good reasons why this is so. Really. Just to name a few: - The commit messages itself are not version controlled, so if you accidentally remove an important one, it is really gone; - Trac doesn't parse the svn log messages of the whole repository each time but instead keeps its own cache; you would have to trigger Trac to refresh its cache of the changed revision - Other version control systems like git consider the commit message as part of the actual commit, which means if you change the message, you change the whole commit, which blows up the whole idea of distributed versioning where I can rely on the fact that my copy of the SVN trunk history will stay the same except for newly added commits etc. etc. So yes indeed, we must live with suboptimal worded commit messages :-) Regards, Christian ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: simple generation of the release news items (r18476 - htdocs/trunk/news - Fix unstable version warning)
Dear Geert, Am Donnerstag, 10. Dezember 2009 schrieb Geert Janssens: We also have such a script - the makefile rules for the ChangeLog file in the top-level directory do exactly this: It downloads the svn log data from the hard-coded revision and formats it into some text file by the use of an xslt style sheet. I didn't know that. I have looked at the Changelog script. It is unfortunately of not much help for generating the news files. It outputs plain text, in a particular Changelog format. I played a bit with xslt myself and came up with a script that takes 2 parameters: $oldversion and $newversion. (eg 2.3.7 and 2.3.8). It will get all the commits that went into release $newversion since release $oldversion and outputs a simple html table with this info. This can then be copy/pasted into the newsfile for $newversion. thanks for the script - it could be committed in gnucash/util or similar once you've finished working on it. However, the release notes are *not* identical to svn log: There are plenty of commits which neither need to nor should appear in the release notes, such as fixed typo or added forgotten file. Also, we currently don't have any convention on the maximum size of the commit message (a fact which I currently abuse to copy'n'paste the full discussion into the commit log message, because it is the easiest way for me to look up this discussion later.) In other words: The release notes should clearly contain less text than svn log, but rather mention those distinct items from a user perspective which have changed. The commit message list of your script is a nice first step to get to such a list, but IMHO it will always need a manual extraction of the useful information. To sum up: The release note list should contain much much less text than the svn log. I haven't commited this script anywhere just yet. I'm just playing with ideas. I will attach the example output. It currently contains revision number, committer and logmessage. Would that be reasonable information to put in a newsmessage on the website, or do you prefer to keep it as a bulleted list as it is now ? I clearly prefer a bulleted list, at most with bug numbers where applicable, but no more additional information. BTW if you write a svn commit message and quote a bugzilla bug number, I recommend writing bug #1234, i.e. with the hash sign in front of the number. Our trac website is set up to turn those numbers (those with hash) into hyperlinks into bugzilla, just as r123 is turned into hyperlinks to the respective commit log page in trac. Regards, Christian ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: simple generation of the release news items (r18476 - htdocs/trunk/news - Fix unstable version warning)
On Friday 11 December 2009, Christian Stimming wrote: Dear Geert, Am Donnerstag, 10. Dezember 2009 schrieb Geert Janssens: We also have such a script - the makefile rules for the ChangeLog file in the top-level directory do exactly this: It downloads the svn log data from the hard-coded revision and formats it into some text file by the use of an xslt style sheet. I didn't know that. I have looked at the Changelog script. It is unfortunately of not much help for generating the news files. It outputs plain text, in a particular Changelog format. I played a bit with xslt myself and came up with a script that takes 2 parameters: $oldversion and $newversion. (eg 2.3.7 and 2.3.8). It will get all the commits that went into release $newversion since release $oldversion and outputs a simple html table with this info. This can then be copy/pasted into the newsfile for $newversion. thanks for the script - it could be committed in gnucash/util or similar once you've finished working on it. However, the release notes are *not* identical to svn log: There are plenty of commits which neither need to nor should appear in the release notes, such as fixed typo or added forgotten file. Also, we currently don't have any convention on the maximum size of the commit message (a fact which I currently abuse to copy'n'paste the full discussion into the commit log message, because it is the easiest way for me to look up this discussion later.) In other words: The release notes should clearly contain less text than svn log, but rather mention those distinct items from a user perspective which have changed. The commit message list of your script is a nice first step to get to such a list, but IMHO it will always need a manual extraction of the useful information. To sum up: The release note list should contain much much less text than the svn log. That's what I more or less expected as well. The full changelog is a good starting point to create the release notes though. So I will limit my scripting to output the log entries in a readily reusable format. The person creating the news page can then further reduce the output as he sees fit. I haven't commited this script anywhere just yet. I'm just playing with ideas. I will attach the example output. It currently contains revision number, committer and logmessage. Would that be reasonable information to put in a newsmessage on the website, or do you prefer to keep it as a bulleted list as it is now ? I clearly prefer a bulleted list, at most with bug numbers where applicable, but no more additional information. Ok for me. BTW if you write a svn commit message and quote a bugzilla bug number, I recommend writing bug #1234, i.e. with the hash sign in front of the number. Our trac website is set up to turn those numbers (those with hash) into hyperlinks into bugzilla, just as r123 is turned into hyperlinks to the respective commit log page in trac. I copied the bug title directly from bugzilla and didn't pay attention to the # sign, sorry. I wanted to correct this with: $ svn propedit --revprop -r18488 svn:log But I am not allowed to do so: svn: Revprop change blocked by pre-revprop-change hook (exit code 1) with output: Sorry [gjanssens], you cannot change [svn:log] Geert ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: r18476 - htdocs/trunk/news - Fix unstable version warning
Zitat von Geert Janssens janssens-ge...@telenet.be: A new template would be great. Even better would be working out a good process for updating the changed item section. For this, I looked at the revision log from http://svn.gnucash.org/trac/log/gnucash/trunk, but it cuts off the comments. You can check Show full log messages and click update. This gives you a view with full log messages, but the layout is slightly changed as well. Maybe this helps ? If not, I think I should be able to whip up a script that extracts the right information and massage it into the proper format. We also have such a script - the makefile rules for the ChangeLog file in the top-level directory do exactly this: It downloads the svn log data from the hard-coded revision and formats it into some text file by the use of an xslt style sheet. Regards, Christian ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: r18476 - htdocs/trunk/news - Fix unstable version warning
On Thursday 10 December 2009, Christian Stimming wrote: Zitat von Geert Janssens janssens-ge...@telenet.be: A new template would be great. Even better would be working out a good process for updating the changed item section. For this, I looked at the revision log from http://svn.gnucash.org/trac/log/gnucash/trunk, but it cuts off the comments. You can check Show full log messages and click update. This gives you a view with full log messages, but the layout is slightly changed as well. Maybe this helps ? If not, I think I should be able to whip up a script that extracts the right information and massage it into the proper format. We also have such a script - the makefile rules for the ChangeLog file in the top-level directory do exactly this: It downloads the svn log data from the hard-coded revision and formats it into some text file by the use of an xslt style sheet. Regards, Christian I didn't know that. I have looked at the Changelog script. It is unfortunately of not much help for generating the news files. It outputs plain text, in a particular Changelog format. I played a bit with xslt myself and came up with a script that takes 2 parameters: $oldversion and $newversion. (eg 2.3.7 and 2.3.8). It will get all the commits that went into release $newversion since release $oldversion and outputs a simple html table with this info. This can then be copy/pasted into the newsfile for $newversion. I have also considered automatically generating the news file, but I don't think that is really possible. There are parts of a news message that are setup by hand (like the major changes section). I haven't commited this script anywhere just yet. I'm just playing with ideas. I will attach the example output. It currently contains revision number, committer and logmessage. Would that be reasonable information to put in a newsmessage on the website, or do you prefer to keep it as a bulleted list as it is now ? Of course, if we go for a table format, I will add additional CSS to have a cleaner layout. Geert ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: r18476 - htdocs/trunk/news - Fix unstable version warning
Phil, I see you have pushed a new news item. You already found there is now a warning block in it. I had made some additional changes to the news pages, like adding links to the proper download locations and some general tidying to the titles. I see now that I didn't communicate these changes properly. Sorry about that. The result is that these changes are not picked up in your new news item. I propose to take the news item for 2.3.7 as a template for future (development) news pages. It would be nice if the 2.3.8 item had the other layout and content updates I did to the previous items. I can do that if you like, or you can do it yourself. I think apart for the version numbers, the only varying part of the news item is the Changes between 2.3.x and 2.3.y include section. Specifically for the version number, it's easiest to do a search and replace. There are some in the links at the bottom of the news item as well. Geert On Wednesday 9 December 2009, Phil Longstaff wrote: Author: plongstaff Date: 2009-12-09 13:09:25 -0500 (Wed, 09 Dec 2009) New Revision: 18476 Trac: http://svn.gnucash.org/trac/changeset/18476 Modified: htdocs/trunk/news/091208-2.3.8.news Log: Fix unstable version warning ___ gnucash-patches mailing list gnucash-patc...@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-patches ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: r18476 - htdocs/trunk/news - Fix unstable version warning
Also, when you update a release (stable or development), the new version number should be inserted in externals/global_params.php. This ensures that the front page and downloads page continue to list the latest versions. For an unstable release, only the downloads page is affected by this, for a stable release, both pages are affected. Geert On Wednesday 9 December 2009, Phil Longstaff wrote: Author: plongstaff Date: 2009-12-09 13:09:25 -0500 (Wed, 09 Dec 2009) New Revision: 18476 Trac: http://svn.gnucash.org/trac/changeset/18476 Modified: htdocs/trunk/news/091208-2.3.8.news Log: Fix unstable version warning ___ gnucash-patches mailing list gnucash-patc...@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-patches ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: r18476 - htdocs/trunk/news - Fix unstable version warning
I didn't 'svn update' until after I'd copied 2.3.7 to 2.3.8 as a template, so I didn't know about the new stuff. It wasn't until I had first committed the 2.3.8 news item and then went to see how it looked on gnucash.org that I noticed some of the new stuff. I copied the warning block, but nothing else. A new template would be great. Even better would be working out a good process for updating the changed item section. For this, I looked at the revision log from http://svn.gnucash.org/trac/log/gnucash/trunk, but it cuts off the comments. Phil From: Geert Janssens janssens-ge...@telenet.be To: gnucash-devel@gnucash.org Sent: Wed, December 9, 2009 1:35:42 PM Subject: Re: r18476 - htdocs/trunk/news - Fix unstable version warning Phil, I see you have pushed a new news item. You already found there is now a warning block in it. I had made some additional changes to the news pages, like adding links to the proper download locations and some general tidying to the titles. I see now that I didn't communicate these changes properly. Sorry about that. The result is that these changes are not picked up in your new news item. I propose to take the news item for 2.3.7 as a template for future (development) news pages. It would be nice if the 2.3.8 item had the other layout and content updates I did to the previous items. I can do that if you like, or you can do it yourself. I think apart for the version numbers, the only varying part of the news item is the Changes between 2.3.x and 2.3.y include section. Specifically for the version number, it's easiest to do a search and replace. There are some in the links at the bottom of the news item as well. Geert On Wednesday 9 December 2009, Phil Longstaff wrote: Author: plongstaff Date: 2009-12-09 13:09:25 -0500 (Wed, 09 Dec 2009) New Revision: 18476 Trac: http://svn.gnucash.org/trac/changeset/18476 Modified: htdocs/trunk/news/091208-2.3.8.news Log: Fix unstable version warning ___ gnucash-patches mailing list gnucash-patc...@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-patches ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: r18476 - htdocs/trunk/news - Fix unstable version warning
On Wednesday 9 December 2009, Phil Longstaff wrote: I didn't 'svn update' until after I'd copied 2.3.7 to 2.3.8 as a template, so I didn't know about the new stuff. It wasn't until I had first committed the 2.3.8 news item and then went to see how it looked on gnucash.org that I noticed some of the new stuff. I copied the warning block, but nothing else. A new template would be great. Even better would be working out a good process for updating the changed item section. For this, I looked at the revision log from http://svn.gnucash.org/trac/log/gnucash/trunk, but it cuts off the comments. What do you mean with it cuts off the comments ? Geert ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: r18476 - htdocs/trunk/news - Fix unstable version warning
On Wednesday 9 December 2009, Phil Longstaff wrote: On Wed, 2009-12-09 at 23:34 +0100, Geert Janssens wrote: On Wednesday 9 December 2009, Phil Longstaff wrote: I didn't 'svn update' until after I'd copied 2.3.7 to 2.3.8 as a template, so I didn't know about the new stuff. It wasn't until I had first committed the 2.3.8 news item and then went to see how it looked on gnucash.org that I noticed some of the new stuff. I copied the warning block, but nothing else. A new template would be great. Even better would be working out a good process for updating the changed item section. For this, I looked at the revision log from http://svn.gnucash.org/trac/log/gnucash/trunk, but it cuts off the comments. What do you mean with it cuts off the comments ? Here's the log message from the most recent commit: Small UI string corrections related to the recent tax enhancements. Patch … The ... is what I mean. Ok, now I see. It didn't cross my mind you were looking to a website in your browser. I was looking at svn log at the command line, which also uses a URL :) You can check Show full log messages and click update. This gives you a view with full log messages, but the layout is slightly changed as well. Maybe this helps ? If not, I think I should be able to whip up a script that extracts the right information and massage it into the proper format. Geert ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: r18476 - htdocs/trunk/news - Fix unstable version warning
On Wed, 2009-12-09 at 23:34 +0100, Geert Janssens wrote: On Wednesday 9 December 2009, Phil Longstaff wrote: I didn't 'svn update' until after I'd copied 2.3.7 to 2.3.8 as a template, so I didn't know about the new stuff. It wasn't until I had first committed the 2.3.8 news item and then went to see how it looked on gnucash.org that I noticed some of the new stuff. I copied the warning block, but nothing else. A new template would be great. Even better would be working out a good process for updating the changed item section. For this, I looked at the revision log from http://svn.gnucash.org/trac/log/gnucash/trunk, but it cuts off the comments. What do you mean with it cuts off the comments ? Here's the log message from the most recent commit: Small UI string corrections related to the recent tax enhancements. Patch … The ... is what I mean. Phil ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
