Bug 1937455 - Review Request: ocaml-caml-mode - Emacs mode for editing OCaml source code
Summary: Review Request: ocaml-caml-mode - Emacs mode for editing OCaml source code
Keywords:
Status: CLOSED ERRATA
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: 2021-03-10 16:56 UTC by Jerry James
Modified: 2021-03-31 00:16 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-03-31 00:16:17 UTC
Type: ---
Embargoed:
rjones: fedora-review+


Attachments (Terms of Use)

Description Jerry James 2021-03-10 16:56:15 UTC
Spec URL: https://jjames.fedorapeople.org/ocaml-caml-mode/ocaml-caml-mode.spec
SRPM URL: https://jjames.fedorapeople.org/ocaml-caml-mode/ocaml-caml-mode-4.06-1.fc35.src.rpm
Fedora Account System Username: jjames
Description: This package provides a caml-mode for Emacs, for editing OCaml programs, as well as an inferior-caml-mode, to run a toplevel.  Caml-mode supports indentation, compilation and error retrieving, and sending phrases to the toplevel.  There is also support for hilit, font-lock and imenu.

Comment 1 Robert-André Mauchin 🐧 2021-03-16 11:51:42 UTC
 - Own this directory:

[!]: Package requires other packages for directories it uses.
     Note: No known owner of /usr/share/emacs/site-lisp/caml-mode

 - Notify upstream about their use of an obsolete FSF address:

emacs-caml-mode.noarch: E: incorrect-fsf-address /usr/share/licenses/emacs-caml-mode/COPYING

 - Not sure about this one:

emacs-caml-mode.noarch: E: script-without-shebang /usr/bin/ocamltags

Generally we remove shebangs for python, but I don't know how Ocaml should be handled.




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

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



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

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", "GNU General Public License, Version
     2", "GNU General Public License", "GNU General Public License v2.0 or
     later", "GNU General Public License v1.0 or later". 5 files have
     unknown license. Detailed output of licensecheck in
     /home/bob/packaging/review/ocaml-caml-mode/review-ocaml-caml-
     mode/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[!]: Package requires other packages for directories it uses.
     Note: No known owner of /usr/share/emacs/site-lisp/caml-mode
[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.
[-]: 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 20480 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 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 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).
[-]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in emacs-
     caml-mode
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[-]: 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]: 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: ocaml-caml-mode-4.06-1.fc35.x86_64.rpm
          emacs-caml-mode-4.06-1.fc35.noarch.rpm
          ocaml-caml-mode-4.06-1.fc35.src.rpm
ocaml-caml-mode.x86_64: W: spelling-error Summary(en_US) Opam -> Spam, Opal, Op am
ocaml-caml-mode.x86_64: W: spelling-error %description -l en_US emacs -> Emacs, macs, maces
ocaml-caml-mode.x86_64: W: no-documentation
emacs-caml-mode.noarch: W: spelling-error %description -l en_US toplevel -> top level, top-level, topple
emacs-caml-mode.noarch: W: spelling-error %description -l en_US hilit -> hilt, hi lit, hi-lit
emacs-caml-mode.noarch: W: spelling-error %description -l en_US imenu -> menu, i menu, immense
emacs-caml-mode.noarch: E: script-without-shebang /usr/bin/ocamltags
emacs-caml-mode.noarch: E: incorrect-fsf-address /usr/share/licenses/emacs-caml-mode/COPYING
emacs-caml-mode.noarch: W: no-manual-page-for-binary ocamltags
ocaml-caml-mode.src: W: spelling-error Summary(en_US) Opam -> Spam, Opal, Op am
ocaml-caml-mode.src: W: spelling-error %description -l en_US opam -> spam, opal, Spam
3 packages and 0 specfiles checked; 2 errors, 9 warnings.

Comment 2 Jerry James 2021-03-23 01:43:48 UTC
Thank you again for the review!

