Bug 1687872 - Review Request: python-sphinx-removed-in - versionremoved and removed-in directives for Sphinx
Summary: Review Request: python-sphinx-removed-in - versionremoved and removed-in dire...
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: PYTEST4
TreeView+ depends on / blocked
 
Reported: 2019-03-12 14:15 UTC by Miro Hrončok
Modified: 2019-03-25 12:54 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-03-25 12:54:04 UTC
Type: ---
Embargoed:
zebob.m: fedora-review+


Attachments (Terms of Use)

Description Miro Hrončok 2019-03-12 14:15:35 UTC
Spec URL: https://churchyard.fedorapeople.org/SRPMS/python-sphinx-removed-in-0.1.3-1.fc29.src.rpm
SRPM URL: https://churchyard.fedorapeople.org/SRPMS/python-sphinx-removed-in.spec

Description:
This is a Sphinx extension which recognizes the versionremoved and removed-in
directives.

Fedora Account System Username: churchyard

Comment 1 Robert-André Mauchin 🐧 2019-03-13 20:46:46 UTC
I've got a test error:

+ /usr/bin/python3 setup.py test
running test
running egg_info
writing sphinx_removed_in.egg-info/PKG-INFO
writing dependency_links to sphinx_removed_in.egg-info/dependency_links.txt
writing requirements to sphinx_removed_in.egg-info/requires.txt
writing top-level names to sphinx_removed_in.egg-info/top_level.txt
reading manifest file 'sphinx_removed_in.egg-info/SOURCES.txt'
writing manifest file 'sphinx_removed_in.egg-info/SOURCES.txt'
running build_ext
BUILDSTDERR: test_sphinx_build (tests.test_extension.TestExtension) ... /usr/lib/python3.7/site-packages/jinja2/sandbox.py:82: DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it will stop working
BUILDSTDERR:   from collections import MutableSet, MutableMapping, MutableSequence
BUILDSTDERR: /usr/lib/python3.7/site-packages/docutils/io.py:245: DeprecationWarning: 'U' mode is deprecated
BUILDSTDERR:   self.source = open(source_path, mode, **kwargs)
BUILDSTDERR: ERROR
BUILDSTDERR: ======================================================================
BUILDSTDERR: ERROR: test_sphinx_build (tests.test_extension.TestExtension)
BUILDSTDERR: ----------------------------------------------------------------------
BUILDSTDERR: Traceback (most recent call last):
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx_testing/util.py", line 166, in decorator
BUILDSTDERR:     return func(*(args + (app, status, warning)), **kwargs)
BUILDSTDERR:   File "/builddir/build/BUILD/sphinx-removed-in-0.1.3/tests/test_extension.py", line 14, in test_sphinx_build
BUILDSTDERR:     app.build()
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx/application.py", line 338, in build
BUILDSTDERR:     self.builder.build_update()
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 326, in build_update
BUILDSTDERR:     len(to_build))
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 339, in build
BUILDSTDERR:     updated_docnames = set(self.read())
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 445, in read
BUILDSTDERR:     self._read_serial(docnames)
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 467, in _read_serial
BUILDSTDERR:     self.read_doc(docname)
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 511, in read_doc
BUILDSTDERR:     doctree = read_doc(self.app, self.env, self.env.doc2path(docname))
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx/io.py", line 324, in read_doc
BUILDSTDERR:     pub.publish()
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/docutils/core.py", line 217, in publish
BUILDSTDERR:     self.settings)
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx/io.py", line 117, in read
BUILDSTDERR:     self.parse()
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/docutils/readers/__init__.py", line 78, in parse
BUILDSTDERR:     self.parser.parse(self.input, document)
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx/parsers.py", line 94, in parse
BUILDSTDERR:     self.statemachine.run(inputlines, document, inliner=self.inliner)
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 171, in run
BUILDSTDERR:     input_source=document['source'])
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/docutils/statemachine.py", line 239, in run
BUILDSTDERR:     context, state, transitions)
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/docutils/statemachine.py", line 460, in check_line
BUILDSTDERR:     return method(match, context, next_state)
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 2326, in explicit_markup
BUILDSTDERR:     nodelist, blank_finish = self.explicit_construct(match)
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 2338, in explicit_construct
BUILDSTDERR:     return method(self, expmatch)
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 2081, in directive
BUILDSTDERR:     directive_class, match, type_name, option_presets)
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/docutils/parsers/rst/states.py", line 2130, in run_directive
BUILDSTDERR:     result = directive_instance.run()
BUILDSTDERR:   File "/usr/lib/python3.7/site-packages/sphinx/domains/changeset.py", line 85, in run
BUILDSTDERR:     classes = ['versionmodified', versionlabel_classes[self.name]]
BUILDSTDERR: KeyError: 'versionremoved'
BUILDSTDERR: ----------------------------------------------------------------------
BUILDSTDERR: Ran 1 test in 0.407s
BUILDSTDERR: FAILED (errors=1)
BUILDSTDERR: Test failed: <unittest.runner.TextTestResult run=1 errors=1 failures=0>
BUILDSTDERR: error: Test failed: <unittest.runner.TextTestResult run=1 errors=1 failures=0>
BUILDSTDERR: error: Bad exit status from /var/tmp/rpm-tmp.GySHAG (%check)
BUILDSTDERR:     Bad exit status from /var/tmp/rpm-tmp.GySHAG (%check)


