Bug 954354 - Review Request: zimlib - Library for reading/writing ZIM files
Summary: Review Request: zimlib - Library for reading/writing ZIM files
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Volker Fröhlich
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-04-22 11:10 UTC by Micah Roth
Modified: 2013-06-09 03:29 UTC (History)
3 users (show)

Fixed In Version: zimlib-1.0-5.fc19
Clone Of:
Environment:
Last Closed: 2013-06-09 02:25:50 UTC
Type: ---
Embargoed:
volker27: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)

Description Micah Roth 2013-04-22 11:10:05 UTC
Spec URL: http://multiseatlibrary.distract.org/files/zimlib.spec
SRPM URL: http://multiseatlibrary.distract.org/files/zimlib-1.0-2.fc18.src.rpm
Description: The zimlib is the standard implementation of the ZIM specification. It is a
library which implements the read and write method for ZIM files. Use zimlib in
your own software - like reader applications - to make them ZIM-capable without
the need having to dig too much into the ZIM file format. zimlib is written in
C++.
Fedora Account System Username: ndroftheline

This is a dependency of another package I am working with volter on called Kiwix, an offline wikipedia reader and server.

Comment 1 Volker Fröhlich 2013-04-22 15:29:34 UTC
%{_libdir}/libzim.a -- Don't ship that or don't even build it (--disable-static).

Comment 2 Volker Fröhlich 2013-04-22 15:30:21 UTC
The description of the devel package is wrong:

"It also includes the binaries zimsearch and zimdump, for directly searching and viewing ZIM file contents."

Comment 3 Micah Roth 2013-04-22 18:33:59 UTC
> %{_libdir}/libzim.a -- Don't ship that or don't even build it (--disable-static).

Fixed.

> The description of the devel package is wrong:

Fixed. 

New URLS:
Spec URL: http://multiseatlibrary.distract.org/files/zimlib.spec
SRPM URL: http://multiseatlibrary.distract.org/files/zimlib-1.0-3.fc18.src.rpm

Comment 4 Volker Fröhlich 2013-04-23 22:06:05 UTC
There's only one blocker. See the review below for details.

Some minor and cosmetic stuff:

Don't ship INSTALL, as it only contains generic installation instructions, as of http://fedoraproject.org/wiki/Packaging:Guidelines#Documentation. README seems to be about something completely unrelated. Changelog and NEWS are empty. I usually don't ship empty files.

I'd also recommend to make it "%{_includedir}/zim/" in the files section, as that's more specific. Notice, there's no trailing asterisk!

For the sake of simplicity, remove the empty %doc instruction from the devel files section and remove the commented out BRs and Requires.

It's common to leave one line empty between the different changelog entry blocks.


Package Review
==============

Key:
[x] = Pass
[!] = Fail
[-] = Not applicable
[?] = Not evaluated
[ ] = Manual review needed

===== MUST items =====

C/C++:
[x]: Package does not contain kernel modules.
[x]: Package contains no static executables.
[x]: Header files in -devel subpackage, if present.
[x]: ldconfig called in %post and %postun if required.
[x]: Package does not contain any libtool archives (.la)
[x]: Rpath absent or only used for internal libs.
[x]: Development (unversioned) .so files in -devel subpackage, if present.

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: %build honors applicable compiler flags or justifies otherwise.
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[x]: Development files must be in a -devel package
[-]: Package requires other packages for directories it uses.
[x]: Package uses nothing in %doc for runtime.
[x]: Package is not known to require ExcludeArch.

Builds on PPC and ARM

[x]: Package complies to the Packaging Guidelines
[!]: If (and only if) the source package includes the text of the license(s)
     in its own file, then that file, containing the text of the license(s)
     for the package is included in %doc.

Add COPYING to the %doc section of the main package!

[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses found:
     "LGPL (v2.1 or later)", "GPL (v2 or later)", "LGPL (v2 or later) (with
     incorrect FSF address)", "Unknown or generated". 4 files have unknown
     license. Detailed output of licensecheck in
     /home/makerpm/954354-zimlib/licensecheck.txt
