Bug 527306 - Review Request: jericho-html - Jericho HTML Parser
Summary: Review Request: jericho-html - Jericho HTML Parser
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Stanislav Ochotnicky
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 607076
TreeView+ depends on / blocked
 
Reported: 2009-10-05 21:20 UTC by Orion Poplawski
Modified: 2010-06-28 17:47 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2010-06-28 17:47:08 UTC
Type: ---
Embargoed:
sochotni: fedora-review+
j: fedora-cvs+


Attachments (Terms of Use)

Description Orion Poplawski 2009-10-05 21:20:06 UTC
Spec URL: http://www.cora.nwra.com/~orion/fedora/jericho-html.spec
SRPM URL: http://www.cora.nwra.com/~orion/fedora/jericho-html-3.1-1.fc11.src.rpm 

Description:

Jericho HTML Parser is a java library allowing analysis and manipulation of
parts of an HTML document, including server-side tags, while reproducing
verbatim any unrecognised or invalid HTML. It also provides high-level HTML
form manipulation functions.

It is an open source library released under both the Eclipse Public License
(EPL) and GNU Lesser General Public License (LGPL). You are therefore free to
use it in commercial applications subject to the terms detailed in either one
of these licence documents.

Comment 1 Stanislav Ochotnicky 2010-06-08 10:52:23 UTC
I will do the review

Comment 2 Stanislav Ochotnicky 2010-06-08 10:53:25 UTC
Your spec file and spec file inside src.rpm differ. You will have to fix that before I start official review.

Comment 3 Alexander Kurtakov 2010-06-23 07:02:32 UTC
Orion: Are you interested in doing it?

Comment 5 Stanislav Ochotnicky 2010-06-25 13:27:45 UTC
NEEDSWORK: rpmlint must be run on every package. The output should be posted in the review.
jericho-html.noarch: W: spelling-error %description -l en_US unrecognised -> unrecognized, unrecognizable, unrecognizably
jericho-html.noarch: W: spelling-error %description -l en_US licence -> license, licente, licentiate
jericho-html-javadoc.noarch: W: spelling-error Summary(en_US) Javadocs -> Java docs, Java-docs, Javanese
jericho-html-javadoc.noarch: W: non-standard-group Development Documentation
2 packages and 0 specfiles checked; 0 errors, 4 warnings.

You need to change Group of javadoc to "Development/Documentation". I
also don't think that proper group for main package is "System
Environment/Libraries". More like "Java Development".

OK: The package must be named according to the Package Naming Guidelines .
OK: The spec file name must match the base package %{name}, in the format %{name}.spec unless your package has an exemption.  .
OK: The package must meet the Packaging Guidelines .
OK: The package must be licensed with a Fedora approved license and meet the Licensing Guidelines .
OK: The License field in the package spec file must match the actual license. 
OK: 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.
OK: The spec file must be written in American English. 
OK: The spec file for the package MUST be legible. 
OK: The sources used to build the package must match the upstream source, as provided in the spec URL. Reviewers should use md5sum for this task. If no upstream URL can be specified for this package, please see the Source URL Guidelines for how to deal with this.
OK: The package MUST successfully compile and build into binary rpms on at least one primary architecture. 
NEEDSWORK: 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.

You are missing java and jpackage-utils in Requires. See:
https://fedoraproject.org/wiki/Packaging:Java#BuildRequires_and_Requires

Please also note that in current rawhide jakarta-commons-logging is
called apache-commons-logging so it would be better to change this
accordingly once you will be committing the package to devel branch.

OK: Packages must NOT bundle copies of system libraries.
OK: 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. 
OK: A Fedora package must not list a file more than once in the spec file's %files listings. 
OK: Permissions on files must be set properly. Executables should be set with executable permissions, for example. Every %files section must include a %defattr(...) line. 
OK: Each package must consistently use macros. 
OK: The package must contain code, or permissable content. 
OK: 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). 
OK: 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. 
OK: 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. 
OK: All filenames in rpm packages must be valid UTF-8. 

Other:

You do:
> cp dist/%{name}-%{version}.jar samples/webapps/JerichoHTML/WEB-INF/lib

to give back jericho jar so that sample will work. I would strongly
recommend instead creating symlink to file in %{_javadir} during install phase.

Please also use more descriptive Summary, current one doesn't say
much. You can basically use first sentence from Description, e.g. 
"Java library allowing analysis and manipulation of parts of an HTML document"

I would also recommend contacting upstream and working with them on making
use of some build system, be it maven or ant or something
different. Re-doing all compiling in spec file is just ugly (this
doesn't affect approval, it's just for future reference).


Once you fix mentioned problems, I can re-check and approve this package.

Comment 6 Orion Poplawski 2010-06-25 15:19:57 UTC
Thanks for the review.

http://www.cora.nwra.com/~orion/fedora/jericho-html.spec
http://www.cora.nwra.com/~orion/fedora/jericho-html-3.1-2.fc13.src.rpm

* Fri Jun 25 2010 Orion Poplawski <orion.com> - 3.1-2
- Fix spelling errors
- Change package groups
- Fix Requires and BuildRequires
- Fix Summary
- Don't need to copy library for tests

Comment 7 Stanislav Ochotnicky 2010-06-28 09:09:55 UTC
Ok, I am sorry for this, but I made a mistake when telling you to change group to "Development/Documentation" it was supposed to be just "Documentation" (I had to correct that exact problem so many times I remembered it as correct solution). It is supposed to be just "Documentation". Also there is no group "Development/Libraries/Java". Please look into /usr/share/doc/rpm-X.Y.Z/GROUPS and pick one from there.

> - Don't need to copy library for tests  

You removed copying of jar file not for testing but for samples, and I believe that sample will now stop working. Your change was:

61d61
< cp dist/%{name}-%{version}.jar samples/webapps/JerichoHTML/WEB-INF/lib

Now the JerichoHTML.war is missing jericho dependency. Why not just create symlink of jericho jar file into samples/webapps/JerichoHTML/WEB-INF/lib and install that without even creating the war file. I don't see any reason why we should have both the war and the unpacked version.

Comment 8 Orion Poplawski 2010-06-28 15:30:02 UTC
http://www.cora.nwra.com/~orion/fedora/jericho-html.spec
http://www.cora.nwra.com/~orion/fedora/jericho-html-3.1-3.fc13.src.rpm

* Mon Jun 28 2010 Orion Poplawski <orion.com> - 3.1-3
- Fix Groups again
- Link to jar in sample webapp
- Don't package webapp as war

Comment 9 Stanislav Ochotnicky 2010-06-28 15:55:49 UTC
Great, everything seems to be in order now. Sorry for that wrong group change suggestion again.

Package is APPROVED.

Comment 10 Orion Poplawski 2010-06-28 16:26:57 UTC
New Package CVS Request
=======================
Package Name: jericho-html
Short Description: Java library allowing analysis and manipulation of parts of an HTML document
Owners: orion
Branches: F-13 F-12 EL-6
InitialCC:

Comment 11 Jason Tibbitts 2010-06-28 16:42:49 UTC
CVS done (by process-cvs-requests.py).

Comment 12 Orion Poplawski 2010-06-28 17:47:08 UTC
Checked in and built.  Thanks everyone.


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