Re: [libvirt] [PATCH] spec: Only pull in API docs with -devel package
On Wed, 2016-04-13 at 10:54 -0400, Cole Robinson wrote:
Move some API specific documentation out of -docs package and into
-devel, and some end user docs out of -devel and into -docs, then
drop the -devel dep on -docs. This is more in line with the suggested
Fedora guidelines.
https://bugzilla.redhat.com/show_bug.cgi?id=1310155
---
libvirt.spec.in | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
diff --git a/libvirt.spec.in b/libvirt.spec.in
index 8036fa3..500cde9 100644
--- a/libvirt.spec.in
+++ b/libvirt.spec.in
@@ -1197,7 +1197,6 @@ namespaces.
Summary: Libraries, includes, etc. to compile with the libvirt library
Group: Development/Libraries
Requires: %{name}-client = %{version}-%{release}
-Requires: %{name}-docs = %{version}-%{release}
This looks good...
Requires: pkgconfig
%description devel
@@ -1949,14 +1948,10 @@ exit 0
%files docs
%defattr(-, root, root)
-%doc AUTHORS ChangeLog.gz NEWS README TODO libvirt-docs/*
+%doc AUTHORS ChangeLog.gz NEWS README TODO
+%doc libvirt-docs/*
+%doc docs/*.html docs/html docs/*.gif
... this too...
-# API docs
-%dir %{_datadir}/gtk-doc/html/libvirt/
-%doc %{_datadir}/gtk-doc/html/libvirt/*.devhelp
-%doc %{_datadir}/gtk-doc/html/libvirt/*.html
-%doc %{_datadir}/gtk-doc/html/libvirt/*.png
-%doc %{_datadir}/gtk-doc/html/libvirt/*.css
... not convinced about this one.
The Fedora policy is kinda vague here, possibly on purpose
to allow for some leeway:
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.
Since we already have a -doc subpackage, it would make more
sense to me to put all the documentation, including the API
reference, in there and keep the -devel subpackage as lean as
possible.
My rationale being: you might end up installing -devel because
you want to compile some software that uses libvirt, in which
case you're not interested in either the documentation or the
API reference; on the other hand, if you're developing an
application based on libvirt yourself, you probably want to
have both.
Cheers.
--
Andrea Bolognani
Software Engineer - Virtualization Team