[!]: License file installed when any subpackage combination is installed.

See above!

[x]: Package consistently uses macro is (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Package must own all directories that it creates.
[x]: Package does not own files or directories owned by other packages.
[-]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[x]: Useful -debuginfo package or justification otherwise.
[-]: Large documentation must go in a -doc subpackage.
     Note: Documentation size is 30720 bytes in 5 files.
[x]: All build dependencies are listed in BuildRequires, except for any that
     are listed in the exceptions section of Packaging Guidelines.
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Each %files section contains %defattr if rpm < 4.4
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Fully versioned dependency in subpackages, if present.
[x]: Spec file lacks Packager, Vendor, PreReq tags.
[-]: Package use %makeinstall only when make install' ' DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package do not use a name that already exist
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as provided
     in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local
[x]: Package successfully compiles and builds into binary rpms on at least one
     supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).

===== SHOULD items =====

Generic:
[-]: If the source package does not include license text(s) as a separate file
     from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: Scriptlets must be sane, if used.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[-]: %check is present and all tests pass.

Upstream clarified, that the tests for this library are not ready to use.

[!]: Packages should try to preserve timestamps of original installed files.
[x]: Sources can be downloaded from URI in Source: tag
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: Dist tag is present.
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Uses parallel make.
[x]: SourceX tarball generation or download is documented.
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define.

===== EXTRA items =====

Generic:
[x]: Large data in /usr/share should live in a noarch subpackage if package is
     arched.
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: zimlib-1.0-3.fc20.x86_64.rpm
          zimlib-devel-1.0-3.fc20.x86_64.rpm
zimlib.x86_64: E: changelog-time-in-future 2013-04-23
zimlib.x86_64: E: zero-length /usr/share/doc/zimlib-1.0/NEWS
zimlib.x86_64: E: zero-length /usr/share/doc/zimlib-1.0/ChangeLog
zimlib.x86_64: W: no-manual-page-for-binary zimdump
zimlib.x86_64: W: no-manual-page-for-binary zimsearch
zimlib.x86_64: W: install-file-in-docs /usr/share/doc/zimlib-1.0/INSTALL
zimlib-devel.x86_64: E: changelog-time-in-future 2013-04-23
zimlib-devel.x86_64: W: no-documentation
2 packages and 0 specfiles checked; 4 errors, 4 warnings.




Rpmlint (installed packages)
----------------------------
# rpmlint zimlib-devel zimlib
zimlib-devel.x86_64: E: changelog-time-in-future 2013-04-23
zimlib-devel.x86_64: W: no-documentation
zimlib.x86_64: E: changelog-time-in-future 2013-04-23
zimlib.x86_64: E: zero-length /usr/share/doc/zimlib-1.0/NEWS
zimlib.x86_64: E: zero-length /usr/share/doc/zimlib-1.0/ChangeLog
zimlib.x86_64: W: no-manual-page-for-binary zimdump
zimlib.x86_64: W: no-manual-page-for-binary zimsearch
zimlib.x86_64: W: install-file-in-docs /usr/share/doc/zimlib-1.0/INSTALL
2 packages and 0 specfiles checked; 4 errors, 4 warnings.
# echo 'rpmlint-done:'



Requires
--------
zimlib-devel (rpmlib, GLIBC filtered):
    libzim.so.0()(64bit)
    zimlib(x86-64)

zimlib (rpmlib, GLIBC filtered):
    /sbin/ldconfig
    libc.so.6()(64bit)
    libgcc_s.so.1()(64bit)
    libgcc_s.so.1(GCC_3.0)(64bit)
    liblzma.so.5()(64bit)
    liblzma.so.5(XZ_5.0)(64bit)
    libm.so.6()(64bit)
    libpthread.so.0()(64bit)
    libstdc++.so.6()(64bit)
    libstdc++.so.6(CXXABI_1.3)(64bit)
    libzim.so.0()(64bit)
    rtld(GNU_HASH)



