Bug 1245330 - Review Request: python-sphinxcontrib-programoutput - Extension to insert output of commands into documents
Summary: Review Request: python-sphinxcontrib-programoutput - Extension to insert outp...
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Nikola Forró
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-07-21 19:08 UTC by Zbigniew Jędrzejewski-Szmek
Modified: 2015-12-06 23:14 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-12-06 23:14:59 UTC
Type: ---
Embargoed:
nforro: fedora-review+


Attachments (Terms of Use)

Description Zbigniew Jędrzejewski-Szmek 2015-07-21 19:08:17 UTC
Spec URL: http://in.waw.pl/~zbyszek/fedora/python-sphinxcontrib-programoutput.spec
SRPM URL: http://in.waw.pl/~zbyszek/fedora/python-sphinxcontrib-programoutput-0.8-1.fc24.src.rpm
Fedora Account System Username: zbyszek
Description:
A Sphinx extension to literally insert the output of arbitrary
commands into documents, helping you to keep your command examples
up to date.

The name follows the pattern of other sphinxcontrib extensions:
python-sphinxcontrib-napoleon.noarch : Sphinx napoleon extension
python-sphinxcontrib-adadomain.noarch : Ada domain for the Sphinx documentation generator
python3-sphinxcontrib-napoleon.noarch : Sphinx napoleon extension
python-sphinxcontrib-cheeseshop.noarch : Sphinx extension cheeseshop
python-sphinxcontrib-httpdomain.noarch : Sphinx domain for documenting HTTP APIs
python-sphinxcontrib-issuetracker.noarch : Sphinx integration with different issue trackers
python3-sphinxcontrib-issuetracker.noarch : Sphinx integration with different issue trackers for Python 3

Comment 1 Nikola Forró 2015-07-24 11:21:17 UTC
Your python2 package needs to provide a python2 version of its name:
https://fedoraproject.org/wiki/Packaging:Python#Provides

Python3 package shouldn't own %{python3_sitelib}/__pycache__ directory.

Rpmlint produces following output on binary packages:

python3-sphinxcontrib-programoutput.noarch: W: dangling-relative-symlink /usr/share/doc/python-sphinxcontrib-programoutp
ut/html/_static/jquery.js %{_jsdir}/jquery/latest/jquery.min.js
python-sphinxcontrib-programoutput.noarch: W: dangling-relative-symlink /usr/share/doc/python-sphinxcontrib-programoutpu
t/html/_static/jquery.js %{_jsdir}/jquery/latest/jquery.min.js

You need to add web-assets-devel to BR for %{_jsdir} macro expansion.

python-sphinxcontrib-programoutput.noarch: E: python-bytecode-wrong-magic-value /usr/lib/python2.7/site-packages/sphinxc
ontrib/__pycache__/programoutput.cpython-34.pyc expected 62211 (2.7), found 3310 (3.4)
python-sphinxcontrib-programoutput.noarch: W: python-bytecode-without-source /usr/lib/python2.7/site-packages/sphinxcont
rib/__pycache__/__init__.cpython-34.pyc

It seems like __pycache__ from python3 package is included in python2 package as well.

