Bug 642637 - Review Request: antlr-maven-plugin - Maven plugin that generates files based on grammar file(s)
Summary: Review Request: antlr-maven-plugin - Maven plugin that generates files based ...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Alexander Kurtakov
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2010-10-13 13:30 UTC by Tom "spot" Callaway
Modified: 2010-10-19 09:11 UTC (History)
4 users (show)

Fixed In Version: antlr3-3.2-11.fc14
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2010-10-19 09:11:09 UTC
Type: ---
Embargoed:
akurtako: fedora-review+
tcallawa: fedora-cvs+


Attachments (Terms of Use)

Description Tom "spot" Callaway 2010-10-13 13:30:19 UTC
Spec URL: http://www.auroralinux.org/people/spot/review/new/antlr-maven-plugin.spec 
SRPM URL: http://www.auroralinux.org/people/spot/review/new/antlr-maven-plugin-2.1-1.20101012svn12849.fc14.src.rpm
Description: 
The Antlr Plugin has two goals:
- antlr:generate Generates file(s) to a target directory based on grammar
  file(s).
- antlr:html Generates Antlr report for grammar file(s).

NOTE: This package is a build dependency for antlr3.

Comment 1 Tom "spot" Callaway 2010-10-13 13:30:48 UTC
Koji F14 scratch build: http://koji.fedoraproject.org/koji/taskinfo?taskID=2532325.

Comment 2 Colin Walters 2010-10-13 13:39:46 UTC
(not a full review)

# svn checkout https://svn.codehaus.org/mojo/tags/antlr-maven-plugin-2.1 antlr-maven-plugin
# find antlr-maven-plugin -depth -name .svn -type d -exec rm -rf {} \;

"svn export"?

Patch0:			maven-antlr-plugin-2.1-modello-issue.patch
Patch1:			maven-antlr-plugin-2.1-artifact.patch
Patch2:			maven-antlr-plugin-2.1-sinkfix.patch

Each of these should have a rationale comment:
https://fedoraproject.org/wiki/Packaging:Guidelines#All_patches_should_have_an_upstream_bug_link_or_comment

