[libvirt] [PATCH] spec: Only distribute ChangeLog in -devel package
Helps save space on the Fedora livecd, as requested here: https://bugzilla.redhat.com/show_bug.cgi?id=977099 --- libvirt.spec.in | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/libvirt.spec.in b/libvirt.spec.in index e94901a..a327eab 100644 --- a/libvirt.spec.in +++ b/libvirt.spec.in @@ -1739,7 +1739,6 @@ fi %files daemon %defattr(-, root, root) -%doc AUTHORS ChangeLog.gz NEWS README COPYING COPYING.LESSER TODO %dir %attr(0700, root, root) %{_sysconfdir}/libvirt/ %if %{with_network} @@ -2011,7 +2010,6 @@ fi %files client -f %{name}.lang %defattr(-, root, root) -%doc AUTHORS ChangeLog.gz NEWS README COPYING COPYING.LESSER TODO %config(noreplace) %{_sysconfdir}/libvirt/libvirt.conf %config(noreplace) %{_sysconfdir}/libvirt/virt-login-shell.conf @@ -2081,6 +2079,7 @@ fi %{_datadir}/libvirt/api/libvirt-qemu-api.xml %{_datadir}/libvirt/api/libvirt-lxc-api.xml +%doc AUTHORS ChangeLog.gz NEWS README COPYING COPYING.LESSER TODO %doc docs/*.html docs/html docs/*.gif %doc docs/libvirt-api.xml %doc examples/hellolibvirt -- 1.8.3.1
On 09/04/2013 08:24 AM, Cole Robinson wrote:
Helps save space on the Fedora livecd, as requested here:
https://bugzilla.redhat.com/show_bug.cgi?id=977099 --- libvirt.spec.in | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
ACK - makes more sense to have the files in only one rpm instead of two, and to have that rpm be one that is not part of a live image. -- Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
On Wed, Sep 04, 2013 at 10:24:06AM -0400, Cole Robinson wrote:
Helps save space on the Fedora livecd, as requested here:
https://bugzilla.redhat.com/show_bug.cgi?id=977099 --- libvirt.spec.in | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/libvirt.spec.in b/libvirt.spec.in index e94901a..a327eab 100644 --- a/libvirt.spec.in +++ b/libvirt.spec.in @@ -1739,7 +1739,6 @@ fi %files daemon %defattr(-, root, root)
-%doc AUTHORS ChangeLog.gz NEWS README COPYING COPYING.LESSER TODO %dir %attr(0700, root, root) %{_sysconfdir}/libvirt/
%if %{with_network} @@ -2011,7 +2010,6 @@ fi
%files client -f %{name}.lang %defattr(-, root, root) -%doc AUTHORS ChangeLog.gz NEWS README COPYING COPYING.LESSER TODO
%config(noreplace) %{_sysconfdir}/libvirt/libvirt.conf %config(noreplace) %{_sysconfdir}/libvirt/virt-login-shell.conf @@ -2081,6 +2079,7 @@ fi %{_datadir}/libvirt/api/libvirt-qemu-api.xml %{_datadir}/libvirt/api/libvirt-lxc-api.xml
+%doc AUTHORS ChangeLog.gz NEWS README COPYING COPYING.LESSER TODO %doc docs/*.html docs/html docs/*.gif %doc docs/libvirt-api.xml %doc examples/hellolibvirt
The subject says you're moving the ChangeLog file, but you're in fact moving all docs files. I don't think it is right to move the COPYING and COPYING.LESSER files - I think those should say in libvirt-client so that they're always present for any possible libvirt sub-RPM install. In fact I believe this is required by packaging guidelines https://fedoraproject.org/wiki/Packaging:LicensingGuidelines [quote] Subpackage Licensing If a subpackage is dependent (either implicitly or explicitly) upon a base package (where a base package is defined as a resulting binary package from the same source RPM which contains the appropriate license texts as %doc), it is not necessary for that subpackage to also include those license texts as %doc. However, if a subpackage is independent of any base package (it does not require it, either implicitly or explicitly), it must include copies of any license texts (as present in the source) which are applicable to the files contained within the subpackage. [/quote] Daniel -- |: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|
On 09/04/2013 08:53 AM, Daniel P. Berrange wrote:
On Wed, Sep 04, 2013 at 10:24:06AM -0400, Cole Robinson wrote:
Helps save space on the Fedora livecd, as requested here:
https://bugzilla.redhat.com/show_bug.cgi?id=977099 --- libvirt.spec.in | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
+%doc AUTHORS ChangeLog.gz NEWS README COPYING COPYING.LESSER TODO %doc docs/*.html docs/html docs/*.gif %doc docs/libvirt-api.xml %doc examples/hellolibvirt
The subject says you're moving the ChangeLog file, but you're in fact moving all docs files. I don't think it is right to move the COPYING and COPYING.LESSER files - I think those should say in libvirt-client so that they're always present for any possible libvirt sub-RPM install.
Oh, good point. That means: client: COPYING COPYING.LESSER daemon: none other[*]: AUTHORS ChangeLog.gz NEWS README TODO where I have yet another question: should the other package be libvirt-docs or libvirt-devel? Your patch put them in devel, but I think docs might be a better fit. Disregard my ACK, and let's get this right in a v2. -- Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
On Wed, Sep 04, 2013 at 09:02:58AM -0600, Eric Blake wrote:
On 09/04/2013 08:53 AM, Daniel P. Berrange wrote:
On Wed, Sep 04, 2013 at 10:24:06AM -0400, Cole Robinson wrote:
Helps save space on the Fedora livecd, as requested here:
https://bugzilla.redhat.com/show_bug.cgi?id=977099 --- libvirt.spec.in | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
+%doc AUTHORS ChangeLog.gz NEWS README COPYING COPYING.LESSER TODO %doc docs/*.html docs/html docs/*.gif %doc docs/libvirt-api.xml %doc examples/hellolibvirt
The subject says you're moving the ChangeLog file, but you're in fact moving all docs files. I don't think it is right to move the COPYING and COPYING.LESSER files - I think those should say in libvirt-client so that they're always present for any possible libvirt sub-RPM install.
Oh, good point.
That means:
client: COPYING COPYING.LESSER daemon: none other[*]: AUTHORS ChangeLog.gz NEWS README TODO
where I have yet another question: should the other package be libvirt-docs or libvirt-devel? Your patch put them in devel, but I think docs might be a better fit.
Oh, I didn't realize we had a -docs package. I just looked at -devel and saw the website docs and didn't look further. It seems we're duplicating website in both -docs and -devel which is bad. We should remove those website docs from -devel and have all docs related stuff in -docs Daniel -- |: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|
On 09/04/2013 09:11 AM, Daniel P. Berrange wrote:
client: COPYING COPYING.LESSER daemon: none other[*]: AUTHORS ChangeLog.gz NEWS README TODO
where I have yet another question: should the other package be libvirt-docs or libvirt-devel? Your patch put them in devel, but I think docs might be a better fit.
Oh, I didn't realize we had a -docs package. I just looked at -devel and saw the website docs and didn't look further. It seems we're duplicating website in both -docs and -devel which is bad. We should remove those website docs from -devel and have all docs related stuff in -docs
Duplication is indeed bad. But notice this guideline: https://fedoraproject.org/wiki/Packaging:Guidelines?rd=Packaging/Guidelines#... Any relevant documentation included in the source distribution should be included in the package as %doc. Irrelevant documentation include build instructions, the omnipresent INSTALL file containing generic build instructions, for example, and documentation for non-Linux systems, e.g. README.MSDOS. Pay also attention about which subpackage you include documentation in, for example API documentation belongs in the -devel subpackage, not the main one. Or if there's a lot of documentation, consider putting it into a subpackage. In this case, it is recommended to use *-doc as the subpackage name, and Documentation as the value of the Group tag. I'm wondering if the API docs should live in -devel, and all other files in -docs; or we could just have ALL docs live in -docs, as well as make -devel depend on -docs. -- Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
On 09/04/2013 11:18 AM, Eric Blake wrote:
On 09/04/2013 09:11 AM, Daniel P. Berrange wrote:
client: COPYING COPYING.LESSER daemon: none other[*]: AUTHORS ChangeLog.gz NEWS README TODO
where I have yet another question: should the other package be libvirt-docs or libvirt-devel? Your patch put them in devel, but I think docs might be a better fit.
Oh, I didn't realize we had a -docs package. I just looked at -devel and saw the website docs and didn't look further. It seems we're duplicating website in both -docs and -devel which is bad. We should remove those website docs from -devel and have all docs related stuff in -docs
Duplication is indeed bad. But notice this guideline:
https://fedoraproject.org/wiki/Packaging:Guidelines?rd=Packaging/Guidelines#...
Any relevant documentation included in the source distribution should be included in the package as %doc. Irrelevant documentation include build instructions, the omnipresent INSTALL file containing generic build instructions, for example, and documentation for non-Linux systems, e.g. README.MSDOS. Pay also attention about which subpackage you include documentation in, for example API documentation belongs in the -devel subpackage, not the main one. Or if there's a lot of documentation, consider putting it into a subpackage. In this case, it is recommended to use *-doc as the subpackage name, and Documentation as the value of the Group tag.
I'm wondering if the API docs should live in -devel, and all other files in -docs; or we could just have ALL docs live in -docs, as well as make -devel depend on -docs.
Currently all the API files are in -docs, with -devel having a dep on -docs, so I'll leave it that way. Upcoming patch uses danpb's suggesting of COPYING* in -client and everything else (AUTHORS, ChangeLog, etc). in -docs Thanks, Cole
participants (3)
-
Cole Robinson -
Daniel P. Berrange -
Eric Blake