(In reply to Robert-André Mauchin 🐧 from comment #1)
>  - Own this directory:
> 
> [!]: Package requires other packages for directories it uses.
>      Note: No known owner of /usr/share/emacs/site-lisp/caml-mode

Fixed.

>  - Notify upstream about their use of an obsolete FSF address:
> 
> emacs-caml-mode.noarch: E: incorrect-fsf-address
> /usr/share/licenses/emacs-caml-mode/COPYING

I will send them a pull request.

>  - Not sure about this one:
> 
> emacs-caml-mode.noarch: E: script-without-shebang /usr/bin/ocamltags
> 
> Generally we remove shebangs for python, but I don't know how Ocaml should
> be handled.

This is actually an Emacs script.  There is no shebang because Emacs has its own ideas about what should be on the first line of the file ... but it works anyway.  Try it!

Comment 3 Jerry James 2021-03-23 01:46:09 UTC
I forgot to mention that I reuploaded the spec and srpm files for all 3 of the reviews you commented on, so you can verify that I fixed the ownership issues if you wish.

Comment 4 Richard W.M. Jones 2021-03-26 14:39:01 UTC
So a first look at the package and the emacs packaging guidelines
(https://docs.fedoraproject.org/en-US/packaging-guidelines/Emacs/)

Name looks good.  xemacs is dead anyway these days.

Has a subpackage called "emacs-foo" (emacs-caml-mode) - good.

Lisp files in %{_emacs_sitelispdir}/caml-mode - good.
Startup file in %{_emacs_sitestartdir} - good.

Doesn't need a emacs-common-* subpackage - good.

It's a bit unclear, but it seems like it could be missing this?
Requires: emacs-filesystem >= %{_emacs_version}

However the guidelines themselves seem to conflict, because the
example only suggests using
Requires:   emacs(bin) >= %{_emacs_version}
(which this package does - good).
So maybe this is not a problem.

Does BR emacs - good.

Does bytecompilation using the suggested macros - good.

BuildArch: noarch - good.

Comment 5 Richard W.M. Jones 2021-03-26 14:45:42 UTC
Package Review
==============

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



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

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", "GNU General Public License, Version
     2", "GNU General Public License", "GNU General Public License v2.0 or
     later", "GNU General Public License v1.0 or later". 5 files have
     unknown license. Detailed output of licensecheck in
     /var/tmp/1937455-ocaml-caml-mode/licensecheck.txt

I checked licensecheck.txt and the files manually and it is fine.

[x]: License file installed when any subpackage combination is installed.

Yes - the emacs-foo package has the license file, and the opam package
depends on that.

[x]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib64/ocaml

I guess OK since /usr/lib64/ocaml should be owned by the ocaml compiler.

[-]: %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.
[-]: Development files must be in a -devel package
[-]: Package uses nothing in %doc for runtime.
[-]: 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.

There is a justifying comment in the spec file.

[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 20480 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 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:
[-]: 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).
[-]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in emacs-
     caml-mode

Not needed as far as I'm aware.

[ ]: Package functions as described.
[ ]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[-]: 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.
[-]: 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]: 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: ocaml-caml-mode-4.06-1.fc33.x86_64.rpm
          emacs-caml-mode-4.06-1.fc33.noarch.rpm
          ocaml-caml-mode-4.06-1.fc33.src.rpm
ocaml-caml-mode.x86_64: W: spelling-error Summary(en_US) Opam -> Spam, Opal, Op am
ocaml-caml-mode.x86_64: W: spelling-error %description -l en_US emacs -> Emacs, macs, maces
ocaml-caml-mode.x86_64: W: no-documentation
emacs-caml-mode.noarch: W: spelling-error %description -l en_US toplevel -> top level, top-level, topple
emacs-caml-mode.noarch: W: spelling-error %description -l en_US hilit -> hilt, hi lit, hi-lit
emacs-caml-mode.noarch: W: spelling-error %description -l en_US imenu -> menu, i menu, immense
emacs-caml-mode.noarch: E: script-without-shebang /usr/bin/ocamltags
emacs-caml-mode.noarch: E: incorrect-fsf-address /usr/share/licenses/emacs-caml-mode/COPYING

[!] I guess this is one you should fix upstream.

emacs-caml-mode.noarch: W: no-manual-page-for-binary ocamltags
ocaml-caml-mode.src: W: spelling-error Summary(en_US) Opam -> Spam, Opal, Op am
ocaml-caml-mode.src: W: spelling-error %description -l en_US opam -> spam, opal, Spam
3 packages and 0 specfiles checked; 2 errors, 9 warnings.




Rpmlint (installed packages)
----------------------------
ocaml-caml-mode.x86_64: W: spelling-error Summary(en_US) Opam -> Spam, Opal, Op am
ocaml-caml-mode.x86_64: W: spelling-error %description -l en_US emacs -> Emacs, macs, maces
ocaml-caml-mode.x86_64: W: invalid-url URL: https://github.com/ocaml/caml-mode <urlopen error [Errno -3] Temporary failure in name resolution>
ocaml-caml-mode.x86_64: W: no-documentation
emacs-caml-mode.noarch: W: spelling-error %description -l en_US toplevel -> top level, top-level, topple
emacs-caml-mode.noarch: W: spelling-error %description -l en_US hilit -> hilt, hi lit, hi-lit
emacs-caml-mode.noarch: W: spelling-error %description -l en_US imenu -> menu, i menu, immense
emacs-caml-mode.noarch: W: invalid-url URL: https://github.com/ocaml/caml-mode <urlopen error [Errno -3] Temporary failure in name resolution>
emacs-caml-mode.noarch: E: script-without-shebang /usr/bin/ocamltags
emacs-caml-mode.noarch: E: incorrect-fsf-address /usr/share/licenses/emacs-caml-mode/COPYING
emacs-caml-mode.noarch: W: no-manual-page-for-binary ocamltags
2 packages and 0 specfiles checked; 2 errors, 9 warnings.



Source checksums
----------------
https://github.com/ocaml/caml-mode/archive/38ebde12d3d529e6ef8078967997d32226e69e82/caml-mode-38ebde12d3d529e6ef8078967997d32226e69e82.tar.gz :
  CHECKSUM(SHA256) this package     : 5325aa43b8c2d6f5cead6e178bfce3406aa54b21fde808e22c00cf91cace9c40
  CHECKSUM(SHA256) upstream package : 5325aa43b8c2d6f5cead6e178bfce3406aa54b21fde808e22c00cf91cace9c40


Requires
--------
ocaml-caml-mode (rpmlib, GLIBC filtered):
    emacs-caml-mode

emacs-caml-mode (rpmlib, GLIBC filtered):
    emacs(bin)



Provides
--------
ocaml-caml-mode:
    ocaml-caml-mode
    ocaml-caml-mode(x86-64)

emacs-caml-mode:
    emacs-caml-mode



Generated by fedora-review 0.7.5 (5fa5b7e) last change: 2020-02-16
Command line :/usr/bin/fedora-review -b 1937455 --mock-config fedora-33-x86_64
Buildroot used: fedora-33-x86_64
Active plugins: Generic, Ocaml, Shell-api
Disabled plugins: R, Perl, Python, Java, SugarActivity, fonts, C/C++, PHP, Haskell
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 6 Richard W.M. Jones 2021-03-26 14:47:01 UTC
It would be nice to work with upstream to fix their out of date
COPYING file, however that does not block the package in Fedora.

=============
This package is APPROVED by rjones
=============

Comment 7 Jerry James 2021-03-26 15:12:30 UTC
(In reply to Richard W.M. Jones from comment #5)
> [x]: Package must own all directories that it creates.
>      Note: Directories without known owners: /usr/lib64/ocaml
> 
> I guess OK since /usr/lib64/ocaml should be owned by the ocaml compiler.

No, wait.  That's not right.  I'm used to OCaml packages automatically pulling in the base ocaml package, but that doesn't happen here.  I'll add "Requires: ocaml(runtime)".

(In reply to Richard W.M. Jones from comment #6)
> It would be nice to work with upstream to fix their out of date
> COPYING file, however that does not block the package in Fedora.

I will point that out to upstream.  Thank you for the quick review!

Comment 8 Gwyn Ciesla 2021-03-26 15:30:37 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/ocaml-caml-mode

Comment 9 Fedora Update System 2021-03-26 15:57:16 UTC
FEDORA-2021-376a797e94 has been submitted as an update to Fedora 34. https://bodhi.fedoraproject.org/updates/FEDORA-2021-376a797e94

Comment 10 Fedora Update System 2021-03-27 02:01:22 UTC
FEDORA-2021-376a797e94 has been pushed to the Fedora 34 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2021-376a797e94 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-376a797e94

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

Comment 11 Fedora Update System 2021-03-31 00:16:17 UTC
FEDORA-2021-376a797e94 has been pushed to the Fedora 34 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.