(Though personally I've switched to using git format-patch patches for upstreams which use git, since it allows longer explanations and as a bonus makes it easy for upstream to merge the patch; but in this case upstream is svn)

Comment 3 Tom "spot" Callaway 2010-10-13 14:04:18 UTC
- add post/postun
- fix pom filename
- svn export
- comment patchset
- provides for maven-antlr-plugin
- drop unnecessary symlinks
- use maven macros

Spec URL:
http://www.auroralinux.org/people/spot/review/new/antlr-maven-plugin.spec 
SRPM URL:
http://www.auroralinux.org/people/spot/review/new/antlr-maven-plugin-2.1-2.20101012svn12849.fc14.src.rpm

Comment 4 Alexander Kurtakov 2010-10-13 14:15:59 UTC
I'm taking this one.

Comment 5 Alexander Kurtakov 2010-10-13 14:41:01 UTC
Key:
- = N/A
x = Check
! = Problem
? = Not evaluated


=== REQUIRED ITEMS ===
[X]  Rpmlint output:
antlr-maven-plugin-javadoc.noarch: W: spelling-error Summary(en_US) Javadocs -> Java docs, Java-docs, Javanese
antlr-maven-plugin.noarch: W: spelling-error %description -l en_US html -> HTML, ht ml, ht-ml
False positive.
antlr-maven-plugin.noarch: W: no-documentation
No documentation.
antlr-maven-plugin.noarch: W: non-conffile-in-etc /etc/maven/fragments/antlr-maven-plugin
False positive.
[X]  Package is named according to the Package Naming Guidelines[1].
[X]  Spec file name must match the base package name, in the format %{name}.spec.
[X]  Package meets the Packaging Guidelines[2].
[X]  Package successfully compiles and builds into binary rpms.
[X]  Buildroot is correct (%{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n))
[X]  Package is licensed with an open-source compatible license and meets other legal requirements as defined in the legal section of Packaging Guidelines[3,4].
[X]  License field in the package spec file matches the actual license.
License type: ASL 2.0
[-]  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.
[-]  All independent sub-packages have license of their own
[-]  Spec file is legible and written in American English.
[-]  Sources used to build the package matches the upstream source, as provided in the spec URL.
[-]  All build dependencies are listed in BuildRequires, except for any that are listed in the exceptions section of Packaging Guidelines[5].
[X]  Package must own all directories that it creates.
[X]  Package requires other packages for directories it uses.
[X]  Package does not contain duplicates in %files.
[X]  Permissions on files are set properly.
[X]  Package has a %clean section, which contains rm -rf %{buildroot} (or $RPM_BUILD_ROOT).
[X]  Package consistently uses macros.
[X]  Package contains code, or permissable content.
[X]  Fully versioned dependency in subpackages, if present.
[-]  Package contains a properly installed %{name}.desktop file if it is a GUI application.
[!]  Package does not own files or directories owned by other packages.
It owns %{_mavendepmapfragdir} please change it to %{_mavendepmapfragdir}/*
[X]  Javadoc documentation files are generated and included in -javadoc subpackage
[X]  Packages have proper BuildRequires/Requires on jpackage-utils
[X]  Javadoc subpackages have Require: jpackage-utils
[X]  Package uses %global not %define
[X]  If package uses tarball from VCS include comment how to re-create that tarball (svn export URL, git clone URL, ...)
[X]  If source tarball includes bundled jar/class files these need to be removed prior to building
[X]  All filenames in rpm packages must be valid UTF-8.

=== Maven ===
[X]  Use %{_mavenpomdir} macro for placing pom files instead of %{_datadir}/maven2/poms
[X]  If package uses "-Dmaven.test.skip=true" explain why it was needed in a comment
[-]  If package uses custom depmap "-Dmaven2.jpp.depmap.file=*" explain why it's needed in a comment
[X]  Package uses %update_maven_depmap in %post/%postun
[X]  Packages have Requires(post) and Requires(postun) on jpackage-utils (for %update_maven_depmap macro)

=== Other suggestions ===
[X]  If possible use upstream build method (maven/ant/javac)
[X]  Jar files are installed to %{_javadir}/%{name}-%{version}.jar with %{_javadir}/%{name}.jar (unversioned) symlink
[X]  If package contains pom.xml files install it (including depmaps) even when building with ant 
[X]  Avoid having BuildRequires on exact NVR unless necessary
[X]  Package has BuildArch: noarch (if possible)
[X]  Latest version is packaged.


=== Issues ===
1. Package should not own %{_mavendepmapfragdir} but %{_mavendepmapfragdir}/*
2. We don't need BuildArch set to noarch for javadoc subpackage as the whole package is noarch.
3. Why do you add provides for maven-antlr-plugin?? If it was for the old package it was named maven2-plugin-antlr so we have to either change the Provides to the old name or remove it. I would also prefer to have obsolete too so we are sure that it is replaced by this package.

Comment 6 Tom "spot" Callaway 2010-10-13 14:52:48 UTC
Issues resolved:
- fix provides/obsoletes to replace old (dead) package
- don't own mavendepmapfragdir, just the files inside it
- don't set buildarch on javadoc (entire package is noarch already)

Spec URL:
http://www.auroralinux.org/people/spot/review/new/antlr-maven-plugin.spec 
SRPM URL:
http://www.auroralinux.org/people/spot/review/new/antlr-maven-plugin-2.1-3.20101012svn12849.fc14.src.rpm

Comment 7 Alexander Kurtakov 2010-10-13 14:55:11 UTC
Thanks,

This package is APPROVED.

Comment 8 Tom "spot" Callaway 2010-10-13 14:58:15 UTC
New Package SCM Request
=======================
Package Name: antlr-maven-plugin
Short Description: Maven plugin that generates files based on grammar file(s)
Owners: spot
Branches: f14 devel

Comment 9 Tom "spot" Callaway 2010-10-13 15:21:47 UTC
Git done (by process-git-requests).

Comment 10 Fedora Update System 2010-10-13 19:46:18 UTC
antlr3-3.2-11.fc14,antlr-maven-plugin-2.1-3.20101012svn12849.fc14 has been submitted as an update for Fedora 14.
https://admin.fedoraproject.org/updates/antlr3-3.2-11.fc14,antlr-maven-plugin-2.1-3.20101012svn12849.fc14

Comment 11 Fedora Update System 2010-10-13 21:21:26 UTC
antlr3-3.2-11.fc14, antlr-maven-plugin-2.1-3.20101012svn12849.fc14 has been pushed to the Fedora 14 testing repository.  If problems still persist, please make note of it in this bug report.
 If you want to test the update, you can install it with 
 su -c 'yum --enablerepo=updates-testing update antlr3 antlr-maven-plugin'.  You can provide feedback for this update here: https://admin.fedoraproject.org/updates/antlr3-3.2-11.fc14,antlr-maven-plugin-2.1-3.20101012svn12849.fc14

Comment 12 Fedora Update System 2010-10-19 09:10:50 UTC
antlr3-3.2-11.fc14, antlr-maven-plugin-2.1-3.20101012svn12849.fc14 has been pushed to the Fedora 14 stable repository.  If problems still persist, please make note of it in this bug report.


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