Bug 1875389 - Review Request: ormolu - A formatter for Haskell source code
Summary: Review Request: ormolu - A formatter for Haskell source code
Keywords:
Status: CLOSED ERRATA
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: 2020-09-03 12:52 UTC by Jens Petersen
Modified: 2020-10-23 22:03 UTC (History)
2 users (show)

Fixed In Version: ormolu-0.1.2.0-1.fc34
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-10-23 22:03:14 UTC
Type: ---
Embargoed:
zebob.m: fedora-review+


Attachments (Terms of Use)

Description Jens Petersen 2020-09-03 12:52:54 UTC
Spec URL: https://petersen.fedorapeople.org/reviews/ormolu/ormolu.spec
SRPM URL: https://petersen.fedorapeople.org/reviews/ormolu/ormolu-0.1.2.0-1.fc33.src.rpm

Description:
Ormolu is a formatter for Haskell source code.
The project was created with the following goals in mind:

- Using GHC's own parser to avoid parsing problems caused by haskell-src-exts.

- Let some whitespace be programmable. The layout of the input
  influences the layout choices in the output. This means that the
  choices between single-line/multi-line layouts in each particular
  situation are made by the user, not by an algorithm. This makes the
  implementation simpler and leaves some control to the user while
  still guaranteeing that the formatted code is stylistically
  consistent.

- Writing code in such a way so it's easy to modify and maintain.

- Implementing one âtrueâ formatting style which admits no configuration.

- That formatting style aims to result in minimal diffs while still
  remaining very close to âconventionalâ Haskell formatting people
  use.

- Choose a style compatible with modern dialects of Haskell. As new
  Haskell extensions enter broad use, we may change the style to
  accomodate them.

- Idempotence: formatting already formatted code doesn't change it.

- Be well-tested and robust to the point that it can be used in large
  projects without exposing unfortunate, disappointing bugs here and
  there.


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

Comment 1 Robert-André Mauchin 🐧 2020-09-03 14:14:31 UTC
spelling-error %description -l en_US accomodate -> accommodate

