Bug 1327083

Summary: Review Request: usnic-tools - Simple tool for extracting diagnostics and informational data
Product: [Fedora] Fedora Reporter: Honggang LI <honli>
Component: Package ReviewAssignee: Michal Schmidt <mschmidt>
Status: CLOSED ERRATA QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: rawhideCC: jsquyres, mschmidt, package-review
Target Milestone: ---Flags: mschmidt: fedora-review+
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-05-07 12:07:46 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1315609    

Description Honggang LI 2016-04-14 09:14:33 UTC
Spec URL: http://people.redhat.com/honli/.4450b38c8011bb39223fc38f16a99579/usnic-tools.spec

SRPM URL: http://people.redhat.com/honli/.4450b38c8011bb39223fc38f16a99579/usnic-tools-1.1.0.0-1.fc25.src.rpm

Description: This is a simple tool for extracting some diagnostics and informational meta data out of Cisco usNIC devices using the Cisco usNIC extensions in libfabric.

Fedora Account System Username: honli

Comment 1 Michal Schmidt 2016-04-14 10:10:53 UTC
> Name:           usnic-tools
> Version:        1.1.0.0
> Release:        1%{?dist}
> Summary:        Simple tool for extracting diagnostics and informational data

One could match that summary on a lot of packages :-)
How about:
Tool for extracting diagnostics and informational data from Cisco usNIC devices

> License:        GPLv2 or BSD
> Url:            http://cisco.com/

Please use a more relevant URL. https://github.com/cisco/usnic_tools

> Source0:        https://github.com/cisco/usnic_tools/releases/download/v%{version}/%{name}-%{version}.tar.gz
> BuildRequires:  libfabric-devel >= 1.3.0
> 
> %description
> This is a simple tool for extracting some diagnostics and informational
> meta data out of Cisco usNIC devices using the Cisco usNIC extensions
> in libfabric.
> 
> %prep
> %setup -q
> 
> %build
> %configure
> make %{?_smp_mflags}
> 
> %install
> %{make_install}
> 
> %files
> # All files are licensed in GPLv2.

Misleading. Remove the comment.

