Bug 1581404 - Package Review: python-rst-linker - Can add links and perform other custom replacements to rst
Summary: Package Review: python-rst-linker - Can add links and perform other custom re...
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Matthias Runge
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 1411746 1581407
TreeView+ depends on / blocked
 
Reported: 2018-05-22 16:41 UTC by Dan Radez
Modified: 2019-04-09 00:47 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-04-09 00:47:47 UTC
Type: Bug
Embargoed:
mrunge: fedora-review+


Attachments (Terms of Use)

Description Dan Radez 2018-05-22 16:41:53 UTC
python-rst-linker is a dependency of python-cheroot which is a dependency of python-cherrypy-15. This is one of a few new dependencies to get python-cherrypy and python3-cherrypy up to latest version.

https://radez.fedorapeople.org/python-rst-linker-1.9-1.fc28.src.rpm
https://radez.fedorapeople.org/python-rst-linker.spec

$ rpmlint python-rst-linker.spec python-rst-linker-1.9-1.fc28.src.rpm                                      
1 packages and 1 specfiles checked; 0 errors, 0 warnings.

Comment 1 Matthias Runge 2018-05-22 20:13:08 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]: 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]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated". 16 files have unknown license. Detailed
     output of licensecheck in /home/mrunge/review/1581404-python-rst-
     linker/licensecheck.txt
[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.
[-]: 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. 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]: 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]: 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]: 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 python2
     -rst-linker , python3-rst-linker , python-rst-linker-doc
[?]: Package functions as described.
[!]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: 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: python2-rst-linker-1.9-1.fc29.noarch.rpm
          python3-rst-linker-1.9-1.fc29.noarch.rpm
          python-rst-linker-doc-1.9-1.fc29.noarch.rpm
          python-rst-linker-1.9-1.fc29.src.rpm
python3-rst-linker.noarch: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
python-rst-linker-doc.noarch: W: summary-not-capitalized C rst.linker documentation
4 packages and 0 specfiles checked; 0 errors, 2 warnings.




Rpmlint (installed packages)
----------------------------
python3-rst-linker.noarch: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
python3-rst-linker.noarch: W: invalid-url URL: https://github.com/jaraco/rst.linker <urlopen error [Errno -2] Name or service not known>
python2-rst-linker.noarch: W: invalid-url URL: https://github.com/jaraco/rst.linker <urlopen error [Errno -2] Name or service not known>
python-rst-linker-doc.noarch: W: summary-not-capitalized C rst.linker documentation
python-rst-linker-doc.noarch: W: invalid-url URL: https://github.com/jaraco/rst.linker <urlopen error [Errno -2] Name or service not known>
3 packages and 0 specfiles checked; 0 errors, 5 warnings.



Requires
--------
python3-rst-linker (rpmlib, GLIBC filtered):
    python(abi)
    python3-dateutil
    python3-six

python2-rst-linker (rpmlib, GLIBC filtered):
    python(abi)
    python-dateutil
    python-six

python-rst-linker-doc (rpmlib, GLIBC filtered):



Provides
--------
python3-rst-linker:
    python3-rst-linker
    python3.6dist(rst.linker)
    python3dist(rst.linker)

python2-rst-linker:
    python-rst-linker
    python2-rst-linker
    python2.7dist(rst.linker)
    python2dist(rst.linker)

python-rst-linker-doc:
    python-rst-linker-doc



Source checksums
----------------
https://files.pythonhosted.org/packages/source/r/rst.linker/rst.linker-1.9.tar.gz :
  CHECKSUM(SHA256) this package     : 4de05e547d14ac16599d6379a73d394b8eba03afb1f16b6bdb400013957d9999
  CHECKSUM(SHA256) upstream package : 4de05e547d14ac16599d6379a73d394b8eba03afb1f16b6bdb400013957d9999


Generated by fedora-review 0.6.1 (f03e4e7) last change: 2016-05-02
Command line :/usr/bin/fedora-review -b 1581404
Buildroot used: fedora-rawhide-x86_64
Active plugins: Python, Generic, Shell-api
Disabled plugins: Java, C/C++, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP, Ruby
Disabled flags: EXARCH, DISTTAG, EPEL5, BATCH, EPEL6


Issues:
- please use python2-foo instead of python-foo (requirements)
- please update to version 1.10
- please add the license in a %license: LICENSE tag

You could run the check on python2 at least. But that's a minor.

Comment 2 Dan Radez 2018-05-24 01:15:58 UTC
https://radez.fedorapeople.org/python-rst-linker-1.10-1.fc28.src.rpm
https://radez.fedorapeople.org/python-rst-linker.spec

I've updated these two files.
Though I think that the upstream has an inter-dependency between rst.linker and jaraco.packaging.

If we skip the docs build then we don't hit this inter-dependency. I'm not sure what the right way to handle this when two packages depend on each other.

Also: The build does produce python2-rst-linker

Comment 3 Dan Radez 2018-05-24 01:20:21 UTC
The inter-dependency is with this package:
https://bugzilla.redhat.com/show_bug.cgi?id=1581407

I also updated the %check comment, the dep for path.py is not satisfied in py2 or py3 :(

Comment 4 Matthias Runge 2018-05-24 06:44:37 UTC
You're still requiring python-dateutil instead of python2-dateutil. Same for six and a few others. Could you please update these buildrequires and requires?

Otherwise the package looks good and we could skip docs generation in first step. You can enable this later, once the packages were both imported and built.

Comment 5 Matthias Runge 2018-07-09 09:23:41 UTC
Dan, would you have time to address the issues in my last comment? I think we're then ready to go with this.

Comment 6 Dan Radez 2018-07-09 12:05:34 UTC
Yes, Thanks for bringing this back to my radar, I was out for a month and have not circled back to getting theses packages in.

I'll get it updated this week.

Comment 7 Ken Dreyer (Red Hat) 2019-02-25 23:08:42 UTC
Would you please make this package Python 3 only?

Comment 8 Ken Dreyer (Red Hat) 2019-02-25 23:37:13 UTC
Looks like this is only for building documentation, so it's not strictly necessary to build the latest CherryPy version.

Comment 9 Dan Radez 2019-04-02 14:00:36 UTC
sry, been distracted from this for a while. I'll get an update posted.

Comment 10 Dan Radez 2019-04-02 16:44:48 UTC
I've updated the spec file and uploaded it taking out the py2 stuff.

Comment 12 Matthias Runge 2019-04-03 16:00:49 UTC
Thank you, the package looks good, all the issues I've mentioned are fixed.

Package APPROVED

Comment 13 Gwyn Ciesla 2019-04-03 19:01:31 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-rst-linker


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