Bug 1849479 - Review Request: ghc-lukko - File locking
Summary: Review Request: ghc-lukko - File locking
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
low
unspecified
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-06-22 03:22 UTC by Jens Petersen
Modified: 2020-08-23 07:01 UTC (History)
2 users (show)

Fixed In Version: ghc-lukko-0.1.1.2-1.fc33
Clone Of:
Environment:
Last Closed: 2020-08-23 07:01:38 UTC
Type: ---
Embargoed:
eclipseo: fedora-review+


Attachments (Terms of Use)

Description Jens Petersen 2020-06-22 03:22:52 UTC
Spec URL: https://petersen.fedorapeople.org/reviews/ghc-lukko/ghc-lukko.spec
SRPM URL: https://petersen.fedorapeople.org/reviews/ghc-lukko/ghc-lukko-0.1.1.2-1.fc32.src.rpm

Description:
This package provides access to platform dependent file locking APIs:

*
<https://www.gnu.org/software/libc/manual/html_node/Open-File-Description-Locks.html
Open file descriptor locking> on Linux ("Lukko.OFD") * BSD-style 'flock(2)'
locks on UNIX platforms ("Lukko.FLock") * Windows locking via
<https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-lockfilee
LockFileEx> ("Lukko.Windows") * No-op locking, which throws exceptions
("Lukko.NoOp") * "Lukko" module exports the best option for the target platform
with uniform API.

There are alternative file locking packages:

* "GHC.IO.Handle.Lock" in 'base >= 4.10' is good enough for most use cases.
However, uses only 'Handle's so these locks cannot be used for intra-process
locking. (You should use e.g. 'MVar' in addition).

* <https://hackage.haskell.org/package/filelock filelock> doesn't support OFD
locking.

/Lukko/ means lock in Finnish.

Submodules "Lukko.OFD", "Lukko.Windows" etc are available based on following
conditions.

' if os(windows) cpp-options: -DHAS_WINDOWS_LOCK

elif (os(linux) && flag(ofd-locking)) cpp-options: -DHAS_OFD_LOCKING
cpp-options: -DHAS_FLOCK

elif !(os(solaris) || os(aix)) cpp-options: -DHAS_FLOCK '

"Lukko.FLock" is available on not (Windows or Solaris or AIX).
"Lukko.NoOp" is always available.


Koji scratch build: https://koji.fedoraproject.org/koji/taskinfo?taskID=45968014

Comment 1 Jens Petersen 2020-06-22 03:25:42 UTC
This is needed by ghc-hackage-security for F33

Comment 2 Robert-André Mauchin 🐧 2020-06-29 19:44:54 UTC
 - Please fix the License field:

License:        GPL20orlaterANDBSD3Clause


Package approved. Please fix the aforementioned issue before import.


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]: 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: "Unknown or generated", "GPL (v3 or later)", "GNU Lesser
     General Public License", "BSD 2-clause "Simplified" License". 16 files
     have unknown license. Detailed output of licensecheck in
     /home/bob/packaging/review/ghc-lukko/review-ghc-lukko/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[x]: Package does not own files or directories owned by other packages.
     Note: Dirs in package are owned also by: /usr/share/doc/ghc(ghc-
     EdisonAPI-doc, ghc-cborg-doc, ghc-uri-encode-doc, ghc-time-manager-
     doc, ghc-http2-doc, ghc-murmur-hash-doc, ghc-EdisonCore-doc, ghc-
     geniplate-mirror-doc, ghc-aeson-better-errors-doc, ghc-Agda-doc, ghc-
     compiler, ghc-dns-doc, ghc-parsers-doc), /usr/share/doc/ghc/html(ghc-
     EdisonAPI-doc, ghc-cborg-doc, ghc-uri-encode-doc, ghc-time-manager-
     doc, ghc-http2-doc, ghc-murmur-hash-doc, ghc-EdisonCore-doc, ghc-
     geniplate-mirror-doc, ghc-aeson-better-errors-doc, ghc-Agda-doc, ghc-
     compiler, ghc-dns-doc, ghc-parsers-doc),
     /usr/share/doc/ghc/html/libraries(ghc-EdisonAPI-doc, ghc-cborg-doc,
     ghc-uri-encode-doc, ghc-time-manager-doc, ghc-http2-doc, ghc-murmur-
     hash-doc, ghc-EdisonCore-doc, ghc-geniplate-mirror-doc, ghc-aeson-
     better-errors-doc, ghc-Agda-doc, ghc-compiler, ghc-dns-doc, ghc-
     parsers-doc)
