[libvirt] Improving our ChangeLog format?
Hi all, Noticed an entry in a recent LWN.net article about PostgreSQL's conversion to git. One of the things mentioned sounds relevant to us : Robert Haas has documented how to get commit summaries and sizes from Git. He wrote a perl script (which Tom Lane improved) that allows you to produce a changelog suitable for release notes from Git. http://git.postgresql.org/gitweb?p=postgresql.git;a=blob_plain;f=src/tools/g... The changelog mention might be useful for us, as the PostgreSQL changelog looks a bunch more useful than ours. The PostgreSQL ChangeLog: http://www.postgresql.org/docs/9.0/static/release-9-0.html Our ChangeLog: http://libvirt.org/news.html Mentioning this in case anyone has the time/inclination to look into it. Any takers? :) Regards and best wishes, Justin Clift
On Thu, Oct 14, 2010 at 08:55:24PM +1100, Justin Clift wrote:
Hi all,
Noticed an entry in a recent LWN.net article about PostgreSQL's conversion to git.
One of the things mentioned sounds relevant to us :
Robert Haas has documented how to get commit summaries and sizes from Git. He wrote a perl script (which Tom Lane improved) that allows you to produce a changelog suitable for release notes from Git.
http://git.postgresql.org/gitweb?p=postgresql.git;a=blob_plain;f=src/tools/g...
The changelog mention might be useful for us, as the PostgreSQL changelog looks a bunch more useful than ours.
The PostgreSQL ChangeLog: http://www.postgresql.org/docs/9.0/static/release-9-0.html
I don't believe that this corresponds to the output of the script you show above. This page is a hand-written change summary. That script above gives formatted commit logs. There's no enough structured info in commit messages to be able to generate a page like the one above.
Our ChangeLog: http://libvirt.org/news.html
Mentioning this in case anyone has the time/inclination to look into it. Any takers? :)
I don't disagree that our news file is somewhat unreadable. We can't automate this though - it needs manual work to create it. Regards, Daniel -- |: Red Hat, Engineering, London -o- http://people.redhat.com/berrange/ :| |: http://libvirt.org -o- http://virt-manager.org -o- http://deltacloud.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: GnuPG: 7D3B9505 -o- F3C9 553F A1DA 4AC2 5648 23C1 B3DF F742 7D3B 9505 :|
On 10/14/2010 09:09 PM, Daniel P. Berrange wrote: <snip>
The changelog mention might be useful for us, as the PostgreSQL changelog looks a bunch more useful than ours.
The PostgreSQL ChangeLog: http://www.postgresql.org/docs/9.0/static/release-9-0.html
I don't believe that this corresponds to the output of the script you show above. This page is a hand-written change summary. That script above gives formatted commit logs. There's no enough structured info in commit messages to be able to generate a page like the one above.
Aww rats. :(
2010/10/14 Daniel P. Berrange <berrange@redhat.com>:
On Thu, Oct 14, 2010 at 08:55:24PM +1100, Justin Clift wrote:
Hi all,
Noticed an entry in a recent LWN.net article about PostgreSQL's conversion to git.
One of the things mentioned sounds relevant to us :
Robert Haas has documented how to get commit summaries and sizes from Git. He wrote a perl script (which Tom Lane improved) that allows you to produce a changelog suitable for release notes from Git.
http://git.postgresql.org/gitweb?p=postgresql.git;a=blob_plain;f=src/tools/g...
The changelog mention might be useful for us, as the PostgreSQL changelog looks a bunch more useful than ours.
The PostgreSQL ChangeLog: http://www.postgresql.org/docs/9.0/static/release-9-0.html
I don't believe that this corresponds to the output of the script you show above. This page is a hand-written change summary. That script above gives formatted commit logs. There's no enough structured info in commit messages to be able to generate a page like the one above.
Our ChangeLog: http://libvirt.org/news.html
Mentioning this in case anyone has the time/inclination to look into it. Any takers? :)
I don't disagree that our news file is somewhat unreadable. We can't automate this though - it needs manual work to create it.
We could split the huge comma seperated lists of items per <li> into a second level of <li>'s to avoid this large blocks of text. Matthias
On Thu, Oct 14, 2010 at 01:06:56PM +0200, Matthias Bolte wrote:
2010/10/14 Daniel P. Berrange <berrange@redhat.com>:
On Thu, Oct 14, 2010 at 08:55:24PM +1100, Justin Clift wrote:
The PostgreSQL ChangeLog: http://www.postgresql.org/docs/9.0/static/release-9-0.html
I don't believe that this corresponds to the output of the script you show above. This page is a hand-written change summary. That script above gives formatted commit logs. There's no enough structured info in commit messages to be able to generate a page like the one above.
Our ChangeLog: http://libvirt.org/news.html
Mentioning this in case anyone has the time/inclination to look into it. Any takers? :)
I don't disagree that our news file is somewhat unreadable. We can't automate this though - it needs manual work to create it.
We could split the huge comma seperated lists of items per <li> into a second level of <li>'s to avoid this large blocks of text.
This would run into incredibly long logs per release ! I was doing that in the very first releases see (bottom of news.html) I could change that to something more linear. Maybe adding a <br /> at the end of each line would be sufficient though, and may take sligtly less place than a sub list. I don't really care either way, it would be easy to fix, Daniel -- Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/ daniel@veillard.com | Rpmfind RPM search engine http://rpmfind.net/ http://veillard.com/ | virtualization library http://libvirt.org/
On 10/14/2010 11:40 PM, Daniel Veillard wrote: <snip>
This would run into incredibly long logs per release ! I was doing that in the very first releases see (bottom of news.html) I could change that to something more linear. Maybe adding a<br /> at the end of each line would be sufficient though, and may take sligtly less place than a sub list. I don't really care either way, it would be easy to fix,
Is it something you can try out, and throw onto a page somewhere so we can look at it, comment on it here, etc? Seems like we'd really need to "see it" before deciding. :)
On Thu, Oct 14, 2010 at 11:50:50PM +1100, Justin Clift wrote:
On 10/14/2010 11:40 PM, Daniel Veillard wrote: <snip>
This would run into incredibly long logs per release ! I was doing that in the very first releases see (bottom of news.html) I could change that to something more linear. Maybe adding a<br /> at the end of each line would be sufficient though, and may take sligtly less place than a sub list. I don't really care either way, it would be easy to fix,
Is it something you can try out, and throw onto a page somewhere so we can look at it, comment on it here, etc?
Seems like we'd really need to "see it" before deciding. :)
http://libvirt.org/news.test.html to get an idea, I didn't tried to clean everything up though Daniel -- Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/ daniel@veillard.com | Rpmfind RPM search engine http://rpmfind.net/ http://veillard.com/ | virtualization library http://libvirt.org/
On 10/15/2010 12:22 AM, Daniel Veillard wrote: <snip>
Seems like we'd really need to "see it" before deciding. :)
http://libvirt.org/news.test.html
to get an idea, I didn't tried to clean everything up though
Cool. That's going in the right direction. Can we add in a unique sort (sort -u), so it groups them by topic? ie: bridge: Fix static-only DHCP configuration (Jiri Denemark), build: Fix permissions of sysconfig files (Jiri Denemark), esx: Fix esxVI_BuildSelectSet's invalid argument check (Matthias Bolte), qemu: qemuMonitorJSONEjectMedia(): Fix arguments' type (Luiz Capitulino), qemu: qemuMonitorJSONMigrate(): Fix arguments' type (Luiz Capitulino), qemu: Check for errors when converting PCI address to string (Jiri Denemark), qemu: Fix JSON migrate_set_downtime command (Jiri Denemark), phyp: Bad comparison when checking for existing domain name (Eduardo Otubo), spec: Fix undefined with_libnl (Jiri Denemark), test: Don't overwrite storage volume target path and key (Matthias Bolte), virsh: remove driver check from attach-disk command (Ryan Harper), Preferably then turning the first word subject starter (bridge, build, esx, qemu, etc) into a heading. Something with visual separation like: BRIDGE Fix static-only DHCP configuration (Jiri Denemark) BUILD Fix permissions of sysconfig files (Jiri Denemark) ESX Fix esxVI_BuildSelectSet's invalid argument check (Matthias Bolte) QEMU qemuMonitorJSONEjectMedia(): Fix arguments' type (Luiz Capitulino) qemuMonitorJSONMigrate(): Fix arguments' type (Luiz Capitulino) Check for errors when converting PCI address to string (Jiri Denemark) Fix JSON migrate_set_downtime command (Jiri Denemark) PHYP Bad comparison when checking for existing domain name (Eduardo Otubo) SPEC Fix undefined with_libnl (Jiri Denemark) TEST Don't overwrite storage volume target path and key (Matthias Bolte) VIRSH remove driver check from attach-disk command (Ryan Harper) The above is obviously a text representation. For HTML, maybe use <h4>HEADING</h4> tags or something?
participants (4)
-
Daniel P. Berrange -
Daniel Veillard -
Justin Clift -
Matthias Bolte