Bug 959734 - Review Request: sigrok-firmware - Firmware for some hardware supported by sigrok
Summary: Review Request: sigrok-firmware - Firmware for some hardware supported by sigrok
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: T.C. Hollingsworth
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
: 959733 (view as bug list)
Depends On:
Blocks: 922246
TreeView+ depends on / blocked
 
Reported: 2013-05-05 06:59 UTC by Alex G.
Modified: 2013-05-15 17:30 UTC (History)
4 users (show)

Fixed In Version: sigrok-firmware-0.1.0-3.20130426git83e0802.fc19
Clone Of:
Environment:
Last Closed: 2013-05-15 17:30:17 UTC
Type: ---
Embargoed:
tchollingsworth: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)

Description Alex G. 2013-05-05 06:59:08 UTC
Spec URL: http://g-tech.no-ip.org/~mrnuke/fedrev/sigrok-firmware-0.1.0-1.20130426git83e0802/sigrok-firmware.spec
SRPM URL: http://g-tech.no-ip.org/~mrnuke/fedrev/sigrok-firmware-0.1.0-1.20130426git83e0802/sigrok-firmware-0.1.0-1.20130426git83e0802.fc18.src.rpm
sigrok-firmware is a collection of firmware files required for some of the devices libsigrok supports (logic analyzers, oscilloscopes, or others).

sigrok-firmware only contains firmware files which have an explicit permission/license that allows at _least_ redistribution of the firmware.
Fedora Account System Username: mrnuke

Comment 1 Alex G. 2013-05-05 06:59:54 UTC
*** Bug 959733 has been marked as a duplicate of this bug. ***

Comment 2 Antonio T. (sagitter) 2013-05-05 13:00:23 UTC
Hi Alex.

- 'Package free', I see a BSD license:

 $ licensecheck asix-sigma/LICENSE.Sigma
asix-sigma/LICENSE.Sigma: BSD

- 'Package nonfree':

$ licensecheck nexus-osciprime/COPYING
nexus-osciprime/COPYING: *No copyright* UNKNOWN

Inside, it refers to a GPLv2 license.


Why nonfree ?

