Bug 1347006 - Review Request: python-sphinxcontrib-spelling - A spelling checker for Sphinx-based documentation
Summary: Review Request: python-sphinxcontrib-spelling - A spelling checker for Sphinx...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: 24
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: William Moreno
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-06-15 18:57 UTC by Avram Lubkin
Modified: 2016-07-02 15:26 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-07-02 15:26:38 UTC
Type: ---
Embargoed:
williamjmorenor: fedora-review+


Attachments (Terms of Use)

Description Avram Lubkin 2016-06-15 18:57:10 UTC
Spec URL: https://aviso.fedorapeople.org/python-sphinxcontrib-spelling.spec
SRPM URL: https://aviso.fedorapeople.org/python-sphinxcontrib-spelling-2.1.2-1.fc24.src.rpm
Description: This package contains sphinxcontrb.spelling, a spelling checker for
Sphinx-based documentation. It uses PyEnchant to produce a report showing
misspelled words.
Fedora Account System Username: aviso

Comment 1 Avram Lubkin 2016-06-16 12:38:49 UTC
A couple heads up to reviewer:

This package won't build on Fedora 23 due to the rename or python-sphinx to python2-sphinx in Fedora 24. Not planning on releasing for Fedora 23 unless someone asks for it. These should both succeed.

fedora-review -b 1347006 -m fedora-rawhide-x86_64
fedora-review -b 1347006 -m fedora-24-x86_64

rpmlint will find non-executable-script for the python package files. That's an upstream bug. The correct way to fix it is to remove the shebang line from those files since none of them are actually scripts. Only way to get rid of the error now would be to patch the files or make the files executable. Neither seems like a good idea, since the only thing it affects is rpmlint, but let me know what you think. Pull request submitted to upstream.

https://bitbucket.org/dhellmann/sphinxcontrib-spelling/pull-requests/4/removed-unnecessary-shebang-lines-from-non/diff

Comment 2 William Moreno 2016-06-22 19:28:01 UTC
Package Review
==============

1. There is a issue with directories without proper ownerships
[!]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/python3.5/site-
     packages/sphinxcontrib, /usr/lib/python2.7/site-packages/sphinxcontrib

2. I will recomend to remove the shebangs with sed before aprove this package, there is a oneliner in:

https://fedoraproject.org/wiki/Packaging_tricks#Remove_shebang_from_files

===== 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.
[x]: License file installed when any subpackage combination is installed.
[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.
[x]: 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.
[x]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[x]: Large documentation must go in a -doc subpackage.
[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]: All build dependencies are listed in BuildRequires, except for any
     that are listed in the exceptions section of Packaging Guidelines.
[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

Python:
[x]: Python eggs must not download any dependencies during the build
     process.
[x]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[x]: Binary eggs must be removed in %prep

===== SHOULD items =====
Generic:
[x]: %check is present and all tests pass.
[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]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python2-sphinxcontrib-spelling-2.1.2-1.fc25.noarch.rpm
          python3-sphinxcontrib-spelling-2.1.2-1.fc25.noarch.rpm
          python-sphinxcontrib-spelling-2.1.2-1.fc25.src.rpm
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/tests/test_builder.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/filters.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/checker.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/builder.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/tests/test_checker.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/tests/test_filter.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/directive.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/tests/test_filter.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/directive.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/tests/test_builder.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/tests/test_checker.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/checker.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/filters.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/builder.py 644 /usr/bin/env
3 packages and 0 specfiles checked; 14 errors, 0 warnings.

Rpmlint (installed packages)
----------------------------
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/tests/test_checker.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/builder.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/filters.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/directive.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/tests/test_builder.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/tests/test_filter.py 644 /usr/bin/env
python3-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python3.5/site-packages/sphinxcontrib/spelling/checker.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/directive.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/tests/test_filter.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/tests/test_builder.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/filters.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/tests/test_checker.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/builder.py 644 /usr/bin/env
python2-sphinxcontrib-spelling.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/sphinxcontrib/spelling/checker.py 644 /usr/bin/env
2 packages and 0 specfiles checked; 14 errors, 0 warnings.

Requires
--------
python3-sphinxcontrib-spelling (rpmlib, GLIBC filtered):
    python(abi)
    python3-enchant
    python3-six
    python3-sphinx

python2-sphinxcontrib-spelling (rpmlib, GLIBC filtered):
    python(abi)
    python-enchant
    python2-six
    python2-sphinx

Provides
--------
python3-sphinxcontrib-spelling:
    python3-sphinxcontrib-spelling

python2-sphinxcontrib-spelling:
    python-sphinxcontrib-spelling
    python2-sphinxcontrib-spelling

Source checksums
----------------
https://files.pythonhosted.org/packages/source/s/sphinxcontrib-spelling/sphinxcontrib-spelling-2.1.2.tar.gz :
  CHECKSUM(SHA256) this package     : c5ac488141408564cb60f355c50efd90b826a9fc7723738a07ab907a0384f086
  CHECKSUM(SHA256) upstream package : c5ac488141408564cb60f355c50efd90b826a9fc7723738a07ab907a0384f086

Comment 3 Avram Lubkin 2016-06-22 21:19:02 UTC
I took out the shebangs and fixed the directory. Should be good now.

Comment 4 William Moreno 2016-06-22 22:45:34 UTC
It is a good practice to bump the spec (rpmdev-bumpspec) any time you make a change to the spec and document changes done in the changelog, then post new spec and srpm in the format:

Spec URL: 
SRPM URL:

Any way I see the changes in the spec and looks good, package aproved.

Comment 5 Gwyn Ciesla 2016-06-23 13:07:35 UTC
Package request has been approved: https://admin.fedoraproject.org/pkgdb/package/rpms/python-sphinxcontrib-spelling

Comment 6 Fedora Update System 2016-06-23 14:13:15 UTC
python-sphinxcontrib-spelling-2.1.2-1.fc24 has been submitted as an update to Fedora 24. https://bodhi.fedoraproject.org/updates/FEDORA-2016-00f7684349

Comment 7 Fedora Update System 2016-06-23 18:56:29 UTC
python-sphinxcontrib-spelling-2.1.2-1.fc24 has been pushed to the Fedora 24 testing repository. If problems still persist, please make note of it in this bug report.
See https://fedoraproject.org/wiki/QA:Updates_Testing for
instructions on how to install test updates.
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2016-00f7684349

Comment 8 Fedora Update System 2016-07-02 15:26:37 UTC
python-sphinxcontrib-spelling-2.1.2-1.fc24 has been pushed to the Fedora 24 stable repository. If problems still persist, 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.