Bug 1628752 - Review Request: ipmctl - Utility for managing Intel DCPMM
Summary: Review Request: ipmctl - Utility for managing Intel DCPMM
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-09-13 21:34 UTC by Juston Li
Modified: 2019-01-09 18:39 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-09-19 17:45:41 UTC
Type: ---
Embargoed:
zebob.m: fedora-review+


Attachments (Terms of Use)

Description Juston Li 2018-09-13 21:34:02 UTC
Spec URL: https://copr-be.cloud.fedoraproject.org/results/jhli/ipmctl/fedora-28-x86_64/00797907-ipmctl/ipmctl.spec

SRPM URL: https://copr-be.cloud.fedoraproject.org/results/jhli/ipmctl/fedora-28-x86_64/00797907-ipmctl/ipmctl-01.00.00.3262-2.fc28.src.rpm

Description: Utility for managing Intel Optane DC persistent memory modules. This obsoletes ixpdimm_sw (https://src.fedoraproject.org/rpms/ixpdimm_sw). ipmctl is a rename but also a new codebase that is not compatible with ixpdimm_sw. ixdimm_sw has been deprecated for 4 months now and I will retire the packages.

Fedora Account System Username: jhli

Comment 1 Robert-André Mauchin 🐧 2018-09-16 20:28:45 UTC
 - Group: is not used in Fedora

 - Use a more meaningful name for your archive with: 

Source:		https://github.com/intel/ipmctl/archive/v%{version}/%{name}-%{version}.tar.gz


 - If you obsolete stuff, you should add similar Provides in order to have an upgrade path for your users:

Obsoletes:	ixpdimm-cli < 01.00.00.3000

Obsoletes:	ixpdimm_sw < 01.00.00.3000
Obsoletes:	libixpdimm-common < 01.00.00.3000
Obsoletes:	libixpdimm-core < 01.00.00.3000
Obsoletes:	libixpdimm-cli < 01.00.00.3000
Obsoletes:	libixpdimm-cim < 01.00.00.3000
Obsoletes:	libixpdimm < 01.00.00.3000
Obsoletes:	ixpdimm-data < 01.00.00.3000

→ obsolete-not-provided:
If a package is obsoleted by a compatible replacement, the obsoleted package
should also be provided in order to not cause unnecessary dependency breakage.
If the obsoleting package is not a compatible replacement for the old one,
leave out the Provides.


 - Are you sure you need to specify the lib dependency in ipmctl and ipmctl-monitor? Usually RPM is able to pick up what libs are necessary automatically.

Requires:	libipmctl%{?_isa} = %{version}-%{release}

I've checked and libipmctl.so.2()(64bit) is indeed picked up, so you don't need these Requires.

 - Build fails:

[  1%] Generating String Definitions
python /builddir/build/BUILD/ipmctl-01.00.00.3262/src/os/efi_shim/os_efi_hii_auto_gen_strings.py
BUILDSTDERR: make[2]: python: Command not found
BUILDSTDERR: make[2]: *** [CMakeFiles/stringdefs.dir/build.make:70: src/os/efi_shim/os_efi_hii_auto_gen_strings.h] Error 127
make[2]: Leaving directory '/builddir/build/BUILD/ipmctl-01.00.00.3262'
BUILDSTDERR: make[1]: *** [CMakeFiles/Makefile2:303: CMakeFiles/stringdefs.dir/all] Error 2

It should call python2 or python3 not "python". Python 3 preferred as we're retiring Python 2 by 2020.

 - make -f Makefile install DESTDIR=%{buildroot} → %make_install -f Makefile

 - In order to avoid unintentional SONAME bump, globbing the major soname vension is now forbidden, instead use:

%{_libdir}/libipmctl.so.2*

 - You should probably use %config(noreplace) here:

%config(noreplace) %{_sysconfdir}/ipmctl.conf

 - Split the description to stay below 80 characters per line:

ipmctl-monitor.x86_64: E: description-line-too-long C A monitor daemon for monitoring the health and status of Utility for managing Intel Optane DC persistent memory modules

 - You need a logrotate file:

libipmctl.x86_64: W: log-files-without-logrotate ['/var/log/ipmctl']

   See https://fedoraproject.org/wiki/Packaging:Guidelines#Logrotate_config_file

 - Release should start at 1

 Release:	1%{?dist}

 - Your changelog entries are missing the Release info:

%changelog
* Thu Sep 13 2018 Juston Li <juston.li> - 01.00.00.3262-1
- Clean up spec for fedora

* Wed May 02 2018 Juston Li <juston.li> - 01.00.00.3000-1
- initial spec




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

Legend:
[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]: If your application is a C or C++ application you must list a
     BuildRequires against gcc, gcc-c++ or clang.
[x]: Header files in -devel subpackage, if present.
[x]: ldconfig not called in %post and %postun for Fedora 28 and later.
[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]: 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]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "*No copyright* BSD (3 clause)",
     "MIT/X11 (BSD like)", "BSD (unspecified)", "BSD (3 clause)", "BSD (2
     clause)". 5075 files have unknown license. Detailed output of
     licensecheck in /home/bob/packaging/review/ipmctl/review-
     ipmctl/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[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
[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.
[x]: 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]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: Package requires other packages for directories it uses.
[x]: Package does not own files or directories owned by other packages.
[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]: %config files are marked noreplace or the reason is justified.
[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]: No %config files under /usr.
[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:
[-]: 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.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in ipmctl-
     monitor , libipmctl , ipmctl-debuginfo , ipmctl-debugsource
[?]: 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.
[-]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[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]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: The placement of pkgconfig(.pc) files are correct.
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: Spec use %global instead of %define unless justified.

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

Generic:
[x]: Rpmlint is run on debuginfo package(s).
     Note: No rpmlint messages.
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[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: ipmctl-01.00.00.3262-2.fc30.x86_64.rpm
          ipmctl-monitor-01.00.00.3262-2.fc30.x86_64.rpm
          libipmctl-01.00.00.3262-2.fc30.x86_64.rpm
          libipmctl-devel-01.00.00.3262-2.fc30.x86_64.rpm
          ipmctl-debuginfo-01.00.00.3262-2.fc30.x86_64.rpm
          ipmctl-debugsource-01.00.00.3262-2.fc30.x86_64.rpm
          ipmctl-01.00.00.3262-2.fc30.src.rpm
ipmctl.x86_64: W: incoherent-version-in-changelog 01.00.00.3262 ['01.00.00.3262-2.fc30', '01.00.00.3262-2']
ipmctl.x86_64: W: obsolete-not-provided ixpdimm-cli
ipmctl.x86_64: W: no-documentation
ipmctl.x86_64: W: no-manual-page-for-binary ipmctl
ipmctl-monitor.x86_64: E: description-line-too-long C A monitor daemon for monitoring the health and status of Utility for managing Intel Optane DC persistent memory modules
ipmctl-monitor.x86_64: W: obsolete-not-provided ixpdimm-monitor
ipmctl-monitor.x86_64: W: manual-page-warning /usr/share/man/man1/ipmctl-change-device-passphrase.1.gz 134: warning: macro `..' not defined
ipmctl-monitor.x86_64: W: manual-page-warning /usr/share/man/man1/ipmctl-change-preferences.1.gz 363: warning: macro `..' not defined
ipmctl-monitor.x86_64: W: manual-page-warning /usr/share/man/man1/ipmctl-change-sensor.1.gz 133: warning: macro `..' not defined
ipmctl-monitor.x86_64: W: manual-page-warning /usr/share/man/man1/ipmctl-delete-goal.1.gz 80: warning: macro `..' not defined
ipmctl-monitor.x86_64: W: manual-page-warning /usr/share/man/man1/ipmctl-enable-device-security.1.gz 121: warning: macro `..' not defined
ipmctl-monitor.x86_64: W: manual-page-warning /usr/share/man/man1/ipmctl-help.1.gz 64: warning: macro `..' not defined
ipmctl-monitor.x86_64: W: manual-page-warning /usr/share/man/man1/ipmctl-inject.1.gz 248: warning: macro `..' not defined
ipmctl-monitor.x86_64: W: manual-page-warning /usr/share/man/man1/ipmctl-update-firmware.1.gz 173: warning: macro `..' not defined
ipmctl-monitor.x86_64: W: no-manual-page-for-binary ipmctl-monitor
libipmctl.x86_64: E: description-line-too-long C An Application Programming Interface (API) library for managing Intel Optane DC persistent memory modules.
libipmctl.x86_64: W: obsolete-not-provided ixpdimm-data
libipmctl.x86_64: W: obsolete-not-provided ixpdimm_sw
libipmctl.x86_64: W: obsolete-not-provided libixpdimm
libipmctl.x86_64: W: obsolete-not-provided libixpdimm-cim
libipmctl.x86_64: W: obsolete-not-provided libixpdimm-cli
libipmctl.x86_64: W: obsolete-not-provided libixpdimm-common
libipmctl.x86_64: W: obsolete-not-provided libixpdimm-core
libipmctl.x86_64: W: log-files-without-logrotate ['/var/log/ipmctl']
libipmctl-devel.x86_64: W: obsolete-not-provided ixpdimm-devel
libipmctl-devel.x86_64: W: obsolete-not-provided ixpdimm_sw-devel
libipmctl-devel.x86_64: W: no-documentation
7 packages and 0 specfiles checked; 2 errors, 25 warnings.

Comment 2 Juston Li 2018-09-18 17:02:21 UTC
Spec URL: https://copr-be.cloud.fedoraproject.org/results/jhli/ipmctl/fedora-28-x86_64/00799986-ipmctl/ipmctl.spec

SRPM URL: https://copr-be.cloud.fedoraproject.org/results/jhli/ipmctl/fedora-28-x86_64/00799986-ipmctl/ipmctl-01.00.00.3262-1.fc28.src.rpm

Fixed except the two below, Let me know if you still think they should be changed.

Thank you for doing the review! It is very much appreciated!

(In reply to Robert-André Mauchin from comment #1) 
>  - If you obsolete stuff, you should add similar Provides in order to have
> an upgrade path for your users:
> 
> Obsoletes:	ixpdimm-cli < 01.00.00.3000
> 
> Obsoletes:	ixpdimm_sw < 01.00.00.3000
> Obsoletes:	libixpdimm-common < 01.00.00.3000
> Obsoletes:	libixpdimm-core < 01.00.00.3000
> Obsoletes:	libixpdimm-cli < 01.00.00.3000
> Obsoletes:	libixpdimm-cim < 01.00.00.3000
> Obsoletes:	libixpdimm < 01.00.00.3000
> Obsoletes:	ixpdimm-data < 01.00.00.3000
> 
> → obsolete-not-provided:
> If a package is obsoleted by a compatible replacement, the obsoleted package
> should also be provided in order to not cause unnecessary dependency
> breakage.
> If the obsoleting package is not a compatible replacement for the old one,
> leave out the Provides.
> 

I considered it an incompatible replacement, it is based on a new codebase and went through a number of other changes. ixpdimm_sw has not been distributed in months and all users should have migrated to ipmctl.

>  - Are you sure you need to specify the lib dependency in ipmctl and
> ipmctl-monitor? Usually RPM is able to pick up what libs are necessary
> automatically.
> 
> Requires:	libipmctl%{?_isa} = %{version}-%{release}
> 
> I've checked and libipmctl.so.2()(64bit) is indeed picked up, so you don't
> need these Requires.

The binary and lib are always compiled and released together. I do agree these requires don't seem to be needed but separate versions are not validated so I'd like to keep them together just in case there are any issues.

Thanks again!

Comment 3 Robert-André Mauchin 🐧 2018-09-18 17:34:18 UTC
 - BuildRequires:	python2

It should be python3 as that's what you run in CMakeList

 - Also now the archive in the SRPM differs from the one linked in Source0, that's not okay. You should make a new release with the fixes you've made in order to have the same checksum.


Package is approved but please fix these issues before import.

Comment 4 Gwyn Ciesla 2018-09-18 19:31:55 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/ipmctl

Comment 5 Fedora Update System 2018-09-19 17:41:12 UTC
ipmctl-01.00.00.3262-1.fc27 has been submitted as an update to Fedora 27. https://bodhi.fedoraproject.org/updates/FEDORA-2018-026e8cc747

Comment 6 Fedora Update System 2018-09-19 17:41:18 UTC
ipmctl-01.00.00.3262-1.fc28 has been submitted as an update to Fedora 28. https://bodhi.fedoraproject.org/updates/FEDORA-2018-fc4e7fc9bc

Comment 7 Juston Li 2018-09-19 17:45:41 UTC
(In reply to Robert-André Mauchin from comment #3)
>  - BuildRequires:	python2
> 
> It should be python3 as that's what you run in CMakeList
> 

Fixed 

>  - Also now the archive in the SRPM differs from the one linked in Source0,
> that's not okay. You should make a new release with the fixes you've made in
> order to have the same checksum.

I can't bump the version due to our release cycle, I added these fixes as patches.

Thanks again!

Closing now

Comment 8 Fedora Update System 2018-09-20 18:38:13 UTC
ipmctl-01.00.00.3262-1.fc28 has been pushed to the Fedora 28 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-2018-fc4e7fc9bc

Comment 9 Fedora Update System 2018-09-20 19:49:18 UTC
ipmctl-01.00.00.3262-1.fc27 has been pushed to the Fedora 27 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-2018-026e8cc747

Comment 10 Fedora Update System 2018-09-29 23:56:25 UTC
ipmctl-01.00.00.3262-1.fc27 has been pushed to the Fedora 27 stable repository. If problems still persist, please make note of it in this bug report.

Comment 11 Fedora Update System 2018-09-30 01:09:22 UTC
ipmctl-01.00.00.3262-1.fc28 has been pushed to the Fedora 28 stable repository. If problems still persist, please make note of it in this bug report.

Comment 12 Russ Anderson 2019-01-09 18:39:02 UTC
This is needed for Apache Pass DIMMs.


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