Bug 2166239 - Review Request: ghc-fmt - A new formatting library
Summary: Review Request: ghc-fmt - A new formatting library
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Elliott Sales de Andrade
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-02-01 09:28 UTC by Jens Petersen
Modified: 2023-04-20 02:53 UTC (History)
2 users (show)

Fixed In Version: ghc-fmt-0.6.3.0-1.fc39
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-04-19 01:38:31 UTC
Type: ---
Embargoed:
quantum.analyst: fedora-review+


Attachments (Terms of Use)

Description Jens Petersen 2023-02-01 09:28:50 UTC
Spec URL: https://petersen.fedorapeople.org/reviews/ghc-fmt/ghc-fmt.spec
SRPM URL: https://petersen.fedorapeople.org/reviews/ghc-fmt/ghc-fmt-0.6.3.0-1.fc38.src.rpm

Description:
A new formatting library that tries to be simple to understand while still
being powerful and providing more convenience features than other libraries
(like functions for pretty-printing maps and lists, or a function for printing
arbitrary datatypes using generics).

A comparison with other libraries:

* 'printf' (from 'Text.Printf') takes a formatting string and uses some type
tricks to accept the rest of the arguments polyvariadically. It's very concise,
but there are some drawbacks – it can't produce 'Text' (you'd have to 'T.pack'
it every time) and it doesn't warn you at compile-time if you pass wrong
arguments or not enough of them.

* <https://hackage.haskell.org/package/text-format text-format> takes a
formatting string with curly braces denoting places where arguments would be
substituted (the arguments themselves are provided via a tuple). If you want to
apply formatting to some of the arguments, you have to use one of the provided
formatters. Like 'printf', it can fail at runtime, but at least the formatters
are first-class (and you can add new ones).

* <https://hackage.haskell.org/package/formatting formatting> takes a
formatting template consisting of pieces of strings interleaved with
formatters; this ensures that arguments always match their placeholders.
'formatting' provides lots of formatters and generally seems to be the most
popular formatting library here. Unfortunately, at least in my experience
writing new formatters can be awkward and people sometimes have troubles
understanding how 'formatting' works.

* <https://hackage.haskell.org/package/fmt fmt> (i.e. this library) provides
formatters that are ordinary functions, and a bunch of operators for
concatenating formatted strings; those operators also do automatic conversion.
There are some convenience formatters which aren't present in 'formatting'
(like ones for formatting maps, lists, converting to base64, etc).
Some find the operator syntax annoying, while others like it.


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

Comment 1 Jakub Kadlčík 2023-02-01 09:43:48 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/5386192
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2166239-ghc-fmt/fedora-rawhide-x86_64/05386192-ghc-fmt/fedora-review/review.txt

Please take a look if any issues were found.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

Comment 2 Elliott Sales de Andrade 2023-04-09 20:53:11 UTC
Everything looks good to me.

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

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


Issues:
=======
- If your application is a C or C++ application you must list a
  BuildRequires against gcc, gcc-c++ or clang.
  Note: No gcc, gcc-c++ or clang found in BuildRequires
  See: https://docs.fedoraproject.org/en-US/packaging-guidelines/C_and_C++/


===== 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 successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
     Note: Using prebuilt packages