[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.
[x]: 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]: 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 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).
[?]: 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]: Fully versioned dependency in subpackages if applicable.
[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: ghc-lukko-0.1.1.2-1.fc33.x86_64.rpm
          ghc-lukko-devel-0.1.1.2-1.fc33.x86_64.rpm
          ghc-lukko-0.1.1.2-1.fc33.src.rpm
ghc-lukko.x86_64: W: spelling-error %description -l en_US https -> HTTP
ghc-lukko.x86_64: W: spelling-error %description -l en_US www -> WWW, wow
ghc-lukko.x86_64: W: spelling-error %description -l en_US html -> HTML
ghc-lukko.x86_64: W: spelling-error %description -l en_US FLock -> F Lock, Flock, Frock
ghc-lukko.x86_64: W: spelling-error %description -l en_US microsoft -> Microsoft, micro soft, micro-soft
ghc-lukko.x86_64: W: spelling-error %description -l en_US api -> API, pi, ape
ghc-lukko.x86_64: W: spelling-error %description -l en_US fileapi -> fleapit
ghc-lukko.x86_64: W: spelling-error %description -l en_US nf -> NF, bf, n
ghc-lukko.x86_64: W: spelling-error %description -l en_US lockfilee -> kilocycle
ghc-lukko.x86_64: W: spelling-error %description -l en_US NoOp -> No Op, Snoop, Noon
ghc-lukko.x86_64: W: spelling-error %description -l en_US intra -> intro, infra, intranet
ghc-lukko.x86_64: W: spelling-error %description -l en_US hackage -> package, hack age, hack-age
ghc-lukko.x86_64: W: spelling-error %description -l en_US haskell -> Haskell, seashell
ghc-lukko.x86_64: W: spelling-error %description -l en_US filelock -> file lock, file-lock, forelock
ghc-lukko.x86_64: W: spelling-error %description -l en_US Submodules -> Sub modules, Sub-modules, Modules
ghc-lukko.x86_64: W: spelling-error %description -l en_US os -> OS, och, so
ghc-lukko.x86_64: W: spelling-error %description -l en_US cpp -> cop, pp, cps
ghc-lukko.x86_64: W: spelling-error %description -l en_US elif -> elf, lief, life
ghc-lukko.x86_64: W: spelling-error %description -l en_US ofd -> odd, off, of
ghc-lukko.x86_64: W: spelling-error %description -l en_US solaris -> solaria, Polaris, solar is
ghc-lukko.x86_64: W: spelling-error %description -l en_US aix -> six, aux, ax
ghc-lukko.x86_64: E: description-line-too-long C <https://www.gnu.org/software/libc/manual/html_node/Open-File-Description-Locks.html
ghc-lukko.x86_64: W: invalid-license GPL20orlaterANDBSD3Clause
ghc-lukko.x86_64: W: no-documentation
ghc-lukko-devel.x86_64: W: invalid-license GPL20orlaterANDBSD3Clause
ghc-lukko.src: W: spelling-error %description -l en_US https -> HTTP
ghc-lukko.src: W: spelling-error %description -l en_US www -> WWW, wow
ghc-lukko.src: W: spelling-error %description -l en_US html -> HTML
ghc-lukko.src: W: spelling-error %description -l en_US FLock -> F Lock, Flock, Frock
ghc-lukko.src: W: spelling-error %description -l en_US microsoft -> Microsoft, micro soft, micro-soft
ghc-lukko.src: W: spelling-error %description -l en_US api -> API, pi, ape
ghc-lukko.src: W: spelling-error %description -l en_US fileapi -> fleapit
ghc-lukko.src: W: spelling-error %description -l en_US nf -> NF, bf, n
ghc-lukko.src: W: spelling-error %description -l en_US lockfilee -> kilocycle
ghc-lukko.src: W: spelling-error %description -l en_US NoOp -> No Op, Snoop, Noon
ghc-lukko.src: W: spelling-error %description -l en_US intra -> intro, infra, intranet
ghc-lukko.src: W: spelling-error %description -l en_US hackage -> package, hack age, hack-age
ghc-lukko.src: W: spelling-error %description -l en_US haskell -> Haskell, seashell
ghc-lukko.src: W: spelling-error %description -l en_US filelock -> file lock, file-lock, forelock
ghc-lukko.src: W: spelling-error %description -l en_US Submodules -> Sub modules, Sub-modules, Modules
ghc-lukko.src: W: spelling-error %description -l en_US os -> OS, och, so
ghc-lukko.src: W: spelling-error %description -l en_US cpp -> cop, pp, cps
ghc-lukko.src: W: spelling-error %description -l en_US elif -> elf, lief, life
ghc-lukko.src: W: spelling-error %description -l en_US ofd -> odd, off, of
ghc-lukko.src: W: spelling-error %description -l en_US solaris -> solaria, Polaris, solar is
ghc-lukko.src: W: spelling-error %description -l en_US aix -> six, aux, ax
ghc-lukko.src: E: description-line-too-long C <https://www.gnu.org/software/libc/manual/html_node/Open-File-Description-Locks.html
ghc-lukko.src: W: invalid-license GPL20orlaterANDBSD3Clause
3 packages and 0 specfiles checked; 2 errors, 46 warnings.

Comment 3 Jens Petersen 2020-06-30 02:59:42 UTC
Thank you for the review

https://pagure.io/releng/fedora-scm-requests/issue/26670

Comment 4 Gwyn Ciesla 2020-06-30 15:10:28 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/ghc-lukko

Comment 5 Jens Petersen 2020-07-01 05:09:08 UTC
I am updating the License field to: GPLv2+ and BSD

Thanks, I need to update cabal-rpm to handle the newer license tagging in Cabal 2.2+ I think.

Comment 6 Jens Petersen 2020-08-23 07:01:38 UTC
Sorry for keeping this and some earlier reviews in Modified for an extended time: I may still backport some of them to f32 later, thanks!


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