Comment 2 Zbigniew Jędrzejewski-Szmek 2015-07-24 15:19:23 UTC
(In reply to Nikola Forró from comment #1)
> Your python2 package needs to provide a python2 version of its name:
> https://fedoraproject.org/wiki/Packaging:Python#Provides
Added.

> Python3 package shouldn't own %{python3_sitelib}/__pycache__ directory.
Does it? It only see /usr/lib/python3.4/site-packages/sphinxcontrib/__pycache__ here.

> Rpmlint produces following output on binary packages:
> 
> python3-sphinxcontrib-programoutput.noarch: W: dangling-relative-symlink
> /usr/share/doc/python-sphinxcontrib-programoutp
> ut/html/_static/jquery.js %{_jsdir}/jquery/latest/jquery.min.js
> python-sphinxcontrib-programoutput.noarch: W: dangling-relative-symlink
> /usr/share/doc/python-sphinxcontrib-programoutpu
> t/html/_static/jquery.js %{_jsdir}/jquery/latest/jquery.min.js
It's a bug in rpmlint.

> You need to add web-assets-devel to BR for %{_jsdir} macro expansion.
Done.

> python-sphinxcontrib-programoutput.noarch: E:
> python-bytecode-wrong-magic-value /usr/lib/python2.7/site-packages/sphinxc
> ontrib/__pycache__/programoutput.cpython-34.pyc expected 62211 (2.7), found
> 3310 (3.4)
> python-sphinxcontrib-programoutput.noarch: W: python-bytecode-without-source
> /usr/lib/python2.7/site-packages/sphinxcont
> rib/__pycache__/__init__.cpython-34.pyc
>
> It seems like __pycache__ from python3 package is included in python2
> package as well.
Fixed.

Spec URL: http://in.waw.pl/~zbyszek/fedora/python-sphinxcontrib-programoutput.spec
SRPM URL: http://in.waw.pl/~zbyszek/fedora/python-sphinxcontrib-programoutput-0.8-2.fc24.src.rpm

Comment 3 Nikola Forró 2015-07-27 13:19:34 UTC
(In reply to Zbigniew Jędrzejewski-Szmek from comment #2)
> (In reply to Nikola Forró from comment #1)
> > Your python2 package needs to provide a python2 version of its name:
> > https://fedoraproject.org/wiki/Packaging:Python#Provides
> Added.
You should make Provides versioned:
Provides: python2-%{srcname} = %{version}-%{release}

> Does it? It only see
> /usr/lib/python3.4/site-packages/sphinxcontrib/__pycache__ here.
> 
Sorry, of course you are correct.


More issues:

You are missing BR python-setuptools and python3-setuptools since you are using setup.py.

I think you should remove existing sphinxcontrib_programoutput.egg-info directory in %prep section.


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. No licenses
     found. Please check the source files for licenses manually.
[x]: License file installed when any subpackage combination is installed.
[x]: Package does not own files or directories owned by other packages.
     Note: Dirs in package are owned also by: /usr/lib/python3.4/site-
     packages/sphinxcontrib(python3-sphinxcontrib-napoleon, python3
     -sphinxcontrib-issuetracker)
[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 368640 bytes in 56 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]: 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:
[-]: 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 python3
     -sphinxcontrib-programoutput
[x]: 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.
[-]: 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.
[x]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[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]: 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).


Rpmlint
-------
Checking: python-sphinxcontrib-programoutput-0.8-2.fc24.noarch.rpm
          python3-sphinxcontrib-programoutput-0.8-2.fc24.noarch.rpm
          python-sphinxcontrib-programoutput-0.8-2.fc24.src.rpm
python-sphinxcontrib-programoutput.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/python-sphinxcontrib-programoutput/html/objects.inv
python-sphinxcontrib-programoutput.noarch: W: file-not-utf8 /usr/share/doc/python-sphinxcontrib-programoutput/html/objects.inv
python-sphinxcontrib-programoutput.noarch: W: dangling-symlink /usr/share/doc/python-sphinxcontrib-programoutput/html/_static/jquery.js /usr/share/javascript/jquery/latest/jquery.min.js
python3-sphinxcontrib-programoutput.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/python-sphinxcontrib-programoutput/html/objects.inv
python3-sphinxcontrib-programoutput.noarch: W: file-not-utf8 /usr/share/doc/python-sphinxcontrib-programoutput/html/objects.inv
python3-sphinxcontrib-programoutput.noarch: W: dangling-symlink /usr/share/doc/python-sphinxcontrib-programoutput/html/_static/jquery.js /usr/share/javascript/jquery/latest/jquery.min.js
python-sphinxcontrib-programoutput.src:29: W: unversioned-explicit-provides python2-%{srcname}
3 packages and 0 specfiles checked; 0 errors, 7 warnings.




Rpmlint (installed packages)
----------------------------
python3-sphinxcontrib-programoutput.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/python-sphinxcontrib-programoutput/html/objects.inv
python3-sphinxcontrib-programoutput.noarch: W: file-not-utf8 /usr/share/doc/python-sphinxcontrib-programoutput/html/objects.inv
python3-sphinxcontrib-programoutput.noarch: W: dangling-symlink /usr/share/doc/python-sphinxcontrib-programoutput/html/_static/jquery.js /usr/share/javascript/jquery/latest/jquery.min.js
python-sphinxcontrib-programoutput.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/python-sphinxcontrib-programoutput/html/objects.inv
python-sphinxcontrib-programoutput.noarch: W: file-not-utf8 /usr/share/doc/python-sphinxcontrib-programoutput/html/objects.inv
python-sphinxcontrib-programoutput.noarch: W: dangling-symlink /usr/share/doc/python-sphinxcontrib-programoutput/html/_static/jquery.js /usr/share/javascript/jquery/latest/jquery.min.js
2 packages and 0 specfiles checked; 0 errors, 6 warnings.



Requires
--------
python3-sphinxcontrib-programoutput (rpmlib, GLIBC filtered):
    js-jquery
    python(abi)
    python3-sphinx

python-sphinxcontrib-programoutput (rpmlib, GLIBC filtered):
    js-jquery
    python(abi)
    python-sphinx



Provides
--------
python3-sphinxcontrib-programoutput:
    python3-sphinxcontrib-programoutput

python-sphinxcontrib-programoutput:
    python-sphinxcontrib-programoutput
    python2-sphinxcontrib-programoutput



Source checksums
----------------
https://pypi.python.org/packages/source/s/sphinxcontrib-programoutput/sphinxcontrib-programoutput-0.8.tar.gz :
  CHECKSUM(SHA256) this package     : 1776a03124bab87e35576f7f3992fc21d5bb457321b35e6023eb011dbed10a25
  CHECKSUM(SHA256) upstream package : 1776a03124bab87e35576f7f3992fc21d5bb457321b35e6023eb011dbed10a25


Generated by fedora-review 0.6.0 (3c5c9d7) last change: 2015-05-20
Command line :/usr/bin/fedora-review --rpm-spec --name python-sphinxcontrib-programoutput-0.8-2.fc24.src.rpm
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

Comment 5 Nikola Forró 2015-07-27 13:41:02 UTC
Package is APPROVED.

Comment 6 Till Maas 2015-11-16 17:04:53 UTC
Package request has been approved: https://admin.fedoraproject.org/pkgdb/package/python-sphinxcontrib-programoutput

Comment 7 Zbigniew Jędrzejewski-Szmek 2015-12-06 23:14:59 UTC
Built in rawhide and F23 and F22.


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