Bug 927470 - Review Request: python-genmsg - Python library for generating ROS message and service data
Summary: Review Request: python-genmsg - Python library for generating ROS message and...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Mario Blättermann
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On: catkin
Blocks: 927473 927475 927478 ros-std_msgs ros-common_msgs
TreeView+ depends on / blocked
 
Reported: 2013-03-26 02:12 UTC by Rich Mattes
Modified: 2013-07-04 00:57 UTC (History)
3 users (show)

Fixed In Version: python-genmsg-0.3.10-5.20130617git95ca00d.fc19
Clone Of:
Environment:
Last Closed: 2013-07-04 00:57:39 UTC
Type: ---
Embargoed:
mario.blaettermann: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)

Description Rich Mattes 2013-03-26 02:12:14 UTC
Spec URL: http://rmattes.fedorapeople.org/rospackages/genmsg/python-genmsg.spec
SRPM URL: http://rmattes.fedorapeople.org/rospackages/genmsg/python-genmsg-0.3.10-2.git7859688.fc18.src.rpm
Description:
genmsg decouples code generation for ROS messgae & service files from the 
parsing of these files, and from implementation details of the build system.

Fedora Account System Username: rmattes

rpmlint:
$ rpmlint python-genmsg.spec ../../RPMS/noarch/python-genmsg-0.3.10-2.git7859688.fc18.noarch.rpm 
python-genmsg.spec: W: invalid-url Source0: wg-debs-genmsg-release-upstream-0.3.10-0-g7859688.tar.gz
python-genmsg.noarch: W: no-documentation
python-genmsg.noarch: W: devel-file-in-non-devel-package /usr/share/pkgconfig/genmsg.pc
python-genmsg.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/genmsg/gentools.py 0644L /usr/bin/env
1 packages and 1 specfiles checked; 1 errors, 3 warnings

Not sure if the gentools.py file needs the /usr/bin/env, I'll investigate.