Seems you already reported upstream https://github.com/MrSenko/sphinx-removed-in/issues/5

Let me know if you want me to accept the package as is or wait for a fix from upstream.



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", "BSD 3-clause "New" or "Revised"
     License", "*No copyright* BSD (unspecified)". 8 files have unknown
     license. Detailed output of licensecheck in
     /home/bob/packaging/review/python-sphinx-removed-in/review-python-
     sphinx-removed-in/licensecheck.txt
[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.
[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 10240 bytes in 1 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

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]: Packages MUST NOT have dependencies (either build-time or runtime) on
     packages named with the unversioned python- prefix unless no properly
     versioned package exists. Dependencies on Python packages instead MUST
     use names beginning with python2- or python3- as appropriate.
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
[x]: Binary eggs must be removed in %prep

===== 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.
[-]: 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]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-sphinx-removed-in-0.1.3-1.fc31.noarch.rpm
          python-sphinx-removed-in-0.1.3-1.fc31.src.rpm
python3-sphinx-removed-in.noarch: W: spelling-error Summary(en_US) versionremoved -> version removed, version-removed, introversion
python3-sphinx-removed-in.noarch: W: summary-not-capitalized C versionremoved and removed-in directives for Sphinx
python3-sphinx-removed-in.noarch: W: spelling-error %description -l en_US versionremoved -> version removed, version-removed, introversion
python-sphinx-removed-in.src: W: spelling-error Summary(en_US) versionremoved -> version removed, version-removed, introversion
python-sphinx-removed-in.src: W: summary-not-capitalized C versionremoved and removed-in directives for Sphinx
python-sphinx-removed-in.src: W: spelling-error %description -l en_US versionremoved -> version removed, version-removed, introversion
2 packages and 0 specfiles checked; 0 errors, 6 warnings.

Comment 2 Miro Hrončok 2019-03-14 00:21:20 UTC
I've built this in mock and submitted it. But I've got Sphinx 1.8.x. Later I've realized pytest docs don't build and filed the upstream issue.

I don't care if we wait or not, since I only need this for pytest and hence I need the upstream bug fixed. We can keep this open until it is.

Thank you.

Comment 4 Robert-André Mauchin 🐧 2019-03-14 13:07:28 UTC
Great! Package approved.

Comment 5 Gwyn Ciesla 2019-03-14 13:46:18 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-sphinx-removed-in


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