> %{_bindir}/*
> %license COPYING

Might want to add %doc README.md, even though most of its content is irrelevant
build instructions. The example output is nice to have.
 
> %changelog
> * Thu Apr 14 2016 Honggang Li <honli> - 1.1.0.0-1
> - Import usnic-tools for Fedora.

Comment 2 Honggang LI 2016-04-14 11:13:05 UTC
Spec URL: http://people.redhat.com/honli/.4450b38c8011bb39223fc38f16a99579/usnic-tools.spec

SRPM URL: http://people.redhat.com/honli/.4450b38c8011bb39223fc38f16a99579/usnic-tools-1.1.0.0-2.fc25.src.rpm

====================
$ diff -up usnic-tools.spec.old usnic-tools.spec
--- usnic-tools.spec.old        2016-04-14 05:11:32.000000000 -0400
+++ usnic-tools.spec    2016-04-14 06:55:44.113147378 -0400
@@ -1,9 +1,9 @@
 Name:           usnic-tools
 Version:        1.1.0.0
-Release:        1%{?dist}
-Summary:        Simple tool for extracting diagnostics and informational data
+Release:        2%{?dist}
+Summary:        Simple tool for extracting diagnostics and informational data from Cisco usNIC devices
 License:        GPLv2 or BSD
-Url:            http://cisco.com/
+Url:            https://github.com/cisco/usnic_tools
 Source0:        https://github.com/cisco/usnic_tools/releases/download/v%{version}/%{name}-%{version}.tar.gz
 BuildRequires:  libfabric-devel >= 1.3.0
 
@@ -23,10 +23,16 @@ make %{?_smp_mflags}
 %{make_install}
 
 %files
-# All files are licensed in GPLv2.
 %{_bindir}/*
 %license COPYING
+%doc README.md
 
 %changelog
+* Thu Apr 14 2016 Honggang Li <honli> - 1.1.0.0-2
+- Improve summary tag.
+- Use a more relevant source URL.
+- Remove license comment.
+- Add README.md as doc.
+
 * Thu Apr 14 2016 Honggang Li <honli> - 1.1.0.0-1
 - Import usnic-tools for Fedora.

Comment 3 Michal Schmidt 2016-04-14 13:39:46 UTC
Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated


Issues:
=======
rpmlint complains:
usnic-tools.x86_64: E: summary-too-long
I suggest you drop the word "Simple" from the Summary to make it fit in 80
characters.

The package uses AM_SILENT_RULES in configure.ac, so I suggest running make
with V=1 to let us see the compiler command lines in build.log.

please add:
BuildRequires: gcc
as per http://fedoraproject.org/wiki/Packaging:C_and_C%2B%2B

Upstream also provides a .tar.bz2 source archive, which is preferred to .tar.gz
because of generally smaller size. Please switch Source0 to that.

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

C/C++:
[x]: Package does not contain kernel modules.
[x]: Package contains no static executables.
[x]: Package does not contain any libtool archives (.la)
[x]: Rpath absent or only used for internal libs.

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]: License field in the package spec file matches the actual license.
[x]: License file installed when any subpackage combination is installed.
[-]: If the package is under multiple licenses, the licensing breakdown
     must be documented in the spec.
#### The software is entirely dual-licensed (recipient's choice) BSD or GPLv2.
[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.
[-]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (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]: 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.
[x]: Package is not known to require an ExcludeArch tag.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 1 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[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 %license.
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[x]: Package does not own files or directories owned by other packages.
[x]: All build dependencies are listed in BuildRequires, except for any
     that are listed in the exceptions section of Packaging Guidelines.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[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

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

Generic:
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[-]: 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).
[x]: Fully versioned dependency in subpackages if applicable.
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[?]: 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]: 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]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Uses parallel make %{?_smp_mflags} macro.
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

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

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


Rpmlint
-------
Checking: usnic-tools-1.1.0.0-2.fc25.x86_64.rpm
          usnic-tools-debuginfo-1.1.0.0-2.fc25.x86_64.rpm
          usnic-tools-1.1.0.0-2.fc25.src.rpm
usnic-tools.x86_64: E: summary-too-long C Simple tool for extracting diagnostics and informational data from Cisco usNIC devices
usnic-tools.x86_64: W: spelling-error %description -l en_US libfabric -> lib fabric, lib-fabric, fabric
usnic-tools.x86_64: W: no-manual-page-for-binary usnic_devinfo
usnic-tools.src: E: summary-too-long C Simple tool for extracting diagnostics and informational data from Cisco usNIC devices
usnic-tools.src: W: spelling-error %description -l en_US libfabric -> lib fabric, lib-fabric, fabric
usnic-tools.src: W: invalid-url Source0: https://github.com/cisco/usnic_tools/releases/download/v1.1.0.0/usnic-tools-1.1.0.0.tar.gz HTTP Error 403: Forbidden
3 packages and 0 specfiles checked; 2 errors, 4 warnings.




Requires
--------
usnic-tools-debuginfo (rpmlib, GLIBC filtered):

usnic-tools (rpmlib, GLIBC filtered):
    libc.so.6()(64bit)
    libfabric.so.1()(64bit)
    libfabric.so.1(FABRIC_1.0)(64bit)
    rtld(GNU_HASH)



Provides
--------
usnic-tools-debuginfo:
    usnic-tools-debuginfo
    usnic-tools-debuginfo(x86-64)

usnic-tools:
    usnic-tools
    usnic-tools(x86-64)



Source checksums
----------------
https://github.com/cisco/usnic_tools/releases/download/v1.1.0.0/usnic-tools-1.1.0.0.tar.gz :
  CHECKSUM(SHA256) this package     : 8eb424bd2fc3192ae53a477e953743da3ed1c47c34543394d800ba70490d2202
  CHECKSUM(SHA256) upstream package : 8eb424bd2fc3192ae53a477e953743da3ed1c47c34543394d800ba70490d2202


Generated by fedora-review 0.6.0 (3c5c9d7) last change: 2015-05-20
Command line :/usr/bin/fedora-review -b 1327083
Buildroot used: fedora-rawhide-x86_64
Active plugins: Generic, Shell-api, C/C++
Disabled plugins: Java, Python, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP, Ruby
Disabled flags: EXARCH, DISTTAG, EPEL5, BATCH, EPEL6

Comment 5 Michal Schmidt 2016-04-15 08:52:06 UTC
> # Add -fsigned-char to build it on ARM platform.
> export CFLAGS="$RPM_OPT_FLAGS -fsigned-char"

This is because of this code:

  char c;
  /* ... */
  while ((c = getopt(argc, argv, "bd:")) != EOF) { /* ... */ }

A better fix is to have 'c' as int.

Also, getopt() is specified to return -1, not EOF, when all options have been parsed. On glibc EOF is -1, but it should not be relied on.

I'm not going to block the review for this, but please have this fixed upstream.

Approved.

Comment 6 Honggang LI 2016-04-15 08:59:20 UTC
https://github.com/cisco/usnic_tools/issues/13

This issue had been reported to upstream.

Comment 7 Jeff Squyres 2016-04-15 10:57:26 UTC
Fixed upstream, and new version released (v1.1.1.0) containing the fix.

Comment 8 Gwyn Ciesla 2016-04-15 12:31:21 UTC
Package request has been approved: https://admin.fedoraproject.org/pkgdb/package/rpms/usnic-tools

Comment 9 Fedora Update System 2016-04-18 01:43:00 UTC
usnic-tools-1.1.1.0-1.fc24 has been submitted as an update to Fedora 24. https://bodhi.fedoraproject.org/updates/FEDORA-2016-8521f6c7d4

Comment 10 Fedora Update System 2016-04-18 18:51:40 UTC
usnic-tools-1.1.1.0-1.fc24 has been pushed to the Fedora 24 testing repository. If problems still persist, please make note of it in this bug report.
See https://fedoraproject.org/wiki/QA:Updates_Testing for
instructions on how to install test updates.
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2016-8521f6c7d4

Comment 11 Fedora Update System 2016-05-07 12:07:44 UTC
usnic-tools-1.1.1.0-1.fc24 has been pushed to the Fedora 24 stable repository. If problems still persist, please make note of it in this bug report.