[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 License". 16 files have
     unknown license. Detailed output of licensecheck in /var/lib/copr-
     rpmbuild/results/ghc-fmt/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.
[?]: 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 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 must own all directories that it creates.
[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 must not depend on deprecated() packages.
[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]: Reviewer should test that the package builds in mock.
[-]: 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.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[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.


Rpmlint
-------
Checking: ghc-fmt-0.6.3.0-1.fc38.x86_64.rpm
          ghc-fmt-devel-0.6.3.0-1.fc38.x86_64.rpm
          ghc-fmt-0.6.3.0-1.fc38.src.rpm
============================ rpmlint session starts ============================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.11/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmpszwn814z')]
checks: 31, packages: 3

ghc-fmt-devel.x86_64: E: static-library-without-debuginfo /usr/lib64/ghc-8.10.7/fmt-0.6.3.0/libHSfmt-0.6.3.0-5xqDBlXV4Ss9bKXtavqFsI.a
ghc-fmt.x86_64: W: no-documentation
 3 packages and 0 specfiles checked; 1 errors, 1 warnings, 1 badness; has taken 0.2 s 




Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.11/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 31, packages: 2

ghc-fmt.x86_64: W: no-documentation
 2 packages and 0 specfiles checked; 988 errors, 1 warnings, 988 badness; has taken 0.4 s 



Unversioned so-files
--------------------
ghc-fmt: /usr/lib64/libHSfmt-0.6.3.0-5xqDBlXV4Ss9bKXtavqFsI-ghc8.10.7.so

Source checksums
----------------
https://hackage.haskell.org/package/fmt-0.6.3.0/fmt-0.6.3.0.tar.gz :
  CHECKSUM(SHA256) this package     : b4ee7f3da97223bfef589264e7945160521f6e3323f64a2118bdec96cc04b006
  CHECKSUM(SHA256) upstream package : b4ee7f3da97223bfef589264e7945160521f6e3323f64a2118bdec96cc04b006


Requires
--------
ghc-fmt (rpmlib, GLIBC filtered):
    libHSarray-0.5.4.0-ghc8.10.7.so()(64bit)
    libHSbase-4.14.3.0-ghc8.10.7.so()(64bit)
    libHSbase64-bytestring-1.1.0.0-HDz0kgl0nD2AMCL7uo2RNp-ghc8.10.7.so()(64bit)
    libHSbinary-0.8.8.0-ghc8.10.7.so()(64bit)
    libHSbytestring-0.10.12.0-ghc8.10.7.so()(64bit)
    libHScall-stack-0.3.0-7pVkO7EyIfwF2lorHgBZ1Z-ghc8.10.7.so()(64bit)
    libHSclock-0.8.3-5ajb7pp5ltmEUbggHblS9Q-ghc8.10.7.so()(64bit)
    libHScontainers-0.6.5.1-ghc8.10.7.so()(64bit)
    libHSdeepseq-1.4.4.0-ghc8.10.7.so()(64bit)
    libHSdouble-conversion-2.0.2.0-F8qz3JH2RsdCzB2ljJtxLK-ghc8.10.7.so()(64bit)
    libHSformatting-7.1.3-2qxAJPn34Tm5ozoYI7c9Nq-ghc8.10.7.so()(64bit)
    libHSghc-boot-th-8.10.7-ghc8.10.7.so()(64bit)
    libHSghc-prim-0.6.1-ghc8.10.7.so()(64bit)
    libHShashable-1.3.0.0-DKy9JIeMjEpEMnRxDSJKj1-ghc8.10.7.so()(64bit)
    libHSinteger-gmp-1.0.3.0-ghc8.10.7.so()(64bit)
    libHSinteger-logarithms-1.0.3.1-xsL5hmMYGlG65gkrXlNN-ghc8.10.7.so()(64bit)
    libHSmicrolens-0.4.12.0-6q3HVIwdclfLIBOL1IZ85G-ghc8.10.7.so()(64bit)
    libHSold-locale-1.0.0.7-Imy8BjOomMC1ZfvTA3Dz4y-ghc8.10.7.so()(64bit)
    libHSpretty-1.1.3.6-ghc8.10.7.so()(64bit)
    libHSprimitive-0.7.3.0-HMedJdQUTCQ79SiIUfisnA-ghc8.10.7.so()(64bit)
    libHSscientific-0.3.7.0-9Bte1MPl0IRAgeMv2NYBdP-ghc8.10.7.so()(64bit)
    libHStemplate-haskell-2.16.0.0-ghc8.10.7.so()(64bit)
    libHStext-1.2.4.1-ghc8.10.7.so()(64bit)
    libHStime-1.9.3-ghc8.10.7.so()(64bit)
    libHStime-locale-compat-0.1.1.5-GsWV22hAlr5GYW86kJj1ex-ghc8.10.7.so()(64bit)
    libHStransformers-0.5.6.2-ghc8.10.7.so()(64bit)
    libc.so.6()(64bit)
    libdouble-conversion.so.3()(64bit)
    libgmp.so.10()(64bit)
    libm.so.6()(64bit)
    libstdc++.so.6()(64bit)
    rtld(GNU_HASH)

ghc-fmt-devel (rpmlib, GLIBC filtered):
    ghc-compiler
    ghc-devel(base-4.14.3.0)
    ghc-devel(base64-bytestring-1.1.0.0-HDz0kgl0nD2AMCL7uo2RNp)
    ghc-devel(bytestring-0.10.12.0)
    ghc-devel(call-stack-0.3.0-7pVkO7EyIfwF2lorHgBZ1Z)
    ghc-devel(containers-0.6.5.1)
    ghc-devel(formatting-7.1.3-2qxAJPn34Tm5ozoYI7c9Nq)
    ghc-devel(microlens-0.4.12.0-6q3HVIwdclfLIBOL1IZ85G)
    ghc-devel(text-1.2.4.1)
    ghc-devel(time-1.9.3)
    ghc-devel(time-locale-compat-0.1.1.5-GsWV22hAlr5GYW86kJj1ex)
    ghc-fmt(x86-64)



Provides
--------
ghc-fmt:
    ghc-fmt
    ghc-fmt(x86-64)
    libHSfmt-0.6.3.0-5xqDBlXV4Ss9bKXtavqFsI-ghc8.10.7.so()(64bit)

ghc-fmt-devel:
    ghc-devel(fmt-0.6.3.0-5xqDBlXV4Ss9bKXtavqFsI)
    ghc-fmt-devel
    ghc-fmt-devel(x86-64)
    ghc-fmt-static
    ghc-fmt-static(x86-64)



Generated by fedora-review 0.9.0 (6761b6c) last change: 2022-08-23
Command line :/usr/bin/fedora-review --no-colors --prebuilt --rpm-spec --name ghc-fmt --mock-config /var/lib/copr-rpmbuild/results/configs/child.cfg
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Generic, Haskell, C/C++
Disabled plugins: Python, R, Ocaml, SugarActivity, Perl, PHP, Java, fonts
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 3 Jens Petersen 2023-04-11 04:39:51 UTC
Thank you for the review, Elliott

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

Comment 4 Fedora Admin user for bugzilla script actions 2023-04-11 04:39:54 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/ghc-fmt

Comment 5 Fedora Update System 2023-04-11 06:42:35 UTC
FEDORA-2023-f81da0100b has been submitted as an update to Fedora 38. https://bodhi.fedoraproject.org/updates/FEDORA-2023-f81da0100b

Comment 6 Fedora Update System 2023-04-11 06:57:58 UTC
FEDORA-2023-f992d5e7b6 has been submitted as an update to Fedora 37. https://bodhi.fedoraproject.org/updates/FEDORA-2023-f992d5e7b6

Comment 7 Fedora Update System 2023-04-11 22:14:28 UTC
FEDORA-2023-f81da0100b has been pushed to the Fedora 38 testing repository.

You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2023-f81da0100b

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 8 Fedora Update System 2023-04-12 02:42:39 UTC
FEDORA-2023-f992d5e7b6 has been pushed to the Fedora 37 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --refresh --advisory=FEDORA-2023-f992d5e7b6 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2023-f992d5e7b6

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 9 Fedora Update System 2023-04-19 01:38:31 UTC
FEDORA-2023-f81da0100b has been pushed to the Fedora 38 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 10 Fedora Update System 2023-04-20 02:53:11 UTC
FEDORA-2023-f992d5e7b6 has been pushed to the Fedora 37 stable repository.
If problem still persists, please make note of it in this bug report.


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