Comment 1 Mario Blättermann 2013-06-15 21:52:52 UTC
(In reply to Rich Mattes from comment #0)
> Not sure if the gentools.py file needs the /usr/bin/env, I'll investigate.

I'm quite sure no file in %{python_sitelib} needs a shebang and/or to be executable.

Just a few more comments:

The initial cleaning of buildroot in %install is obsolete, please drop it.

python-setuptools-devel is a virtual provide of python-setuptools, you might replace it by the latter.

The warning about a devel file in a non-devel package should be addressed. I don't know how to handle pkgconfig files in Python packages.

Comment 2 Rich Mattes 2013-06-18 00:36:07 UTC
Thanks Mario.  I was able to make the edits you pointed out and do some additional cleanup to the package.  The new spec and srpm can be found here:

Spec URL: http://rmattes.fedorapeople.org/rospackages/genmsg/python-genmsg.spec
SRPM URL: http://rmattes.fedorapeople.org/rospackages/genmsg/python-genmsg-0.3.10-3.20130617git95ca00d.fc19.src.rpm

rpmlint is cleaner now:
$ rpmlint python-genmsg.spec ../../RPMS/noarch/python-genmsg-0.3.10-3.20130617git95ca00d.fc19.noarch.rpm ../../RPMS/noarch/python-genmsg-devel-0.3.10-3.20130617git95ca00d.fc19.noarch.rpm 
python-genmsg.noarch: W: no-documentation
python-genmsg-devel.noarch: W: no-documentation
2 packages and 1 specfiles checked; 0 errors, 2 warnings.

Scratch build:
http://koji.fedoraproject.org/koji/taskinfo?taskID=5514829

Comment 3 Mario Blättermann 2013-06-22 07:32:54 UTC
$ rpmlint -i -v *python-genmsg.src: I: checking
python-genmsg.src: I: checking-url http://ros.org/doc/api/genmsg/html/ (timeout 10 seconds)
python-genmsg.src: I: checking-url https://github.com/ros/genmsg/archive/95ca00d77a6bad85b4719a25575862b964584f34/genmsg-0.3.10-95ca00d.tar.gz (timeout 10 seconds)
python-genmsg.noarch: I: checking
python-genmsg.noarch: I: checking-url http://ros.org/doc/api/genmsg/html/ (timeout 10 seconds)
python-genmsg.noarch: W: no-documentation
The package contains no documentation (README, doc, etc). You have to include
documentation files.

python-genmsg-devel.noarch: I: checking
python-genmsg-devel.noarch: I: checking-url http://ros.org/doc/api/genmsg/html/ (timeout 10 seconds)
python-genmsg-devel.noarch: W: no-documentation
The package contains no documentation (README, doc, etc). You have to include
documentation files.

python-genmsg.spec: I: checking-url https://github.com/ros/genmsg/archive/95ca00d77a6bad85b4719a25575862b964584f34/genmsg-0.3.10-95ca00d.tar.gz (timeout 10 seconds)
3 packages and 1 specfiles checked; 0 errors, 2 warnings.


There's no documentation in your package. But the tarball contains the "doc" subfolder with some useful info, please add it to the package.


Instead of repeating the summary in the description, you might use the description from the project website:
"Project genmsg exists in order to decouple code generation from .msg & .srv format files from the parsing of these files and from impementation details of the build system (project directory layout, existence or nonexistence of utilities like rospack, values of environment variables such as ROS_PACKAGE_PATH): i.e. none of these are required to be set in any particular way."


I take this for a full review.

Comment 4 Rich Mattes 2013-06-22 13:50:19 UTC
Updated package:

Spec URL: http://rmattes.fedorapeople.org/rospackages/genmsg/python-genmsg.spec
SRPM URL: http://rmattes.fedorapeople.org/rospackages/genmsg/python-genmsg-0.3.10-4.20130617git95ca00d.fc19.src.rpm

The spec now builds the html and manpage documentation in the doc directory.  I also updated the package's description to match the docs as you suggested. 

rpmlint:
$ rpmlint python-genmsg.spec ../../RPMS/noarch/python-genmsg*0.3.10-4*
python-genmsg.noarch: W: spelling-error %description -l en_US msg -> MSG, mag, ms
python-genmsg.noarch: W: spelling-error %description -l en_US srv -> RSV
python-genmsg.noarch: W: spelling-error %description -l en_US rospack -> aerospace
python-genmsg.noarch: W: manual-page-warning /usr/share/man/man1/genmsg.1.gz 175: warning: macro `msg' not defined
python-genmsg-devel.noarch: W: no-documentation
2 packages and 1 specfiles checked; 0 errors, 5 warnings.

scratch build:
http://koji.fedoraproject.org/koji/taskinfo?taskID=5530552

Comment 5 Mario Blättermann 2013-06-23 19:27:59 UTC
$ rpmlint -i -v *
python-genmsg.src: I: checking
python-genmsg.src: W: spelling-error %description -l en_US msg -> MSG, mag, ms
The value of this tag appears to be misspelled. Please double-check.

python-genmsg.src: W: spelling-error %description -l en_US srv -> RSV
The value of this tag appears to be misspelled. Please double-check.

python-genmsg.src: W: spelling-error %description -l en_US rospack -> aerospace
The value of this tag appears to be misspelled. Please double-check.

python-genmsg.src: I: checking-url http://ros.org/doc/api/genmsg/html/ (timeout 10 seconds)
python-genmsg.src: I: checking-url https://github.com/ros/genmsg/archive/95ca00d77a6bad85b4719a25575862b964584f34/genmsg-0.3.10-95ca00d.tar.gz (timeout 10 seconds)
python-genmsg.noarch: I: checking
python-genmsg.noarch: W: spelling-error %description -l en_US msg -> MSG, mag, ms
The value of this tag appears to be misspelled. Please double-check.

python-genmsg.noarch: W: spelling-error %description -l en_US srv -> RSV
The value of this tag appears to be misspelled. Please double-check.

python-genmsg.noarch: W: spelling-error %description -l en_US rospack -> aerospace
The value of this tag appears to be misspelled. Please double-check.

python-genmsg.noarch: I: checking-url http://ros.org/doc/api/genmsg/html/ (timeout 10 seconds)
python-genmsg.noarch: W: manual-page-warning /usr/share/man/man1/genmsg.1.gz 175: warning: macro `msg' not defined
This man page may contain problems that can cause it not to be formatted as
intended.

python-genmsg-devel.noarch: I: checking
python-genmsg-devel.noarch: I: checking-url http://ros.org/doc/api/genmsg/html/ (timeout 10 seconds)
python-genmsg-devel.noarch: W: no-documentation
The package contains no documentation (README, doc, etc). You have to include
documentation files.

python-genmsg.spec: I: checking-url https://github.com/ros/genmsg/archive/95ca00d77a6bad85b4719a25575862b964584f34/genmsg-0.3.10-95ca00d.tar.gz (timeout 10 seconds)
3 packages and 1 specfiles checked; 0 errors, 8 warnings.


The warning about a malformed manpage can be ignored, it looks as follows in the man page viewer:

"Project  genmsg exists in order to decouple code generation from .msg & .srv format files ..."

One issue, tough (I trust you that you'll change it before importing your package into Git):

Replace %{_mandir}/man1/%{stackname}.1.gz with %{_mandir}/man1/%{stackname}.1.* because the compression format for manpages depends on the rpm configuration. For now it is gzip but it could be changed. With a placeholder for the file extension you don't have to keep an eye on that.


OK, here we go:

---------------------------------
key:

[+] OK
[.] OK, not applicable
[X] needs work
---------------------------------

[+] MUST: rpmlint must be run on the source rpm and all binary rpms the build produces. The output should be posted in the review.
[+] MUST: The package must be named according to the Package Naming Guidelines.
[+] MUST: The spec file name must match the base package %{name}, in the format %{name}.spec unless your package has an exemption.
[+] MUST: The package must meet the Packaging Guidelines.
[+] MUST: The package must be licensed with a Fedora approved license and meet the Licensing Guidelines.
[+] MUST: The License field in the package spec file must match the actual license.
    BSD
[.] MUST: 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 must be included in %doc.
[+] MUST: The spec file must be written in American English.
[+] MUST: The spec file for the package MUST be legible.
[+] MUST: The sources used to build the package must match the upstream source, as provided in the spec URL. Reviewers should use sha256sum for this task as it is used by the sources file once imported into git. If no upstream URL can be specified for this package, please see the Source URL Guidelines for how to deal with this.
    $ sha256sum *
    07da4507e32f7feb58a1e3fe233ad51b3118df3f6498da855bc422ed62b9c945  genmsg-0.3.10-95ca00d.tar.gz
    07da4507e32f7feb58a1e3fe233ad51b3118df3f6498da855bc422ed62b9c945  genmsg-0.3.10-95ca00d.tar.gz.packaged

[+] MUST: The package MUST successfully compile and build into binary rpms on at least one primary architecture.
[.] MUST: If the package does not successfully compile, build or work on an architecture, then those architectures should be listed in the spec in ExcludeArch. Each architecture listed in ExcludeArch MUST have a bug filed in bugzilla, describing the reason that the package does not compile/build/work on that architecture. The bug number MUST be placed in a comment, next to the corresponding ExcludeArch line.
[+] MUST: All build dependencies must be listed in BuildRequires, except for any that are listed in the exceptions section of the Packaging Guidelines ; inclusion of those as BuildRequires is optional. Apply common sense.
[.] MUST: The spec file MUST handle locales properly. This is done by using the %find_lang macro. Using %{_datadir}/locale/* is strictly forbidden.
[.] MUST: Every binary RPM package (or subpackage) which stores shared library files (not just symlinks) in any of the dynamic linker's default paths, must call ldconfig in %post and %postun.
[.] MUST: Packages must NOT bundle copies of system libraries.
[.] MUST: If the package is designed to be relocatable, the packager must state this fact in the request for review, along with the rationalization for relocation of that specific package. Without this, use of Prefix: /usr is considered a blocker.
[+] MUST: A package must own all directories that it creates. If it does not create a directory that it uses, then it should require a package which does create that directory.
[+] MUST: A Fedora package must not list a file more than once in the spec file's %files listings. (Notable exception: license texts in specific situations)
[+] MUST: Permissions on files must be set properly. Executables should be set with executable permissions, for example.
[+] MUST: Each package must consistently use macros.
[+] MUST: The package must contain code, or permissable content.
[.] MUST: Large documentation files must go in a -doc subpackage. (The definition of large is left up to the packager's best judgement, but is not restricted to size. Large can refer to either size or quantity).
[+] MUST: If a package includes something as %doc, it must not affect the runtime of the application. To summarize: If it is in %doc, the program must run properly if it is not present.
[.] MUST: Static libraries must be in a -static package.
[+] MUST: Development files must be in a -devel package.
[+] MUST: In the vast majority of cases, devel packages must require the base package using a fully versioned dependency: Requires: %{name}%{?_isa} = %{version}-%{release}
    The %{?_isa} tag is not needed here because the package is noarch.

[.] MUST: Packages must NOT contain any .la libtool archives, these must be removed in the spec if they are built.
[.] MUST: Packages containing GUI applications must include a %{name}.desktop file, and that file must be properly installed with desktop-file-install in the %install section. If you feel that your packaged GUI application does not need a .desktop file, you must put a comment in the spec file with your explanation.
[+] MUST: Packages must not own files or directories already owned by other packages. The rule of thumb here is that the first package to be installed should own the files or directories that other packages may rely upon. This means, for example, that no package in Fedora should ever share ownership with any of the files or directories owned by the filesystem or man package. If you feel that you have a good reason to own a file or directory that another package owns, then please present that at package review time. 
[+] MUST: All filenames in rpm packages must be valid UTF-8.


[.] SHOULD: If the source package does not include license text(s) as a separate file from upstream, the packager SHOULD query upstream to include it.
[.] SHOULD: The description and summary sections in the package spec file should contain translations for supported Non-English languages, if available.
[+] SHOULD: The reviewer should test that the package builds in mock.
    See Koji build above (which uses Mock anyway).
[+] SHOULD: The package should compile and build into binary rpms on all supported architectures.
[.] SHOULD: The reviewer should test that the package functions as described. A package should not segfault instead of running, for example.
[+] SHOULD: If scriptlets are used, those scriptlets must be sane. This is vague, and left up to the reviewers judgement to determine sanity.
[.] SHOULD: Usually, subpackages other than devel should require the base package using a fully versioned dependency.
[+] SHOULD: The placement of pkgconfig(.pc) files depends on their usecase, and this is usually for development purposes, so should be placed in a -devel pkg. A reasonable exception is that the main pkg itself is a devel tool not installed in a user runtime, e.g. gcc or gdb.
[.] SHOULD: If the package has file dependencies outside of /etc, /bin, /sbin, /usr/bin, or /usr/sbin consider requiring the package which provides the file instead of the file itself.
[+] SHOULD: your package should contain man pages for binaries/scripts. If it doesn't, work with upstream to add them where they make sense.


----------------

PACKAGE APPROVED

----------------



Once the Rawhide package is present, I'll have a look at your other packages which depend on python-genmsg.

Comment 6 Rich Mattes 2013-06-23 22:23:47 UTC
Thanks!  I forgot about the wildcard requirement for the manpages, I'll make sure to fix that before the package gets built.

Comment 7 Rich Mattes 2013-06-23 22:25:05 UTC
New Package SCM Request
=======================
Package Name: python-genmsg
Short Description: Python library for generating ROS message and service data
Owners: rmattes
Branches: f18 f19 el6
InitialCC:

Comment 8 Gwyn Ciesla 2013-06-24 10:01:05 UTC
Git done (by process-git-requests).

Comment 9 Fedora Update System 2013-06-25 01:44:50 UTC
python-genmsg-0.3.10-5.20130617git95ca00d.fc19 has been submitted as an update for Fedora 19.
https://admin.fedoraproject.org/updates/python-genmsg-0.3.10-5.20130617git95ca00d.fc19

Comment 10 Fedora Update System 2013-06-25 21:16:48 UTC
python-genmsg-0.3.10-5.20130617git95ca00d.fc19 has been pushed to the Fedora 19 testing repository.

Comment 11 Fedora Update System 2013-07-04 00:57:39 UTC
python-genmsg-0.3.10-5.20130617git95ca00d.fc19 has been pushed to the Fedora 19 stable repository.


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