[Bug 622314] Review request: 3Depict- Valued point cloud visualisation and analysis

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Please do not reply directly to this email. All additional
comments should be made in the comments box of this bug.


https://bugzilla.redhat.com/show_bug.cgi?id=622314

Damian Wrobel <dwrobel@xxxxxxxxxxxxxxxxxx> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |dwrobel@xxxxxxxxxxxxxxxxxx,
                   |                            |martin.gieseking@xxxxxx

--- Comment #1 from Damian Wrobel <dwrobel@xxxxxxxxxxxxxxxxxx> 2010-09-20 14:45:08 EDT ---
Hi, I did an un-official(informal) package review for the 3Depict, please find
some initial comments.
As it's one of my first package review please be understanding if something is
not perfect.

- MUST: rpmlint must be run on every package. The output should be posted in
the review.

rpmlint 3Depict-0.0.1-1.fc13.src.rpm 3Depict-0.0.1-1.fc13.i686.rpm
3Depict-debuginfo-0.0.1-1.fc13.i686.rpm 
3 packages and 0 specfiles checked; 0 errors, 0 warnings.

OK

- MUST: The package must be named according to the Package Naming Guidelines.

OK

- MUST: The spec file name must match the base package %{name}, in the format
%{name}.spec unless your package has an exemption.

OK

- MUST: The package must meet the Packaging Guidelines.

$rpmls 3Depict-0.0.1-1.fc13.i686.rpm | grep .so | wc -l
0

a) As the package do not provide any shared libraries[1], it seems to be not
necessary to have in the spec file the following lines:

%post -p /sbin/ldconfig
%postun -p /sbin/ldconfig

b) There is a binary blob (3Depict-0.0.1/src/FreeSans.ttf) which should be
removed from tarball or at least in the %prep section.

c) The configure seems to check for existance of GL and PNG libraries but
there is a following definition in the spec file, which shouldn't be necessary:
export LDFLAGS="-lGL -lpng"


NOT OK

- MUST: The package must be licensed with a Fedora approved license and meet
the Licensing Guidelines.

OK, GPLv3+

- MUST: The License field in the package spec file must match the actual
license.

OK.

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

OK

- MUST: The spec file must be written in American English. 

OK. With remark that it's probably reasonable to consider to change the
Summary:
-Summary: Valued 3D point cloud visualization and analysis
with
+Summary: 3D point cloud visualization and analysis program


- MUST: The spec file for the package MUST be legible. 

OK

- MUST: 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.

$spectool 3Depict.spec | grep Source0 | awk '{print $2}' | wget -i - -O - -o
/dev/null | md5sum
3040bc31eb884c7882fc8c446d1f2a34  -

$ rpmdev-md5 3Depict-0.0.1-1.fc13.src.rpm  | grep .tar
3040bc31eb884c7882fc8c446d1f2a34  3Depict-0.0.1.tar.gz

OK

- MUST: The package MUST successfully compile and build into binary rpms on at
least one primary architecture. 

Frankly speaking it compiles, but only thanks to the following hack in the spec
file:
export LDFLAGS="-lGL -lpng"
which should be removed and the configure itself using appropriately pkg-config
tool should compose compiler/linker command line adequately.

To automatically check for existance of the libpng, please consider to use to
PKG_CHECK_MODULES macro:
PKG_CHECK_MODULES(PNG, libpng >= 1.2)
Then you can obtain linker and compiler options in the PNG_LIBS and PNG_CFLAGS
variables respectively.
This should allows you to remove some of the #ifdefs in the code like the
followings:

#if defined(__WIN32) || defined(__WIN64) || defined(__CYGWIN__)
#include <libpng/png.h>
#else
#include <png.h>
#endif

and

#if PNG_LIBPNG_VER < 10200
#error Requires libpng version 1.2.0 or greater!
#endif                

Apart from that there are a lot of warnings which is worth to consider to be
corrected. Notably:
a) no return statement in function returning non-void (e.g. scene.h:276:69),
b) variable may be used uninitialized in this function (e.g. uniqueID in
3Depict.cpp:624:16),
c) dereferencing type-punned pointer will break strict-aliasing rules (e.g.
endianTest.h:57:32).

NOT OK

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

Ditto.
NOT OK.

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

There is no BR: for libpng.
NOT OK.

- MUST: The spec file MUST handle locales properly. This is done by using the
%find_lang macro. Using %{_datadir}/locale/* is strictly forbidden.

OK

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

OK

- MUST: Packages must NOT OK bundle copies of system libraries.

OK

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

OK

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

OK. But according to the Packaging Guide[2] it would be recommended to
construct the %files section as following:
%files
%defattr(-,root,root,-)
%doc COPYING AUTHORS ChangeLog README TODO
%{_bindir}/%{name}
%dir %{_datadir}/%{name}
%dir %{_datadir}/%{name}/textures
%{_datadir}/%{name}/textures/*.png
%{_datadir}/applications/%{name}.desktop
%{_mandir}/man1/%{name}.1.gz

to avoid unowned/unwanted directories/files.

- 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)

OK

- MUST: 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

- MUST: Each package must consistently use macros.

$ [ `grep {buildroot} 3Depict.spec | wc -l` -gt 0 -a `grep RPM_BUILD_ROOT
3Depict.spec | wc -l` -gt 0 ] && echo "NOT OK"
NOT OK

It looks that both %{buildroot} and $RPM_BUILD_ROOT macros are being used.
You should just pick up one and use it consistently throughout your package[3].

NOT OK.


- MUST: The package must contain code, or permissable content.

OK

- 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).

OK

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

OK

- MUST: Header files must be in a -devel package.

OK

- MUST: Static libraries must be in a -static package.

OK

- MUST: If a package contains library files with a suffix (e.g. libfoo.so.1.1),
then library files that end in .so (without suffix) must go in a -devel
package.

OK

- MUST: In the vast majority of cases, devel packages must require the base
package using a fully versioned dependency: Requires: %{name} =
%{version}-%{release}

OK

- MUST: Packages must NOT OK contain any .la libtool archives, these must be
removed in the spec if they are built.

OK

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

NOT OK. See note about macro consistency.

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

OK

- MUST: All filenames in rpm packages must be valid UTF-8.

OK

References:
[1]. https://fedoraproject.org/wiki/Packaging/Guidelines#Compiler_flags
[2]. https://fedoraproject.org/wiki/Packaging:UnownedDirectories
[3].
https://fedoraproject.org/wiki/Packaging/Guidelines#Using_.25.7Bbuildroot.7D_and_.25.7Boptflags.7D_vs_.24RPM_BUILD_ROOT_and_.24RPM_OPT_FLAGS


Please also consider to correct the following small inconsistency:

man 3Depict says: 3depict - program to do something

's/3depict - program to do something/3Depict - 3D point cloud visualization and
analysis/'

-- 
Configure bugmail: https://bugzilla.redhat.com/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.
_______________________________________________
package-review mailing list
package-review@xxxxxxxxxxxxxxxxxxxxxxx
https://admin.fedoraproject.org/mailman/listinfo/package-review


[Index of Archives]     [Fedora Legacy]     [Fedora Desktop]     [Fedora SELinux]     [Yosemite News]     [KDE Users]     [Fedora Tools]