Provides
--------
zimlib-devel:
    zimlib-devel
    zimlib-devel(x86-64)

zimlib:
    libzim.so.0()(64bit)
    zimlib
    zimlib(x86-64)



MD5-sum check
-------------
http://www.openzim.org/download/zimlib-1.0.tar.gz :
  CHECKSUM(SHA256) this package     : 2213179f0a2c730bc0571cfde4a88e4570b63e5b548a09cceb8468286755d11b
  CHECKSUM(SHA256) upstream package : 2213179f0a2c730bc0571cfde4a88e4570b63e5b548a09cceb8468286755d11b


Generated by fedora-review 0.4.0 (660ce56) last change: 2013-01-29
Buildroot used: fedora-rawhide-x86_64
Command line :/usr/bin/fedora-review -b 954354

Comment 6 Micah Roth 2013-04-24 19:02:24 UTC
> Don't ship INSTALL, as it only contains generic installation instructions,
> as of http://fedoraproject.org/wiki/Packaging:Guidelines#Documentation.
> README seems to be about something completely unrelated. Changelog and NEWS
> are empty. I usually don't ship empty files.

Fixed. Heh, I did notice that the README was in another language, but I couldn't tell it was about something different by the same author until I looked it up. For future reference, is it good practice to include docs shipped in the source that are in another language? For example, if this file was actually applicable to the package but it was in Russian, would I want to include it in the package? Would I need to figure out the lang code and mark it as README.ru or whatever code was appropriate?

> I'd also recommend to make it "%{_includedir}/zim/" in the files section, as
> that's more specific. Notice, there's no trailing asterisk!

Fixed. What is the danger of using the asterisk?

> For the sake of simplicity, remove the empty %doc instruction from the devel
> files section and remove the commented out BRs and Requires.

Fixed.

> It's common to leave one line empty between the different changelog entry
> blocks.

Fixed. By the way, am I being too explicit in my comments or does that matter?

> [x]: Package is not known to require ExcludeArch.
> 
> Builds on PPC and ARM

Out of curiosity, how did you check this? Does Koji have this ability?

> [!]: If (and only if) the source package includes the text of the license(s)
>      in its own file, then that file, containing the text of the license(s)
>      for the package is included in %doc.
> 
> Add COPYING to the %doc section of the main package!

Fixed.

> [!]: License file installed when any subpackage combination is installed.
> 
> See above!

