Bug 2101964 - Review Request: ocaml-pp - Pretty printing library for OCaml
Summary: Review Request: ocaml-pp - Pretty printing library for OCaml
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Richard W.M. Jones
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-06-28 22:19 UTC by Jerry James
Modified: 2022-07-04 17:04 UTC (History)
2 users (show)

Fixed In Version: ocaml-pp-1.1.2-2.fc37
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-07-04 17:04:48 UTC
Type: ---
Embargoed:
rjones: fedora-review+


Attachments (Terms of Use)

Description Jerry James 2022-06-28 22:19:21 UTC
Spec URL: https://jjames.fedorapeople.org/ocaml-pp/ocaml-pp.spec
SRPM URL: https://jjames.fedorapeople.org/ocaml-pp/ocaml-pp-1.1.2-1.fc37.src.rpm
Fedora Account System Username: jjames
Description: This library provides a lean alternative to the Format [1] module of the OCaml standard library.  It aims to make it easy for users to do the right thing.  If you have tried Format before but find its API complicated and difficult to use, then Pp might be a good choice for you.

Pp uses the same concepts of boxes and break hints, and the final rendering is done to formatter from the Format module.  However it defines its own algebra which some might find easier to work with and reason about.  No previous knowledge is required to start using this library, however the various guides for the Format module such as this one [2] should be applicable to Pp as well.

[1]: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Format.html
[2]: https://caml.inria.fr/resources/doc/guides/format.en.html

Comment 1 Richard W.M. Jones 2022-06-28 22:58:31 UTC
It compiles for me, and I'm running fedora-review now, but...

I wonder if -- because dune is a regular binary -- if we can just depend on
a non-specific version of dune so we don't have to do such invasive changes
to builds.

Comment 2 Jerry James 2022-06-28 23:28:49 UTC
Okay, as long as the main dune package contains only the dune binary, I can see how that would work.  When a new version of OCaml is released, for example, we could build ocaml-csexp and ocaml-pp with the old version of dune, then build a new version of dune.  Currently, the main package contains more than just the dune binary, but I plan to change that along with the upgrade to 3.x.

Would you like me to strip out all the manual stuff and give you a new version?

