Bug 1680527 - Review Request: cabal-plan - Library and utility for processing cabal's plan.json file
Summary: Review Request: cabal-plan - Library and utility for processing cabal's plan....
Keywords:
Status: CLOSED DEFERRED
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Nobody's working on this, feel free to take it
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-02-25 09:43 UTC by Jens Petersen
Modified: 2020-07-02 06:13 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-07-02 06:13:33 UTC
Type: ---


Attachments (Terms of Use)

Description Jens Petersen 2019-02-25 09:43:26 UTC
Spec URL: http://petersen.fedorapeople.org//cabal-plan.spec
SRPM URL: http://petersen.fedorapeople.org//cabal-plan-0.4.0.0-1.fc29.src.rpm

Description:
This package provides a library for decoding 'plan.json' files as well as the
simple tool 'cabal-plan' for extracting and pretty printing the information
contained in the 'plan.json' file.

'plan.json' files are generated by
[cabal](https://hackage.haskell.org/package/cabal-install)'s [Nix-style local
builds](http://cabal.readthedocs.io/en/latest/nix-local-build.html) and contain
detailed information about the build/install plan computed by the cabal solver.

Comment 1 Jens Petersen 2019-02-25 09:43:29 UTC
This package built on koji:  https://koji.fedoraproject.org/koji/taskinfo?taskID=33030378

Comment 2 Robert-André Mauchin 🐧 2019-02-25 14:50:30 UTC
 - Latest version is 0.5.0.0

 - License would be GPLv2+ for 0.5.0.0 and src-topograph is BSD: Please add these licenses to the License field and add a comment explaining the breakdown.





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

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


Issues:
=======
- Package does not contain duplicates in %files.
  Note: BUILDSTDERR: warning: File listed twice: /usr/share/licenses/cabal-
  plan/LICENSE
  See: http://fedoraproject.org/wiki/Packaging/Guidelines#DuplicateFiles


===== 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]: 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.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "BSD 3-clause "New" or "Revised" License", "Unknown or
     generated". 8 files have unknown license. Detailed output of
     licensecheck in /home/bob/packaging/review/cabal-plan/review-cabal-
     plan/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.
[-]: 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 440320 bytes in 17 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]: 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]: Static libraries in -static or -devel subpackage, providing -devel if
     present.
     Note: Package has .a files: ghc-cabal-plan-devel.
[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 ghc-
     cabal-plan
[?]: 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.
[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]: 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 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: cabal-plan-0.4.0.0-1.fc31.x86_64.rpm
          ghc-cabal-plan-0.4.0.0-1.fc31.x86_64.rpm
          ghc-cabal-plan-devel-0.4.0.0-1.fc31.x86_64.rpm
          cabal-plan-0.4.0.0-1.fc31.src.rpm
cabal-plan.x86_64: W: spelling-error Summary(en_US) json -> son, j son
cabal-plan.x86_64: W: spelling-error %description -l en_US json -> son, j son
cabal-plan.x86_64: W: spelling-error %description -l en_US https -> HTTP
cabal-plan.x86_64: W: spelling-error %description -l en_US hackage -> package, hack age, hack-age
cabal-plan.x86_64: W: spelling-error %description -l en_US haskell -> Haskell
cabal-plan.x86_64: W: spelling-error %description -l en_US readthedocs -> headteachers
cabal-plan.x86_64: W: spelling-error %description -l en_US html -> HTML, ht ml, ht-ml
cabal-plan.x86_64: W: unstripped-binary-or-object /usr/bin/cabal-plan
cabal-plan.x86_64: E: missing-call-to-setgroups-before-setuid /usr/bin/cabal-plan
cabal-plan.x86_64: W: no-manual-page-for-binary cabal-plan
ghc-cabal-plan.x86_64: W: unstripped-binary-or-object /usr/lib64/libHScabal-plan-0.4.0.0-1QC6QdasRpMFFwWaYicaCl-ghc8.2.2.so
ghc-cabal-plan.x86_64: W: unstripped-binary-or-object /usr/lib64/libHScabal-plan-0.4.0.0-7jgvPpQR3kX315fyHhc8k0-topograph-ghc8.2.2.so
ghc-cabal-plan.x86_64: W: no-documentation
cabal-plan.src: W: spelling-error Summary(en_US) json -> son, j son
cabal-plan.src: W: spelling-error %description -l en_US json -> son, j son
cabal-plan.src: W: spelling-error %description -l en_US https -> HTTP
cabal-plan.src: W: spelling-error %description -l en_US hackage -> package, hack age, hack-age
cabal-plan.src: W: spelling-error %description -l en_US haskell -> Haskell
cabal-plan.src: W: spelling-error %description -l en_US readthedocs -> headteachers
cabal-plan.src: W: spelling-error %description -l en_US html -> HTML, ht ml, ht-ml
4 packages and 0 specfiles checked; 1 errors, 19 warnings.

Comment 3 Jens Petersen 2020-07-02 06:13:33 UTC
Sorry, thank you very much for the early review.

We are missing a few deps still for newer cabal-plan,
so let me close this out for now.


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