Package approved, please fix the spelling 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.
[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". 762 files have unknown license. Detailed output of
     licensecheck in /home/bob/packaging/review/ormolu/review-
     ormolu/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[x]: Package does not own files or directories owned by other packages.
[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.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 30720 bytes in 3 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).
[x]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in ormolu-
     common , ghc-ormolu
[?]: 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.
[x]: %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: ormolu-0.1.2.0-1.fc34.x86_64.rpm
          ormolu-common-0.1.2.0-1.fc34.noarch.rpm
          ghc-ormolu-0.1.2.0-1.fc34.x86_64.rpm
          ghc-ormolu-devel-0.1.2.0-1.fc34.x86_64.rpm
          ormolu-0.1.2.0-1.fc34.src.rpm
ormolu.x86_64: W: spelling-error Summary(en_US) formatter -> formatted, for matter, for-matter
ormolu.x86_64: W: spelling-error %description -l en_US formatter -> formatted, for matter, for-matter
ormolu.x86_64: W: spelling-error %description -l en_US haskell -> Haskell, seashell
ormolu.x86_64: W: spelling-error %description -l en_US src -> arc, sec, sic
ormolu.x86_64: W: spelling-error %description -l en_US exts -> ext, exits, texts
ormolu.x86_64: W: spelling-error %description -l en_US whitespace -> white space, white-space, whites pace
ormolu.x86_64: W: spelling-error %description -l en_US accomodate -> accommodate, accommodation
ormolu.x86_64: W: no-documentation
ormolu.x86_64: W: no-manual-page-for-binary ormolu
ormolu-common.noarch: W: summary-not-capitalized C ormolu common files
ormolu-common.noarch: E: non-executable-script /usr/share/ormolu-0.1.2.0/data/examples/module-header/double-shebangs-out.hs 644 /usr/bin/env stack
ormolu-common.noarch: E: non-executable-script /usr/share/ormolu-0.1.2.0/data/examples/module-header/double-shebangs.hs 644 /usr/bin/env stack
ormolu-common.noarch: E: zero-length /usr/share/ormolu-0.1.2.0/data/examples/module-header/empty-out.hs
ormolu-common.noarch: E: zero-length /usr/share/ormolu-0.1.2.0/data/examples/module-header/empty.hs
ormolu-common.noarch: E: non-executable-script /usr/share/ormolu-0.1.2.0/data/examples/module-header/shebang-out.hs 644 /usr/bin/env runhaskell
ormolu-common.noarch: E: non-executable-script /usr/share/ormolu-0.1.2.0/data/examples/module-header/shebang-with-pragmas-out.hs 644 /usr/bin/env stack
ormolu-common.noarch: E: non-executable-script /usr/share/ormolu-0.1.2.0/data/examples/module-header/shebang-with-pragmas.hs 644 /usr/bin/env stack
ormolu-common.noarch: E: non-executable-script /usr/share/ormolu-0.1.2.0/data/examples/module-header/shebang.hs 644 /usr/bin/env runhaskell
ormolu-common.noarch: E: non-executable-script /usr/share/ormolu-0.1.2.0/data/examples/module-header/stack-header-1-out.hs 644 /usr/bin/env stack
ormolu-common.noarch: E: non-executable-script /usr/share/ormolu-0.1.2.0/data/examples/module-header/stack-header-1.hs 644 /usr/bin/env stack
ormolu-common.noarch: E: non-executable-script /usr/share/ormolu-0.1.2.0/data/examples/module-header/stack-header-2-out.hs 644 /usr/bin/env stack
ormolu-common.noarch: E: non-executable-script /usr/share/ormolu-0.1.2.0/data/examples/module-header/stack-header-2.hs 644 /usr/bin/env stack
ghc-ormolu.x86_64: W: library-not-linked-against-libc /usr/lib64/libHSormolu-0.1.2.0-GACJSQkvqQL2522lsI5HcQ-ghc8.8.4.so
ghc-ormolu.x86_64: W: no-documentation
ghc-ormolu-devel.x86_64: W: no-documentation
ormolu.src: W: spelling-error Summary(en_US) formatter -> formatted, for matter, for-matter
ormolu.src: W: spelling-error %description -l en_US formatter -> formatted, for matter, for-matter
ormolu.src: W: spelling-error %description -l en_US haskell -> Haskell, seashell
ormolu.src: W: spelling-error %description -l en_US src -> arc, sec, sic
ormolu.src: W: spelling-error %description -l en_US exts -> ext, exits, texts
ormolu.src: W: spelling-error %description -l en_US whitespace -> white space, white-space, whites pace
ormolu.src: W: spelling-error %description -l en_US accomodate -> accommodate, accommodation
5 packages and 0 specfiles checked; 12 errors, 20 warnings.

Comment 2 Jens Petersen 2020-09-03 14:36:53 UTC
Thank you for the review

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

Comment 3 Gwyn Ciesla 2020-09-03 16:14:00 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/ormolu

Comment 4 Jens Petersen 2020-09-04 02:43:46 UTC
Thanks for this review, Robert-André 🐧

> spelling-error %description -l en_US accomodate -> accommodate

Good catch!

I opened https://github.com/tweag/ormolu/pull/647

Comment 5 Jens Petersen 2020-09-09 15:37:08 UTC
Thanks again for the review.

(In reply to Jens Petersen from comment #0)
> - Implementing one âtrueâ formatting style which admits no configuration.
:
>   remaining very close to âconventionalâ Haskell formatting people use.

I spent some time debugging and fixing this ^^ fbrnch encoding issue.
The above should be quotes like: “this”.

Comment 6 Jens Petersen 2020-09-09 16:52:13 UTC
(`bugzilla query -b 1875389 --full` (and `fbnrch import`) both don't display
the full description of this bug in gnome-terminal (vte):
they stop early with "Implementing one âtrueâconventionalâ".
Though Emacs shell just outputs the broken encoding okay.
So I guess there is nothing more left for me to do
having fixed the encoding now in fbrnch,
hopefully this kind of thing won't happen too much.)

Comment 7 Fedora Update System 2020-10-03 20:58:18 UTC
FEDORA-2020-211038ee34 has been submitted as an update to Fedora 33. https://bodhi.fedoraproject.org/updates/FEDORA-2020-211038ee34

Comment 8 Fedora Update System 2020-10-04 02:16:11 UTC
FEDORA-2020-211038ee34 has been pushed to the Fedora 33 testing repository.
In short time you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2020-211038ee34 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2020-211038ee34

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

Comment 9 Jens Petersen 2020-10-09 11:16:09 UTC
test message: f32 is too old really for ormolu

Comment 10 Fedora Update System 2020-10-23 22:03:14 UTC
FEDORA-2020-211038ee34 has been pushed to the Fedora 33 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.