Bug 1140202 - Review Request: python-sphinxcontrib-napoleon - Sphinx napoleon extension
Summary: Review Request: python-sphinxcontrib-napoleon - Sphinx napoleon extension
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Florian "der-flo" Lehner
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-09-10 13:31 UTC by Michal Minar
Modified: 2014-12-18 09:09 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-12-18 09:09:37 UTC
Type: ---
Embargoed:
dev: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)

Description Michal Minar 2014-09-10 13:31:36 UTC
Spec URL: https://fedorapeople.org/~miminar/python-sphinxcontrib-napoleon.spec
SRPM URL: https://fedorapeople.org/~miminar/python-sphinxcontrib-napoleon-0.2.8-1.fc20.src.rpm
Description:
Napoleon is a Sphinx extension that parses NumPy and Google style docstrings
and converts them to reStructuredText before Sphinx attempts to parse them.
This happens in an intermediate step while Sphinx is processing the
documentation, so it doesn't modify any of the docstrings in your actual source
code files.

Fedora Account System Username: miminar

Comment 1 Florian "der-flo" Lehner 2014-09-14 13:41:40 UTC
hi!

The file you provided as spec differs from the spec-file in the srpm.

Cheers,
 Flo

Comment 2 Michal Minar 2014-09-16 05:21:57 UTC
You're right, I've just updated srpm.
Thanks for taking this.

Comment 3 Florian "der-flo" Lehner 2014-09-25 18:32:40 UTC
hi Michal!

Are you still interested in a review?

Cheers,
 Florian

Comment 4 Michal Minar 2014-09-29 05:58:34 UTC
Of course! :)

Comment 5 Michal Minar 2014-11-18 11:14:51 UTC
I'm updating urls spec and srpm urls:

Spec URL: https://fedorapeople.org/~miminar/rpmreview/devilspie2.spec
SRPM URL: https://fedorapeople.org/~miminar/rpmreview/devilspie2-0.38-1.fc21.src.rpm

Florian, can you please take a look?

Comment 6 Florian "der-flo" Lehner 2014-11-18 16:28:15 UTC
hi Michal!

Spec file as given by url is still not the same as in SRPM.

Cheers,
 Florian

Comment 7 Florian "der-flo" Lehner 2014-11-20 18:17:39 UTC
hi!

Looking at http://git.savannah.gnu.org/cgit/devilspie2.git/tree/INSTALL I don't know why gettext is needed.

Diff spec file in url and in SRPM
---------------------------------
--- /home/flo/review/1140202-devilspie2/srpm/devilspie2.spec	2014-11-20 19:05:08.379808143 +0100
+++ /home/flo/review/1140202-devilspie2/srpm-unpacked/devilspie2.spec	2014-11-18 12:03:04.000000000 +0100
@@ -14,4 +14,5 @@
 BuildRequires:  libwnck3-devel
 BuildRequires:  glib2-devel
+BuildRequires:  gettext
 
 %description

Cheers,
 Flo

Comment 8 Michal Minar 2014-11-25 07:54:43 UTC
Ouch, I'm so sorry. Those urls were meant for another review.
These are correct ones:

  Spec URL: https://fedorapeople.org/~miminar/rpmreview/python-sphinxcontrib-napoleon.spec
  SRPM URL: https://fedorapeople.org/~miminar/rpmreview/python-sphinxcontrib-napoleon-0.2.8-1.fc21.src.rpm

I've checked SPEC file in SRPM and that given by url and found them identical (both for current urls and those *devilspie2* ones).

Comment 9 Florian "der-flo" Lehner 2014-11-25 17:53:46 UTC
hi Michal!

Taking a look at https://pypi.python.org/pypi/sphinxcontrib-napoleon
and at
$ yum info sphinx | grep Version
Version     : 2.0.8

I don't see a reason to package.

In addition, there is an error:
Error: Package: python-sphinxcontrib-napoleon-0.2.8-1.fc22.noarch (/python-sphinxcontrib-napoleon-0.2.8-1.fc22.noarch)
           Requires: sphinx < 1.3
           Installing: sphinx-2.2.6-1.fc22.x86_64 (fedora)
               sphinx = 2.2.6-1.fc22
 You could try using --skip-broken to work around the problem
Error: Package: python-sphinxcontrib-napoleon-0.2.8-1.fc22.noarch (/python-sphinxcontrib-napoleon-0.2.8-1.fc22.noarch)
           Requires: sphinx < 1.3
           Available: sphinx-2.2.6-1.fc22.x86_64 (fedora)
               sphinx = 2.2.6-1.fc22
Error: Package: python3-sphinxcontrib-napoleon-0.2.8-1.fc22.noarch (/python3-sphinxcontrib-napoleon-0.2.8-1.fc22.noarch)
           Requires: sphinx < 1.3
           Installing: sphinx-2.2.6-1.fc22.x86_64 (fedora)
               sphinx = 2.2.6-1.fc22
 You could try running: rpm -Va --nofiles --nodigest

