Bug 1962626 - Review Request: imath - C++ and python library of 2D and 3D vector, matrix, and math operations for computer graphics
Summary: Review Request: imath - C++ and python library of 2D and 3D vector, matrix, a...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-05-20 12:20 UTC by Richard Shaw
Modified: 2021-06-11 13:26 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2021-06-11 13:26:31 UTC
Type: ---
Embargoed:
eclipseo: fedora-review+


Attachments (Terms of Use)

Description Richard Shaw 2021-05-20 12:20:15 UTC
Spec URL: https://hobbes1069.fedorapeople.org/imath.spec
SRPM URL: https://hobbes1069.fedorapeople.org/imath-3.0.2-1.fc33.src.rpm

Description:
Imath is a basic, light-weight, and efficient C++ representation of 2D and 3D
vectors and matrices and other simple but useful mathematical objects,
functions, and data types common in computer graphics applications, including
the “half” 16-bit floating-point type.

Fedora Account System Username: hobbes1069

Comment 1 Richard Shaw 2021-05-20 12:20:19 UTC
This package built on koji:  https://koji.fedoraproject.org/koji/taskinfo?taskID=68325590

Comment 2 Robert-André Mauchin 🐧 2021-05-22 16:57:33 UTC
 - Your -devel package should require the main and python package

%package devel
Summary:        Development files for Imath
Requires:       %{name}%{?_isa} = %{version}-%{release}
Requires:       python3-%{name}%{?_isa} = %{version}-%{release}
Requires:       boost-devel
Requires:       python3-devel

%description devel
%{summary}.

 - Add all the md to the doc:

%doc CHANGES.md README.md CONTRIBUTORS.md CONTRIBUTING.md SECURITY.md

 - Shorten the Summary (<80 characters):

imath.x86_64: E: summary-too-long C C++ and python library of 2D and 3D vector, matrix, and math operations for computer graphics

 - There is some documentation in docs/ that needs to be build with Sphinx


BuildRequires:  python3-sphinx
BuildRequires:  python3-breathe

[…]

%build
%cmake -DPYTHON=ON
%cmake_build

# Generate html docs
PYTHONPATH=${PWD} sphinx-build-3 docs/ html
# Remove the sphinx-build leftovers
rm -rf html/.{doctrees,buildinfo}

[…]

%files devel
%doc html/




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]: Development (unversioned) .so files in -devel subpackage, if present.
     Note: Unversioned so-files in private %_libdir subdirectory (see
     attachment). Verify they are not in ld path.
[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.

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.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "BSD 3-clause "New" or "Revised"
     License", "[generated file]". 299 files have unknown license. Detailed
     output of licensecheck in /home/bob/packaging/review/imath/review-
     imath/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.
[-]: 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 20480 bytes in 2 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]: 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 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]: 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:
[-]: 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).
[!]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python3-imath , imath-devel
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not 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.
[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]: 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: imath-3.0.2-1.fc35.x86_64.rpm
          python3-imath-3.0.2-1.fc35.x86_64.rpm
          imath-devel-3.0.2-1.fc35.x86_64.rpm
          imath-debuginfo-3.0.2-1.fc35.x86_64.rpm
          imath-debugsource-3.0.2-1.fc35.x86_64.rpm
          imath-3.0.2-1.fc35.src.rpm
imath.x86_64: E: summary-too-long C C++ and python library of 2D and 3D vector, matrix, and math operations for computer graphics
python3-imath.x86_64: W: no-documentation
imath-devel.x86_64: W: no-dependency-on imath/imath-libs/libimath
imath-devel.x86_64: W: no-documentation
imath.src: E: summary-too-long C C++ and python library of 2D and 3D vector, matrix, and math operations for computer graphics
6 packages and 0 specfiles checked; 2 errors, 3 warnings.

Comment 3 Ben Beasley 2021-05-22 17:20:22 UTC
While I changed my mind about reviewing this (thanks, Robert-André, for picking it up!), I did want to note that adding

> %check
> %ctest

worked for me, so unless there are any platform-dependent issues it’s probably trivially easy to run the tests too.

Comment 4 Richard Shaw 2021-05-25 02:56:19 UTC
SPEC: https://hobbes1069.fedorapeople.org/imath.spec
SRPM: https://hobbes1069.fedorapeople.org/imath-3.0.2-2.fc33.src.rpm


* Tue May 25 2021 Richard Shaw <hobbes1069> - 3.0.2-2
- Update spec per reviewer comments.


I saw the inline note about adding requirements to python3-imath, but it requires the library so I'm not sure if an explicit requirement is needed?

$ rpm -qp --requires python3-imath-3.0.2-1.fc35.x86_64.rpm 
libImath-3_0.so.28()(64bit)
...

Comment 5 Ben Beasley 2021-05-25 12:59:40 UTC
> I saw the inline note about adding requirements to python3-imath, but it requires the library so I'm > not sure if an explicit requirement is needed?
> 
> $ rpm -qp --requires python3-imath-3.0.2-1.fc35.x86_64.rpm 
> libImath-3_0.so.28()(64bit)
> ...

The idea is to use a fully-versioned dependency to make sure subpackages stay in sync with their base package. This may not be strictly necessary in some cases, but it avoids a lot of confusing problems in general.



> When a subpackage requires the base package, it must do so using a fully versioned arch-specific (for non-noarch packages) dependency

https://docs.fedoraproject.org/en-US/packaging-guidelines/#_requiring_base_package

Comment 6 Richard Shaw 2021-05-27 12:04:10 UTC
SPEC: https://hobbes1069.fedorapeople.org/imath.spec
SRPM: https://hobbes1069.fedorapeople.org/imath-3.0.2-3.fc33.src.rpm

* Thu May 27 2021 Richard Shaw <hobbes1069> - 3.0.2-3
- Add main package as dependency to python package.

Comment 7 Robert-André Mauchin 🐧 2021-05-28 10:12:36 UTC
Package approved.

Comment 8 Richard Shaw 2021-05-28 12:26:09 UTC
Repo requested: 
https://pagure.io/releng/fedora-scm-requests/issue/34284

Thanks for the review!

Comment 9 Gwyn Ciesla 2021-05-28 13:48:36 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/imath


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