Comment 3 Richard W.M. Jones 2022-06-29 09:10:36 UTC
(In reply to Jerry James from comment #2)
> Okay, as long as the main dune package contains only the dune binary, I can
> see how that would work.  When a new version of OCaml is released, for
> example, we could build ocaml-csexp and ocaml-pp with the old version of
> dune, then build a new version of dune.  Currently, the main package
> contains more than just the dune binary, but I plan to change that along
> with the upgrade to 3.x.
> 
> Would you like me to strip out all the manual stuff and give you a new
> version?

If this would work, I definitely think it'd be better.

Comment 4 Jerry James 2022-06-30 19:49:28 UTC
Sorry for the delay.  Here it is without all the build-without-dune parts.  This means when you do a mass rebuild, you'll have to remove the dependency on dune from ocaml-csexp and ocaml-pp when computing the build order.

Spec URL: https://jjames.fedorapeople.org/ocaml-pp/ocaml-pp.spec
SRPM URL: https://jjames.fedorapeople.org/ocaml-pp/ocaml-pp-1.1.2-2.fc37.src.rpm

Comment 5 Richard W.M. Jones 2022-06-30 20:47:52 UTC
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++/

RWMJ: I don't think this is applicable because the application
is not C/C++


===== MUST items =====

C/C++:
[x]: Package does not contain kernel modules.
[-]: Package contains no static executables.
[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", "MIT License", "*No copyright* MIT
     License [generated file]". 10 files have unknown license. Detailed
     output of licensecheck in /var/tmp/2101964-ocaml-pp/licensecheck.txt

RWMJ: I checked upstream and it's MIT.

[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
[-]: 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.
[-]: 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 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 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

Ocaml:
[x]: This should never happen

RWMJ: Ignore this, bug in rpmlint.

===== 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.

RWMJ: No signatures appear upstream as far as I can tell.

[x]: Package should compile and build into binary rpms on all supported
     architectures.
[-]: %check is present and all tests pass.
[ ]: 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 debuginfo package(s).
     Note: There are rpmlint messages (see attachment).
[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
-------
Cannot parse rpmlint output:


Rpmlint (debuginfo)
-------------------
Cannot parse rpmlint output:



Rpmlint (installed packages)
----------------------------
Cannot parse rpmlint output:

RWMJ: Not sure what's wrong with rpmlint, but I manually checked
the spec file myself.


Source checksums
----------------
https://github.com/ocaml-dune/pp/releases/download/1.1.2/pp-1.1.2.tbz :
  CHECKSUM(SHA256) this package     : e4a4e98d96b1bb76950fcd6da4e938c86d989df4d7e48f02f7a44595f5af1d56
  CHECKSUM(SHA256) upstream package : e4a4e98d96b1bb76950fcd6da4e938c86d989df4d7e48f02f7a44595f5af1d56


Requires
--------
ocaml-pp (rpmlib, GLIBC filtered):
    ocaml(CamlinternalFormatBasics)
    ocaml(Stdlib)
    ocaml(Stdlib__Buffer)
    ocaml(Stdlib__Either)
    ocaml(Stdlib__Format)
    ocaml(Stdlib__ListLabels)
    ocaml(Stdlib__Printf)
    ocaml(Stdlib__Seq)
    ocaml(Stdlib__Uchar)
    rtld(GNU_HASH)

ocaml-pp-devel (rpmlib, GLIBC filtered):
    ocaml(CamlinternalFormatBasics)
    ocaml(Stdlib)
    ocaml(Stdlib__Buffer)
    ocaml(Stdlib__Either)
    ocaml(Stdlib__Format)
    ocaml(Stdlib__ListLabels)
    ocaml(Stdlib__Printf)
    ocaml(Stdlib__Seq)
    ocaml(Stdlib__Uchar)
    ocaml-pp(x86-64)
    ocamlx(Stdlib)
    ocamlx(Stdlib__Format)
    ocamlx(Stdlib__ListLabels)
    ocamlx(Stdlib__Printf)

ocaml-pp-debuginfo (rpmlib, GLIBC filtered):

ocaml-pp-debugsource (rpmlib, GLIBC filtered):



Provides
--------
ocaml-pp:
    ocaml(Pp)
    ocaml-pp
    ocaml-pp(x86-64)

ocaml-pp-devel:
    ocaml(Pp)
    ocaml-pp-devel
    ocaml-pp-devel(x86-64)
    ocamlx(Pp)

ocaml-pp-debuginfo:
    debuginfo(build-id)
    ocaml-pp-debuginfo
    ocaml-pp-debuginfo(x86-64)

ocaml-pp-debugsource:
    ocaml-pp-debugsource
    ocaml-pp-debugsource(x86-64)



Generated by fedora-review 0.8.0 (e988316) last change: 2022-04-07
Command line :/usr/bin/fedora-review -b 2101964
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Generic, Ocaml, C/C++
Disabled plugins: fonts, SugarActivity, R, PHP, Haskell, Java, Perl, Python
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 6 Richard W.M. Jones 2022-06-30 20:48:40 UTC
*********************************************
This package is APPROVED for Fedora by rjones
*********************************************

Comment 7 Jerry James 2022-06-30 21:37:50 UTC
Thank you!  I will update ocaml-dune as soon as this package is built.

(In reply to Richard W.M. Jones from comment #5)
> Rpmlint
> -------
> Cannot parse rpmlint output:
> 
> 
> Rpmlint (debuginfo)
> -------------------
> Cannot parse rpmlint output:
> 
> 
> 
> Rpmlint (installed packages)
> ----------------------------
> Cannot parse rpmlint output:
> 
> RWMJ: Not sure what's wrong with rpmlint, but I manually checked
> the spec file myself.

The issue is that rpmlint command line options and output changed with the introduction of rpmlint 2.x, and nobody has gotten around to fixing fedora-review.  See https://pagure.io/FedoraReview/issue/425.

Comment 8 Kevin Fenzi 2022-07-03 18:14:04 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/ocaml-pp

Comment 9 Jerry James 2022-07-04 17:04:48 UTC
Built in Rawhide.  A dune update will follow shortly.


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