Comment 3 Alex G. 2013-05-05 19:11:06 UTC
(In reply to comment #2)
> Hi Alex.
> 
> - 'Package free', I see a BSD license:
> 
>  $ licensecheck asix-sigma/LICENSE.Sigma
> asix-sigma/LICENSE.Sigma: BSD

Hi Antonio,

licensecheck is very wrong here. The sigma license starts with the wording from BSD, but then it adds a clause forbidding reverse-engineering, and yet another clause stating that modifications may (only ?) be obtained through ASIX s.r.o..

Hence, I put it in the non-free package:
%files nonfree
%doc asix-sigma/LICENSE.Sigma
%{_datadir}/%{name}/asix-sigma-*.fw

> 
> - 'Package nonfree':
> 
> $ licensecheck nexus-osciprime/COPYING
> nexus-osciprime/COPYING: *No copyright* UNKNOWN
> 
> Inside, it refers to a GPLv2 license.
> 
> Why nonfree ?

It is in the 'free' package.

%files free
%doc nexus-osciprime/COPYING.osciprime
%{_datadir}/%{name}/nexus-osciprime.fw

Comment 4 T.C. Hollingsworth 2013-05-06 18:24:44 UTC
While the nexus-osciprime firmware falls under the binary firmware exception so it's okay to use the prebuilt binary, in order to be complaint with the GPLv2 you still need to ship the source code to it in the SRPM.  You should also set the license tag to GPLv2(+).

Does upstream plan to add more firmware to this package in the future?  It seems silly to use -nonfree and -free subpackages when each only contains one kind of firmware.  It seems to make more sense just to name the package after the type of firmware included.

Rpmlint
-------
Checking: sigrok-firmware-free-0.1.0-1.20130426git83e0802.fc20.noarch.rpm
          sigrok-firmware-filesystem-0.1.0-1.20130426git83e0802.fc20.noarch.rpm
          sigrok-firmware-0.1.0-1.20130426git83e0802.fc20.src.rpm
          sigrok-firmware-nonfree-0.1.0-1.20130426git83e0802.fc20.noarch.rpm
sigrok-firmware-free.noarch: E: description-line-too-long C The sigrok-firmware-free package contains firmwares which are available under free

Please wrap at 80 characters.

sigrok-firmware-free.noarch: W: invalid-license Redistributable

Please use an appropriate license tag for the GPL here.

sigrok-firmware-filesystem.noarch: W: summary-not-capitalized C sigrok-firmware directory structure

Something like "Directory structure for the Sigrok firmware" would shut this up.

sigrok-firmware-filesystem.noarch: W: invalid-license Redistributable

Please use a valid license specifier (since this just contains a single directory something like Public Domain would probably be most accurate).

sigrok-firmware.src: W: spelling-error %description -l en_US libsigrok 

False positive, library name,

sigrok-firmware.src: E: description-line-too-long C sigrok-firmware only contains firmware files which have an explicit permission/license

Please wrap at 80 characters.

sigrok-firmware.src: W: invalid-license Redistributable

Please use the union of the licenses for the SRPM, just to make things clear.

e.g. GPLv2 and Redistributable, no modification permitted

sigrok-firmware.src:16: W: macro-in-comment %{name}
sigrok-firmware.src:16: W: macro-in-comment %{version}
sigrok-firmware.src:16: W: macro-in-comment %{name}
sigrok-firmware.src:16: W: macro-in-comment %{version}
sigrok-firmware.src:16: W: macro-in-comment %{checkout}

Please escape macros used in comments.  (e.g. "%%{name}")

sigrok-firmware.src: W: invalid-url Source0: sigrok-firmware-0.1.0-20130426git83e0802.tar.gz

OK, instructions for generating in the comments.

sigrok-firmware-nonfree.noarch: E: description-line-too-long C The sigrok-firmware-nonfree package contains firmwares available under non-free licenses

Again, please wrap at 80 characters.

4 packages and 0 specfiles checked; 3 errors, 11 warnings.

Comment 5 Alex G. 2013-05-06 21:45:38 UTC
(In reply to comment #4)
> While the nexus-osciprime firmware falls under the binary firmware exception
> so it's okay to use the prebuilt binary, in order to be complaint with the
> GPLv2 you still need to ship the source code to it in the SRPM.  You should
> also set the license tag to GPLv2(+).
> 
> Does upstream plan to add more firmware to this package in the future?  It
> seems silly to use -nonfree and -free subpackages when each only contains
> one kind of firmware.  It seems to make more sense just to name the package
> after the type of firmware included.
>
Yes, there will be more firmware added here. Upstream is constanly wotking on
new hardware, and some of the hardware will require firmware. I didn't want to
have a subpackage for each device, because I don't want to end up with a
texlive-live situation (almost a thousand packages -- a real pain to yum update)
I will leave it at free/nonfree for now (with the appropriate license field).
I will deal with new firmware licenses as they are added.

> Please use the union of the licenses for the SRPM, just to make things clear.
> 
> e.g. GPLv2 and Redistributable, no modification permitted
> 
Thanks, I was really debating on how to name this one.

Working on improved spec/srpm...

Comment 7 T.C. Hollingsworth 2013-05-06 23:21:40 UTC
(In reply to comment #5)
> Yes, there will be more firmware added here. Upstream is constanly wotking on
> new hardware, and some of the hardware will require firmware. I didn't want
> to
> have a subpackage for each device, because I don't want to end up with a
> texlive-live situation (almost a thousand packages -- a real pain to yum
> update)
> I will leave it at free/nonfree for now (with the appropriate license field).
> I will deal with new firmware licenses as they are added.

Okay, sounds good.  :-)

--

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

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

Status: NEEDS WORK

==== Issues ====

[!]: rpmlint is still complaining about one of the descriptions.

     Make sure they're all wrapped properly.
     
[!]: Unversioned requires on filesystem subpackage.

     Yeah, it's unlikely to change much, but let's follow the guidelines here
     and add "= %{version}-%{release}" to the dependencies on the filesystem
     package.
     
[!]: Spec URL and Spec in SRPM don't match.

     Please make sure they're in sync on the next update.

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

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]: Package successfully compiles and builds into binary rpms on at least one
     supported primary architecture.
[x]: %build honors applicable compiler flags or justifies otherwise.
[x]: All build dependencies are listed in BuildRequires, except for any that
     are listed in the exceptions section of Packaging Guidelines.
[x]: Package contains no bundled libraries.
[x]: Changelog in prescribed format.
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Sources contain only permissible code or content.
[x]: Each %files section contains %defattr if rpm < 4.4
[x]: Macros in Summary, %description expandable at SRPM build time.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[x]: Package requires other packages for directories it uses.
[x]: Package uses nothing in %doc for runtime.
[x]: Package is not known to require ExcludeArch.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[!]: Fully versioned dependency in subpackages, if present.
[x]: Package complies to the Packaging Guidelines
[x]: Spec file lacks Packager, Vendor, PreReq tags.
[x]: 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.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. No licenses
     found. Please check the source files for licenses manually.
[x]: License file installed when any subpackage combination is installed.
[x]: Package consistently uses macro is (instead of hard-coded directory
     names).
[x]: If the package is under multiple licenses, the licensing breakdown must
     be documented in the spec.
[x]: Package is named using only allowed ASCII characters.
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
     Note: Package contains no Conflicts: tag(s)
[x]: Package do not use a name that already exist
[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.
[x]: Package installs properly.
[x]: Package is not relocatable.
[x]: Requires correct, justified where necessary.
[x]: CheckResultdir
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: Sources used to build the package match the upstream source, as provided
     in the spec URL.
[x]: Spec file is legible and written in American English.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[-]: Package contains systemd file(s) if in need.
[x]: File names are valid UTF-8.
[-]: Large documentation must go in a -doc subpackage.
[x]: Packages must not store files under /srv, /opt or /usr/local

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

Generic:
[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)
[-]: 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]: Dist tag is present.
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[!]: Final provides and requires are sane (rpm -q --provides and rpm -q
     --requires).
[x]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: The placement of pkgconfig(.pc) files are correct.
[x]: SourceX tarball generation or download is documented.
[!]: SourceX / PatchY prefixed with %{name}.
     Note: Source2 (oscione-vhdl.tar.gz) Source1 (fx2-firmware.tar.gz)
[x]: SourceX is a working URL.
[-]: 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.
[x]: Packages should try to preserve timestamps of original installed files.
[x]: Spec use %global instead of %define.

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

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: No rpmlint messages.
[!]: Spec file according to URL is the same as in SRPM.
     Note: Spec file as given by url is not the same as in SRPM (see attached
     diff).
[-]: Large data in /usr/share should live in a noarch subpackage if package is
     arched.


Rpmlint
-------
Checking: sigrok-firmware-nonfree-0.1.0-2.20130426git83e0802.fc20.noarch.rpm
          sigrok-firmware-free-0.1.0-2.20130426git83e0802.fc20.noarch.rpm
          sigrok-firmware-filesystem-0.1.0-2.20130426git83e0802.fc20.noarch.rpm
          sigrok-firmware-0.1.0-2.20130426git83e0802.fc20.src.rpm
sigrok-firmware.src: W: spelling-error %description -l en_US libsigrok 
sigrok-firmware.src: E: description-line-too-long C sigrok-firmware only contains firmware files which have an explicit permission/license
sigrok-firmware.src: W: invalid-url Source0: sigrok-firmware-0.1.0-20130426git83e0802.tar.gz
4 packages and 0 specfiles checked; 1 errors, 2 warnings.

rpmlint is still complaining about one of the descriptions.


Rpmlint (installed packages)
----------------------------
# rpmlint sigrok-firmware-free sigrok-firmware-filesystem sigrok-firmware-nonfree
3 packages and 0 specfiles checked; 0 errors, 0 warnings.
# echo 'rpmlint-done:'

OK

Diff spec file in url and in SRPM
---------------------------------
--- /home/fedora/patches/FedoraReview/959734-sigrok-firmware/srpm/sigrok-firmware.spec	2013-05-06 16:59:40.015476355 -0600
+++ /home/fedora/patches/FedoraReview/959734-sigrok-firmware/srpm-unpacked/sigrok-firmware.spec	2013-05-06 16:59:42.380477141 -0600
@@ -7,5 +7,5 @@
 URL:            http://www.sigrok.org/
 # $ git clone git://sigrok.org/sigrok-firmware
-# $ cd sigrok-firmware
+# $ cd sigrok-firmwares
 # $ git checkout 83e0802146c2c6c211dc68fe18c6d556f04469b7
 # $ sh autogen.sh

Please make sure these are in sync when you do the next one.

Requires
--------
sigrok-firmware-nonfree-0.1.0-2.20130426git83e0802.fc20.noarch.rpm (rpmlib, GLIBC filtered):
    
    sigrok-firmware-filesystem

sigrok-firmware-free-0.1.0-2.20130426git83e0802.fc20.noarch.rpm (rpmlib, GLIBC filtered):
    
    sigrok-firmware-filesystem

sigrok-firmware-filesystem-0.1.0-2.20130426git83e0802.fc20.noarch.rpm (rpmlib, GLIBC filtered):
    
OK


Provides
--------
sigrok-firmware-nonfree-0.1.0-2.20130426git83e0802.fc20.noarch.rpm:
    
    sigrok-firmware-nonfree = 0.1.0-2.20130426git83e0802.fc20

sigrok-firmware-free-0.1.0-2.20130426git83e0802.fc20.noarch.rpm:
    
    sigrok-firmware-free = 0.1.0-2.20130426git83e0802.fc20

sigrok-firmware-filesystem-0.1.0-2.20130426git83e0802.fc20.noarch.rpm:
    
    sigrok-firmware-filesystem = 0.1.0-2.20130426git83e0802.fc20

OK

MD5-sum check
-------------
http://www.osciprime.com/repo/oscione-vhdl.tar.gz :
  CHECKSUM(SHA256) this package     : 0d2a096d304c2485d2168cf55f2779ddae05042b61d4b2a8c0178534b2d24846
  CHECKSUM(SHA256) upstream package : 0d2a096d304c2485d2168cf55f2779ddae05042b61d4b2a8c0178534b2d24846
http://www.osciprime.com/repo/fx2-firmware.tar.gz :
  CHECKSUM(SHA256) this package     : 025daa8504e6bc59b46077b74bc469dcd11d0d10f2797fd5a4fc0669a23fcff0
  CHECKSUM(SHA256) upstream package : 025daa8504e6bc59b46077b74bc469dcd11d0d10f2797fd5a4fc0669a23fcff0

OK

Generated by fedora-review 0.3.1 (f4bc12d) last change: 2012-10-16
Buildroot used: fedora-rawhide-vanilla-x86_64
Command line :./try-fedora-review -b959734

Comment 9 T.C. Hollingsworth 2013-05-07 00:07:33 UTC
This package is APPROVED.

Comment 10 Alex G. 2013-05-07 00:13:29 UTC
New Package SCM Request
=======================
Package Name: sigrok-firmware
Short Description: Firmware for some hardware supported by sigrok
Owners: mrnuke
Branches: f18 f19
InitialCC: mrnuke

Comment 11 Gwyn Ciesla 2013-05-07 13:13:22 UTC
Git done (by process-git-requests).

Comment 12 Fedora Update System 2013-05-07 17:38:06 UTC
sigrok-firmware-0.1.0-3.20130426git83e0802.fc19 has been submitted as an update for Fedora 19.
https://admin.fedoraproject.org/updates/sigrok-firmware-0.1.0-3.20130426git83e0802.fc19

Comment 13 Fedora Update System 2013-05-07 20:45:01 UTC
sigrok-firmware-0.1.0-3.20130426git83e0802.fc19 has been pushed to the Fedora 19 testing repository.

Comment 14 Fedora Update System 2013-05-15 17:30:17 UTC
sigrok-firmware-0.1.0-3.20130426git83e0802.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.