Cheers,
 Flo

Comment 10 Michal Minar 2014-11-26 09:12:48 UTC
Ahh, bad Requires (python-sphinx is the right one). Thanks for finding out.

The new srpm is at:
  https://fedorapeople.org/~miminar/rpmreview/python-sphinxcontrib-napoleon-0.2.8-2.fc21.src.rpm

Comment 11 Florian "der-flo" Lehner 2014-11-26 17:04: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". 12 files have unknown license.
[x]: License file installed when any subpackage combination is installed.
[x]: Package requires other packages for directories it uses.
     Note: No known owner of /usr/lib/python3.4/site-packages,
     /usr/lib/python3.4
[x]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/python3.4/site-packages,
     /usr/lib/python3.4
[x]: Package does not own files or directories owned by other packages.
     Note: Dirs in package are owned also by: /usr/lib/python2.7/site-
     packages/sphinxcontrib(python-sphinxcontrib-cheeseshop, python-
     sphinxcontrib-httpdomain, python-sphinxcontrib-adadomain, python-
     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.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 40960 bytes in 4 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 %doc.
[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]: 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 do not use a name that already exist
[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).
[x]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in python3
     -sphinxcontrib-napoleon
[x]: 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.
   ---> http://koji.fedoraproject.org/koji/taskinfo?taskID=8238024
[-]: %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]: Dist tag is present (not strictly required in GL).
[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).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python-sphinxcontrib-napoleon-0.2.8-2.fc22.noarch.rpm
          python3-sphinxcontrib-napoleon-0.2.8-2.fc22.noarch.rpm
          python-sphinxcontrib-napoleon-0.2.8-2.fc22.src.rpm
python-sphinxcontrib-napoleon.noarch: W: spelling-error %description -l en_US docstrings -> doc strings, doc-strings, drawstrings
python-sphinxcontrib-napoleon.noarch: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
python3-sphinxcontrib-napoleon.noarch: W: spelling-error %description -l en_US docstrings -> doc strings, doc-strings, drawstrings
python3-sphinxcontrib-napoleon.noarch: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
python-sphinxcontrib-napoleon.src: W: spelling-error %description -l en_US docstrings -> doc strings, doc-strings, drawstrings
python-sphinxcontrib-napoleon.src: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
3 packages and 0 specfiles checked; 0 errors, 6 warnings.




Rpmlint (installed packages)
----------------------------
# rpmlint python3-sphinxcontrib-napoleon python-sphinxcontrib-napoleon
python3-sphinxcontrib-napoleon.noarch: W: spelling-error %description -l en_US docstrings -> doc strings, doc-strings, drawstrings
python3-sphinxcontrib-napoleon.noarch: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
python-sphinxcontrib-napoleon.noarch: W: spelling-error %description -l en_US docstrings -> doc strings, doc-strings, drawstrings
python-sphinxcontrib-napoleon.noarch: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
2 packages and 0 specfiles checked; 0 errors, 4 warnings.
# echo 'rpmlint-done:'



Requires
--------
python3-sphinxcontrib-napoleon (rpmlib, GLIBC filtered):
    python(abi)
    python3-sphinx

python-sphinxcontrib-napoleon (rpmlib, GLIBC filtered):
    python(abi)
    python-sphinx



Provides
--------
python3-sphinxcontrib-napoleon:
    python3-sphinxcontrib-napoleon

python-sphinxcontrib-napoleon:
    python-sphinxcontrib-napoleon



Source checksums
----------------
https://pypi.python.org/packages/source/s/sphinxcontrib-napoleon/sphinxcontrib-napoleon-0.2.8.tar.gz :
  CHECKSUM(SHA256) this package     : 1be47b1eb3df9f06ba581a2d865a45131ca89eb49b157be5b6a4191432a060c8
  CHECKSUM(SHA256) upstream package : 1be47b1eb3df9f06ba581a2d865a45131ca89eb49b157be5b6a4191432a060c8


Generated by fedora-review 0.5.2 (63c24cb) last change: 2014-07-14
Command line :/usr/bin/fedora-review -m fedora-rawhide-x86_64 -b 1140202
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, EPEL5, BATCH, DISTTAG
===== Solution =====
      APPROVED

Comment 12 Michal Minar 2014-11-27 07:54:50 UTC
New Package SCM Request
=======================
Package Name: python-sphinxcontrib-napoleon
Short Description: Sphinx napoleon extension
Upstream URL: http://sphinxcontrib-napoleon.readthedocs.org/en/latest/
Owners: miminar
Branches: f20 f21 epel7
InitialCC:

Comment 13 Michal Minar 2014-11-27 07:55:55 UTC
Thank you, Florian, for your patience and overall help.

Comment 14 Gwyn Ciesla 2014-12-01 13:20:55 UTC
Git done (by process-git-requests).


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