From Tommy.Reynolds at MegaCoder.com Thu Jun 4 22:08:23 2015 Content-Type: multipart/mixed; boundary="===============8208212014845464683==" MIME-Version: 1.0 From: Tommy Reynolds To: docs at lists.fedoraproject.org Subject: RFC: RPM Changelog thoughts Date: Mon, 31 Oct 2005 07:40:55 -0600 Message-ID: <20051031074055.9bf0fe90.Tommy.Reynolds@MegaCoder.com> --===============8208212014845464683== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable I'm looking at the RPM packaging steps that Paul has done. AIUI, he uses a small python script to pick the changelog information out of the document's XML. Cool idea. My question is this: should we build the RPM changelog from the XML content or from the CVS check-in log? Using the XML info is way cool, but we can get more file-specific information from the CVS log. I think developers, er, RPM users, would like the additional details. Opinions? Cheers --===============8208212014845464683== Content-Type: application/pgp-signature MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="attachment.sig" LS0tLS1CRUdJTiBQR1AgU0lHTkFUVVJFLS0tLS0KVmVyc2lvbjogR251UEcgdjEuNC4xIChHTlUv TGludXgpCgppRDhEQlFGRFpoN3IvMHlkcWtRRGxRRVJBaGcwQUo5U3lMeHBIYW1DL2FRdUVZVGpE UmJSNUpIcERnQ2RHelNvCkxyM25ZM3MxbVpPTGhUSnVvV3FxY0owPQo9WUdhZAotLS0tLUVORCBQ R1AgU0lHTkFUVVJFLS0tLS0K --===============8208212014845464683==-- From stickster at gmail.com Thu Jun 4 22:08:23 2015 Content-Type: multipart/mixed; boundary="===============7921202678354000774==" MIME-Version: 1.0 From: Paul W. Frields To: docs at lists.fedoraproject.org Subject: Re: RFC: RPM Changelog thoughts Date: Mon, 31 Oct 2005 12:23:54 -0500 Message-ID: <1130779434.5412.11.camel@localhost.localdomain> In-Reply-To: 20051031074055.9bf0fe90.Tommy.Reynolds@MegaCoder.com --===============7921202678354000774== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable On Mon, 2005-10-31 at 07:40 -0600, Tommy Reynolds wrote: > I'm looking at the RPM packaging steps that Paul has done. AIUI, he > uses a small python script to pick the changelog information out of > the document's XML. Cool idea. It is, if only I were indeed doing that! The only thing I do is a grab of the title information out of within the <book> or <article>. I am just learning Python baby steps, so even that was a stretch. Didn't want to take credit where it wasn't due. I had considered this, though, as an eventual goal for Python learning... if I could figure out enough SAX stuff to make this work, that would be a real coup as far as I'm concerned. I was under the impression that there were ways to even parse and read back entities, but I have no idea if that's a correct impression. > My question is this: should we build the RPM changelog from the XML > content or from the CVS check-in log? Using the XML info is way > cool, but we can get more file-specific information from the CVS log. > I think developers, er, RPM users, would like the additional details. > = > Opinions? I think the CVS log would be nice, but my understanding is that it's difficult to parse for this content. A couple difficulties that occurred to me were (1) tying the CVS login name to an email address, which is normally used in the spec file's %changelog; (2) mitigating the situation with the CVS changelog having entries that do not correspond to RPM package versions -- in other words, CVS gets revisions for which a new package is not rolled; and (3) tying the CVS revision number into a version number used for the RPM package. I don't know if any of these are showstoppers, but they are definitely gobsmackers, if you get my meaning. On the other hand, the DocBook XML <revisionhistory> at least has a "rational" version number and date which should roughly correspond with packaging. We still have the email address problem, however, and other problems likely exist with this way of doing it. *sigh* This is so much easier dealing with regular code like in Extras! -- = Paul W. Frields, RHCE http://paul.frields.org/ gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717 Fedora Documentation Project: http://fedora.redhat.com/projects/docs/ --===============7921202678354000774== Content-Type: application/pgp-signature MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="signature.asc" LS0tLS1CRUdJTiBQR1AgU0lHTkFUVVJFLS0tLS0KVmVyc2lvbjogR251UEcgdjEuNC4xIChHTlUv TGludXgpCgppRDhEQlFCRFpsTXFyTnZKTjcwUk54Y1JBa3VEQUo5VFVodE80Z0VVVGYxQnpmcFh5 VUZBbjJoQ3pBQ2c2bVVICjlHYTZhK0pEZGJOZ0ZhN0l4dWlwaEUwPQo9TzFUSgotLS0tLUVORCBQ R1AgU0lHTkFUVVJFLS0tLS0K --===============7921202678354000774==-- From Tommy.Reynolds at MegaCoder.com Thu Jun 4 22:08:24 2015 Content-Type: multipart/mixed; boundary="===============8966737506456843681==" MIME-Version: 1.0 From: Tommy Reynolds <Tommy.Reynolds at MegaCoder.com> To: docs at lists.fedoraproject.org Subject: Re: RFC: RPM Changelog thoughts Date: Mon, 31 Oct 2005 12:49:33 -0600 Message-ID: <20051031124933.a68c503e.Tommy.Reynolds@MegaCoder.com> In-Reply-To: 1130779434.5412.11.camel@localhost.localdomain --===============8966737506456843681== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Uttered "Paul W. Frields" <stickster(a)gmail.com>, spake thus: > I think the CVS log would be nice, but my understanding is that it's > difficult to parse for this content. I hacked together the attached shell script and ran it against the current "release-notes/" document. It gave this output: =3D=3D[release-notes/rpm-Changelog]=3D=3D * Mon Oct 31 2005 04:48 bbbush <fedora-docs-list(a)redhat.com> - RELEASE-NOTES-zh_CN.xml (1.1), daemons-zh_CN.xml (1.1), - desktop-zh_CN.xml (1.1), development-tools-zh_CN.xml (1.1), - entertainment-zh_CN.xml (1.1), feedback-zh_CN.xml (1.1), - file-servers-zh_CN.xml (1.1), hardware-reqs-zh_CN.xml (1.1), - i18n-zh_CN.xml (1.1), install-notes-zh_CN.xml (1.1), intro-zh_CN.xml - (1.1), java-package-zh_CN.xml (1.1), kernel-zh_CN.xml (1.1), - legacy-zh_CN.xml (1.1), misc-server-zh_CN.xml (1.1), - multimedia-zh_CN.xml (1.1), networking-zh_CN.xml (1.1), - overview-zh_CN.xml (1.1), package-movement-zh_CN.xml (1.1), - package-notes-zh_CN.xml (1.1), printing-zh_CN.xml (1.1), - project-overview-zh_CN.xml (1.1), samba-zh_CN.xml (1.1), - security-zh_CN.xml (1.1), server-tools-zh_CN.xml (1.1), - splash-zh_CN.xml (1.1), web-servers-zh_CN.xml (1.1), xorg-zh_CN.xml - (1.1): Simplified Chinese translations of relnotes of fc5test1, of - test and incomplete quality. Problems in package-notes-en.xml are - translated AS-IS because of the freeze. * Sat Oct 29 2005 21:36 Tommy Reynolds <Tommy.Reynolds(a)MegaCoder.com> - Makefile (1.5): If the document directory has a "figs/" subdirectory, - create an "figs/" subdirectory in the HTML output directory. Copy any - ordinary files with a dot in their names to the newly-created - "${DOCBASE}-${LANG}/figs/" subdirectory. To be copied, a graphics - file must: 1) Have an extention that is NOT ".eps", since HTML - doesn't grok EPS files. 2) Have a filename matching "*-${LANG}.*" -- - be a graphic for the selected language. 3) Have a filename that DOES - NOT HAVE A DASH at all -- this allows for "language-independent" - graphics. * Sat Oct 29 2005 08:26 tsekine <fedora-docs-list(a)redhat.com> - Makefile (1.4): fix the figs directory making rule so that 2 or more - lauguages are able to be specified in LANGUAGES variable * Tue Oct 25 2005 14:40 Karsten Wade <Karsten.Wade(a)RedHat.com> - package-movement-en.xml (1.4), package-notes-en.xml (1.4) (utags: - FC-5-TEST1-TRANS-FREEZE): Typos that broke the build, sorry, forgot - to test the build before I did my last commits. <snip> In addition to the attached shell script, I propose adding an "AUTHORS" file to each document. The example one I used above is: =3D=3D[release-notes/AUTHORS]=3D=3D ######################################################################## # We use this AUTHORS file to map CVS checkin names to real names and # email addresses. ######################################################################## # DEFAULT fedora-docs-list(a)redhat.com - jtr Tommy.Reynolds(a)MegaCoder.com Tommy Reynolds kwade Karsten.Wade(a)RedHat.com Karsten Wade Now that I look at the voluminous output, I'm less sure that we want the CVS log in the RPM. I think your current dummied-up %changelog is perhaps more useful. Cheers --===============8966737506456843681== Content-Type: application/octet-stream MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="rpm-changelog.obj" IyEvYmluL3NoCmN2czJjbCAtLXN0ZG91dCAtciAtdCAtYiAtLW5vLXdyYXAgIAkJCQkJfAphd2sJ JwpmdW5jdGlvbiB0cmltKCBzLAl2ICkJewoJdiA9IHMKCXN1YiggL15bIFx0XSovLCAiIiwgdiAp CglzdWIoIC9eWyBcdF0qJC8sICIiLCB2ICkKCXJldHVybiggdiApCn0KZnVuY3Rpb24gY2Fub25p Y2FsRGF0ZSggcywJY21kLCB2ICkJewoJY21kID0gc3ByaW50ZiggImRhdGUgLWQgJXMgXCIrJSVh ICUlYiAlJWQgJSVZXCIiLCBzICkKCWNtZCB8IGdldGxpbmUgcwoJY2xvc2UoIGNtZCApCglyZXR1 cm4oIHMgKQp9CmZ1bmN0aW9uIGlzRGF0ZUxpbmUoIHMgKQl7CglyZXR1cm4oIFwKCQlzIH4gL15b MC05XVswLTldWzAtOV1bMC05XVstXVswLTldWzAtOV1bLV1bMC05XVswLTldWyBcdF0qWzAtOV1b MC05XTpbMC05XVswLTldWyBcdF0qW14gXHRdKiQvIFwKCSkKfQpmdW5jdGlvbiBvdXRMaW5lKCkJ ewoJaWYoIGxpbmUgIT0gIiIgKQl7CgkJcHJpbnQgbGluZQoJfQoJbGluZSA9ICIiCglzZXAgPSAi LSAiCn0KQkVHSU4JewoJZGVmTG9naW4gPSAiREVGQVVMVCIKCWVtYWlsc1sgZGVmTG9naW4gXSA9 ICI8ZmVkb3JhLWRvY3MtbGlzdEByZWRoYXQuY29tPiIKCXJlYWxuYW1lc1sgZGVmTG9naW4gXSA9 ICJGSVhNRSIKCXdoaWxlKCBnZXRsaW5lIDwgIkFVVEhPUlMiID4gMCApCXsKCQlzdWIoIC8jLiok LywgJDAgKQoJCWlmKCBORiA+PSAzICkJewoJCQlsb2duYW1lID0gJDEKCQkJZW1haWwgPSAkMgoJ CQkkMSA9ICIiCgkJCSQyID0gIiIKCQkJZW1haWxzWyBsb2duYW1lIF0gPSAiPCIgZW1haWwgIj4i CgkJCXJlYWxuYW1lc1sgbG9nbmFtZSBdID0gdHJpbSggJDAgKQoJCX0KCX0KCW91dExpbmUoKQp9 CnsKCWRvCXsKCQlpZiggTkYgPT0gMyAmJiBpc0RhdGVMaW5lKCAkMCApICkJewoJCQlvdXRMaW5l KCkKCQkJZGF0ZSA9ICQxCgkJCXRvZCA9ICQyCgkJCWF1dGhvciA9ICQzCgkJCWlmKCBhdXRob3Ig aW4gZW1haWxzICkJewoJCQkJZW1haWwgPSBlbWFpbHNbIGF1dGhvciBdCgkJCQlyZWFsbmFtZSA9 IHJlYWxuYW1lc1sgYXV0aG9yIF0KCQkJfSBlbHNlCXsKCQkJCWVtYWlsID0gZW1haWxzWyBkZWZM b2dpbiBdCgkJCQlyZWFsbmFtZSA9IGF1dGhvcgoJCQl9CgkJCWlmKCBvdGhlcnMrKyApCXsKCQkJ CXByaW50ZiAiXG4iCgkJCX0KCQkJcHJpbnRmKCAiKiAlcyAlcyAlcyAlc1xuIiwgY2Fub25pY2Fs RGF0ZShkYXRlKSwgCgkJCQl0b2QsIHJlYWxuYW1lLCBlbWFpbCApCgkJCWdldGxpbmUJIyBFYXQg YmxhbmsgbGluZSBhZnRlciBkYXRlCgkJCWNvbnRpbnVlCgkJfQoJCW4gPSBzcGxpdCggJDAsIHRv a2VucywgL1sgXHRcbl0vICkKCQlmb3IoIGkgPSAxOyBpIDw9IG47ICsraSApCXsKCQkJdG9rZW4g PSB0b2tlbnNbaV0KCQkJaWYoIHRva2VuID09ICIiICkJewoJCQkJY29udGludWUKCQkJfQoJCQlp ZiggdG9rZW4gPT0gIioiICkJewoJCQkJY29udGludWUKCQkJfQoJCQluZXdMaW5lTGVuID0gbGVu Z3RoKHRva2VuKSArIGxlbmd0aChzZXApICsgXAoJCQkJbGVuZ3RoKCBsaW5lICkKCQkJaWYoIG5l d0xpbmVMZW4gPj0gNzIgKQl7CgkJCQlvdXRMaW5lKCkKCQkJfQoJCQlsaW5lID0gc3ByaW50Zigg IiVzJXMlcyIsIGxpbmUsIHNlcCwgdG9rZW4gKQoJCQlzZXAgPSAiICIKCQl9Cgl9IHdoaWxlKCBn ZXRsaW5lID4gMCApCn0KRU5ECXsKCW91dExpbmUoKQp9CicK --===============8966737506456843681== Content-Type: application/pgp-signature MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="attachment.sig" LS0tLS1CRUdJTiBQR1AgU0lHTkFUVVJFLS0tLS0KVmVyc2lvbjogR251UEcgdjEuNC4xIChHTlUv TGludXgpCgppRDhEQlFGRFptYzkvMHlkcWtRRGxRRVJBbk9VQUtDV3ZVbmRtK2VOVDJmYzAxcFRB dlJlTERVZklnQ2ZlZnZ2Ckg5QzAyK0pYTk5IUWphbjVkcjRRc2xnPQo9QzRvQQotLS0tLUVORCBQ R1AgU0lHTkFUVVJFLS0tLS0K --===============8966737506456843681==-- From stickster at gmail.com Thu Jun 4 22:08:24 2015 Content-Type: multipart/mixed; boundary="===============8090708612252069331==" MIME-Version: 1.0 From: Paul W. Frields <stickster at gmail.com> To: docs at lists.fedoraproject.org Subject: Re: RFC: RPM Changelog thoughts Date: Mon, 31 Oct 2005 14:04:30 -0500 Message-ID: <1130785470.3288.4.camel@localhost.localdomain> In-Reply-To: 20051031124933.a68c503e.Tommy.Reynolds@MegaCoder.com --===============8090708612252069331== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable On Mon, 2005-10-31 at 12:49 -0600, Tommy Reynolds wrote: > Uttered "Paul W. Frields" <stickster(a)gmail.com>, spake thus: > = > > I think the CVS log would be nice, but my understanding is that it's > > difficult to parse for this content. > = > I hacked together the attached shell script and ran it against the > current "release-notes/" document. It gave this output: > = [...snip...] > In addition to the attached shell script, I propose adding an > "AUTHORS" file to each document. The example one I used above is: > = > =3D=3D[release-notes/AUTHORS]=3D=3D > = > ######################################################################## > # We use this AUTHORS file to map CVS checkin names to real names and > # email addresses. > ######################################################################## > # DEFAULT fedora-docs-list(a)redhat.com - > jtr Tommy.Reynolds(a)MegaCoder.com Tommy Reynolds > kwade Karsten.Wade(a)RedHat.com Karsten Wade This is probably a good idea regardless of the route we choose for populating the %changelog, IMHO. > Now that I look at the voluminous output, I'm less sure that we want > the CVS log in the RPM. I think your current dummied-up %changelog > is perhaps more useful. I think James Laska had some input on the %changelog hacking, in that just setting a dummy was neither helpful nor advisable. (I'm kind of putting words in his mouth; he was less unkind, but in all honesty my solution didn't deserve a lot of kindness.) ;-) I think he suggested keeping a ChangeLog with the documents that would be used only for packaging. I am still mulling that over... -- = Paul W. Frields, RHCE http://paul.frields.org/ gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717 Fedora Documentation Project: http://fedora.redhat.com/projects/docs/ --===============8090708612252069331== Content-Type: application/pgp-signature MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="signature.asc" LS0tLS1CRUdJTiBQR1AgU0lHTkFUVVJFLS0tLS0KVmVyc2lvbjogR251UEcgdjEuNC4xIChHTlUv TGludXgpCgppRDhEQlFCRFptcStyTnZKTjcwUk54Y1JBckhKQUo0alNmWTljZlptbTlvOGUyTFQ5 SzhTMnB3MGF3Q2duRnN4CnlVZWxaV3BITTBSNVBITVMvbW5EbUJBPQo9Y3VYZQotLS0tLUVORCBQ R1AgU0lHTkFUVVJFLS0tLS0K --===============8090708612252069331==-- From sundaram at redhat.com Thu Jun 4 22:08:24 2015 Content-Type: multipart/mixed; boundary="===============2693225077095078000==" MIME-Version: 1.0 From: Rahul Sundaram <sundaram at redhat.com> To: docs at lists.fedoraproject.org Subject: Re: RFC: RPM Changelog thoughts Date: Tue, 01 Nov 2005 00:55:23 +0530 Message-ID: <43666FA3.9020203@redhat.com> In-Reply-To: 20051031124933.a68c503e.Tommy.Reynolds@MegaCoder.com --===============2693225077095078000== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Hi >Now that I look at the voluminous output, I'm less sure that we want >the CVS log in the RPM. I think your current dummied-up %changelog >is perhaps more useful. > = > I think dummying up the change log might be the wrong solution here. = Changelog should be split up from the RPM spec and stored seperately. = File a enhancement request? regards Rahul --===============2693225077095078000==-- From stickster at gmail.com Thu Jun 4 22:08:24 2015 Content-Type: multipart/mixed; boundary="===============4891149482837396486==" MIME-Version: 1.0 From: Paul W. Frields <stickster at gmail.com> To: docs at lists.fedoraproject.org Subject: Re: RFC: RPM Changelog thoughts Date: Tue, 01 Nov 2005 07:25:51 -0500 Message-ID: <1130847951.2973.3.camel@localhost.localdomain> In-Reply-To: 43666FA3.9020203@redhat.com --===============4891149482837396486== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable On Tue, 2005-11-01 at 00:55 +0530, Rahul Sundaram wrote: > Hi > = > >Now that I look at the voluminous output, I'm less sure that we want > >the CVS log in the RPM. I think your current dummied-up %changelog > >is perhaps more useful. > > = > > > I think dummying up the change log might be the wrong solution here. = > Changelog should be split up from the RPM spec and stored seperately. = > File a enhancement request? This is really a process change and not a bug, but as James has already made this suggestion on list, it's probably a good idea to discuss it here. Specifically, does doing this create any extra burdens on authors or editors, or should the ChangeLog file (to feed the RPM %changelog) simply include packaging-specific information? I would prefer the latter to avoid needless duplication of work. In other words, although the CVS log and/or revision history might have entries with info like this: - style changes - push to version x.y.z, move to final editorial ...the ChangeLog file would instead only include packaging specific entries or things which have nothing to do with the CVS content (much like code packages): - Update to x.y.z - Fix OMF file Comments? -- = Paul W. Frields, RHCE http://paul.frields.org/ gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717 Fedora Documentation Project: http://fedora.redhat.com/projects/docs/ --===============4891149482837396486== Content-Type: application/pgp-signature MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="signature.asc" LS0tLS1CRUdJTiBQR1AgU0lHTkFUVVJFLS0tLS0KVmVyc2lvbjogR251UEcgdjEuNC4xIChHTlUv TGludXgpCgppRDhEQlFCRFoxN09yTnZKTjcwUk54Y1JBbFdnQUo5Z2Y5YVlheTdLZ3ZqSk05aWlK b0RIclJDYjZRQ2dxdWZDCjBoeVg2YklGMG1Uejd0cDNMbTdmUnRvPQo9dEwyTAotLS0tLUVORCBQ R1AgU0lHTkFUVVJFLS0tLS0K --===============4891149482837396486==--