See above (;

> [!]: Packages should try to preserve timestamps of original installed files.

How can I fix this?

> zimlib-devel.x86_64: E: changelog-time-in-future 2013-04-23

Timezone change ftw

Comment 7 Micah Roth 2013-04-24 19:05:49 UTC
> Don't ship INSTALL, as it only contains generic installation instructions,
> as of http://fedoraproject.org/wiki/Packaging:Guidelines#Documentation.
> README seems to be about something completely unrelated. Changelog and NEWS
> are empty. I usually don't ship empty files.

Fixed. Heh, I did notice that the README was in another language, but I couldn't tell it was about something different by the same author until I looked it up. For future reference, is it good practice to include docs shipped in the source that are in another language? For example, if this file was actually applicable to the package but it was in Russian, would I want to include it in the package? Would I need to figure out the lang code and mark it as README.ru or whatever code was appropriate?

> I'd also recommend to make it "%{_includedir}/zim/" in the files section, as
> that's more specific. Notice, there's no trailing asterisk!

Fixed. What is the danger of using the asterisk?

> For the sake of simplicity, remove the empty %doc instruction from the devel
> files section and remove the commented out BRs and Requires.

Fixed.

> It's common to leave one line empty between the different changelog entry
> blocks.

Fixed. By the way, am I being too explicit in my comments or does that matter?

> [x]: Package is not known to require ExcludeArch.
> 
> Builds on PPC and ARM

Out of curiosity, how did you check this? Does Koji have this ability?

> [!]: If (and only if) the source package includes the text of the license(s)
>      in its own file, then that file, containing the text of the license(s)
>      for the package is included in %doc.
> 
> Add COPYING to the %doc section of the main package!

Fixed.

> [!]: License file installed when any subpackage combination is installed.
> 
> See above!

See above (;

> [!]: Packages should try to preserve timestamps of original installed files.

How can I fix this?

> zimlib-devel.x86_64: E: changelog-time-in-future 2013-04-23

Timezone change ftw 


New URLS:
Spec URL: http://multiseatlibrary.distract.org/files/zimlib.spec
SRPM URL: http://multiseatlibrary.distract.org/files/zimlib-1.0-4.fc18.src.rpm

Comment 8 Volker Fröhlich 2013-04-24 20:47:09 UTC
(In reply to comment #7)
> I did notice that the README was in another language, but I
> couldn't tell it was about something different by the same author until I
> looked it up. For future reference, is it good practice to include docs
> shipped in the source that are in another language? For example, if this
> file was actually applicable to the package but it was in Russian, would I
> want to include it in the package? Would I need to figure out the lang code
> and mark it as README.ru or whatever code was appropriate?

I think there are no strict rules for such cases. Your suggestions sound good to me. If documentation consumed a lot of space, you could create a custom sub-package per language or so.
 
> > I'd also recommend to make it "%{_includedir}/zim/" in the files section, as
> > that's more specific. Notice, there's no trailing asterisk!
> 
> Fixed. What is the danger of using the asterisk?

You wouldn't own the directory then.

> 
> > It's common to leave one line empty between the different changelog entry
> > blocks.
> 
> Fixed. By the way, am I being too explicit in my comments or does that
> matter?
>

I hadn't mentioned non-functional changes, like format changes or comments.

> > [x]: Package is not known to require ExcludeArch.
> > 
> > Builds on PPC and ARM
> 
> Out of curiosity, how did you check this? Does Koji have this ability?

I used ppc-koji and arm-koji to create scratch builds.

> > [!]: Packages should try to preserve timestamps of original installed files.
> 
> How can I fix this?

You can try like Tom did here: https://bugzilla.redhat.com/show_bug.cgi?id=950172#c2

Please also tell upstream.

Comment 9 Volker Fröhlich 2013-04-24 20:51:38 UTC
No blockers, package approved!

Comment 10 Micah Roth 2013-04-25 16:56:45 UTC
> You can try like Tom did here:
> https://bugzilla.redhat.com/show_bug.cgi?id=950172#c2
> 
> Please also tell upstream.

Done. 

New URLS:
Spec URL: http://multiseatlibrary.distract.org/files/zimlib.spec
SRPM URL: http://multiseatlibrary.distract.org/files/zimlib-1.0-5.fc18.src.rpm

Comment 11 Micah Roth 2013-04-27 15:51:22 UTC
New Package SCM Request
=======================
Package Name: zimlib
Short Description: Library for reading/writing ZIM files
Owners: ndroftheline
Branches: f17 f18 f19
InitialCC:

Comment 12 Gwyn Ciesla 2013-04-27 20:48:37 UTC
Git done (by process-git-requests).

Comment 13 Fedora Update System 2013-05-02 17:07:54 UTC
zimlib-1.0-5.fc19 has been submitted as an update for Fedora 19.
https://admin.fedoraproject.org/updates/zimlib-1.0-5.fc19

Comment 14 Fedora Update System 2013-05-02 17:45:02 UTC
zimlib-1.0-5.fc18 has been submitted as an update for Fedora 18.
https://admin.fedoraproject.org/updates/zimlib-1.0-5.fc18

Comment 15 Fedora Update System 2013-05-03 15:18:36 UTC
zimlib-1.0-5.fc19 has been pushed to the Fedora 19 testing repository.

Comment 16 Fedora Update System 2013-06-09 02:25:50 UTC
zimlib-1.0-5.fc18 has been pushed to the Fedora 18 stable repository.

Comment 17 Fedora Update System 2013-06-09 03:29:15 UTC
zimlib-1.0-5.fc19 has been pushed to the Fedora 19 stable repository.


Note You need to log in before you can comment on or make changes to this bug.