Bug 1222227 - Review Request: breathe - Doxygen xml output to reStructuredText
Summary: Review Request: breathe - Doxygen xml output to reStructuredText
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Zbigniew Jędrzejewski-Szmek
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-05-16 17:48 UTC by Dave Johansen
Modified: 2015-08-03 04:30 UTC (History)
2 users (show)

Fixed In Version: breathe-4.0.0-1.fc22
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-08-02 19:29:29 UTC
Type: ---
Embargoed:
zbyszek: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)

Description Dave Johansen 2015-05-16 17:48:51 UTC
Spec URL: https://daveisfera.fedorapeople.org/breathe_4.0.0/breathe.spec
SRPM URL: https://daveisfera.fedorapeople.org/breathe_4.0.0/breathe-4.0.0-1.fc21.src.rpm
Description: Breathe is an extension to reStructuredText and Sphinx to be able to read and render the Doxygen xml output.
Fedora Account System Username: daveisfera

Comment 1 Zbigniew Jędrzejewski-Szmek 2015-06-15 14:52:27 UTC
I'd strongly suggest adding %global _docdir_fmt %{name}. Then a single directory docs and license directories will be used (/usr/share/doc/breathe-doc should simply be /usr/share/doc/breathe).

===== 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.
BSD.

[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.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "zlib/libpng". 104 files have unknown
     license. Detailed output of licensecheck in
     /var/tmp/1222227-breathe/licensecheck.txt

examples/tinyxml has zlib/libpng license.
Please change license of -doc subpackage to "BSD and zlib", and add a comment in .spec explaining why.

[!]: License file installed when any subpackage combination is installed.
No license file (or dependency on main package) in breathe-doc.

[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.
[x]: 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]: 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]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 0 bytes in 0 files.
[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 breathe-
     doc
Not necessary.

[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.
[-]: %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]: Uses parallel make %{?_smp_mflags} macro.
[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: breathe-4.0.0-1.fc23.noarch.rpm
          breathe-doc-4.0.0-1.fc23.noarch.rpm
          breathe-4.0.0-1.fc23.src.rpm
breathe.noarch: W: spelling-error Summary(en_US) xml -> XML, ml, x ml
breathe.noarch: W: spelling-error Summary(en_US) reStructuredText -> restructured Text, restructured-text, restructure
breathe.noarch: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
breathe.noarch: W: spelling-error %description -l en_US xml -> XML, ml, x ml
breathe.noarch: W: no-documentation
breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/compound.py 0644L /usr/bin/env
breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/index.py 0644L /usr/bin/env
breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/compoundsuper.py 0644L /usr/bin/env
breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/indexsuper.py 0644L /usr/bin/env

Please consider removing the header line...
sed '1{/usr.bin.env/d}' breathe/parser/doxygen/compound.py ...

breathe-doc.noarch: W: file-not-utf8 /usr/share/doc/breathe-doc/html/objects.inv
breathe-doc.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/breathe-doc/html/_static/jquery.js
breathe.src: W: spelling-error Summary(en_US) xml -> XML, ml, x ml
breathe.src: W: spelling-error Summary(en_US) reStructuredText -> restructured Text, restructured-text, restructure
breathe.src: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
breathe.src: W: spelling-error %description -l en_US xml -> XML, ml, x ml
3 packages and 0 specfiles checked; 4 errors, 11 warnings.

OK.


Rpmlint (installed packages)
----------------------------
breathe.noarch: W: spelling-error Summary(en_US) xml -> XML, ml, x ml
breathe.noarch: W: spelling-error Summary(en_US) reStructuredText -> restructured Text, restructured-text, restructure
breathe.noarch: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
breathe.noarch: W: spelling-error %description -l en_US xml -> XML, ml, x ml
breathe.noarch: W: no-documentation
breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/compound.py 0644L /usr/bin/env
breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/index.py 0644L /usr/bin/env
breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/compoundsuper.py 0644L /usr/bin/env
breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/indexsuper.py 0644L /usr/bin/env
breathe-doc.noarch: W: file-not-utf8 /usr/share/doc/breathe-doc/html/objects.inv
breathe-doc.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/breathe-doc/html/_static/jquery.js
2 packages and 0 specfiles checked; 4 errors, 7 warnings.

Requires
--------
breathe (rpmlib, GLIBC filtered):
    python(abi)

breathe-doc (rpmlib, GLIBC filtered):

Provides
--------
breathe:
    breathe

breathe-doc:
    breathe-doc

Source checksums
----------------
https://github.srcurl.net/michaeljones/breathe/v4.0.0/breathe-4.0.0.tar.gz :
  CHECKSUM(SHA256) this package     : efbb98a19abe6bf931878408d175eae6f68122eaca2a830628b4b73fd6a41703
  CHECKSUM(SHA256) upstream package : efbb98a19abe6bf931878408d175eae6f68122eaca2a830628b4b73fd6a41703

Generated by fedora-review 0.5.3 (bcf15e3) last change: 2015-05-04
Command line :/usr/bin/fedora-review -b 1222227 -m fedora-rawhide-i386
Buildroot used: fedora-rawhide-i386
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 2 Dave Johansen 2015-06-23 14:23:59 UTC
The updated .spec file and source .rpm are available at the previously listed URLs (the originals are at *_v1). The details of the fixes are listed below.

> I'd strongly suggest adding %global _docdir_fmt %{name}. Then a single directory docs and license directories will be used (/usr/share/doc/breathe-doc should simply be /usr/share/doc/breathe).
Fixed

> [!]: License field in the package spec file matches the actual license.
>      Note: Checking patched sources after %prep for licenses. Licenses
>      found: "Unknown or generated", "zlib/libpng". 104 files have unknown
>      license. Detailed output of licensecheck in
>      /var/tmp/1222227-breathe/licensecheck.txt
> [!]: License file installed when any subpackage combination is installed.
> No license file (or dependency on main package) in breathe-doc.
> [-]: If the source package does not include license text(s) as a separate
>      file from upstream, the packager SHOULD query upstream to include it.
Sorry. I had forgotten to package the license file, but that's now fixed.

> [-]: %check is present and all tests pass.
Upstream has no tests in 4.0.0 release

> Rpmlint
> -------
> breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/compound.py 0644L /usr/bin/env
> breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/index.py 0644L /usr/bin/env
> breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/compoundsuper.py 0644L /usr/bin/env
> breathe.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/breathe/parser/doxygen/indexsuper.py 0644L /usr/bin/env
Added patch to fix this and submitted it upstream.

Comment 3 Zbigniew Jędrzejewski-Szmek 2015-06-23 14:52:15 UTC
What about other comments? New spec file?

Comment 4 Dave Johansen 2015-07-08 17:05:28 UTC
Sorry, I didn't read all of the license comments as thoroughly as I should have and just assumed that they were all stemming from the same cause. I've resolved the other issues as well.

The updated file can be found at:
https://daveisfera.fedorapeople.org/breathe_4.0.0/breathe-4.0.0-1.fc21.src.rpm
https://daveisfera.fedorapeople.org/breathe_4.0.0/breathe.spec

> [!]: License field in the package spec file matches the actual license.
>      Note: Checking patched sources after %prep for licenses. Licenses
>      found: "Unknown or generated", "zlib/libpng". 104 files have unknown
>      license. Detailed output of licensecheck in
>      /var/tmp/1222227-breathe/licensecheck.txt
Changed license of breathe-doc to "BSD and zlib" with comment about why.

> [!]: License file installed when any subpackage combination is installed.
> No license file (or dependency on main package) in breathe-doc.
Added license file to breathe-doc.

Comment 5 Zbigniew Jędrzejewski-Szmek 2015-07-09 02:56:28 UTC
Looks good. Package is APPROVED.

Comment 6 Dave Johansen 2015-07-10 14:28:06 UTC
New Package SCM Request
=======================
Package Name: breathe
Short Description: Doxygen xml output to reStructuredText
Upstream URL: https://github.com/michaeljones/breathe
Owners: daveisfera
Branches: f21 f22 epel7
InitialCC:

Comment 7 Gwyn Ciesla 2015-07-10 16:38:35 UTC
Git done (by process-git-requests).

Comment 8 Fedora Update System 2015-07-12 23:37:54 UTC
breathe-4.0.0-1.fc21 has been submitted as an update for Fedora 21.
https://admin.fedoraproject.org/updates/breathe-4.0.0-1.fc21

Comment 9 Fedora Update System 2015-07-12 23:38:00 UTC
breathe-4.0.0-1.fc22 has been submitted as an update for Fedora 22.
https://admin.fedoraproject.org/updates/breathe-4.0.0-1.fc22

Comment 10 Fedora Update System 2015-07-12 23:38:05 UTC
breathe-4.0.0-1.el7 has been submitted as an update for Fedora EPEL 7.
https://admin.fedoraproject.org/updates/breathe-4.0.0-1.el7

Comment 11 Fedora Update System 2015-07-14 15:32:23 UTC
breathe-4.0.0-1.fc21 has been pushed to the Fedora 21 testing repository.

Comment 12 Fedora Update System 2015-08-02 19:29:29 UTC
breathe-4.0.0-1.el7 has been pushed to the Fedora EPEL 7 stable repository.

Comment 13 Fedora Update System 2015-08-03 04:27:47 UTC
breathe-4.0.0-1.fc21 has been pushed to the Fedora 21 stable repository.

Comment 14 Fedora Update System 2015-08-03 04:30:42 UTC
breathe-4.0.0-1.fc22 has been pushed to the Fedora 22 stable repository.


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