Bug 1057919 - Review Request: libflatarray - A library for highly efficient multi-dimensional array
Summary: Review Request: libflatarray - A library for highly efficient multi-dimension...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Denis Fateyev
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-01-26 01:39 UTC by Christopher Meng
Modified: 2014-03-03 20:04 UTC (History)
2 users (show)

Fixed In Version: libflatarray-0.1.1-1.el6
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-02-25 07:48:05 UTC
Type: ---
Embargoed:
denis: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)

Description Christopher Meng 2014-01-26 01:39:39 UTC
Spec URL: http://cicku.me/libflatarray.spec
SRPM URL: http://cicku.me/libflatarray-0.1.1-1.fc21.src.rpm
Description: LibFlatArray acts as a highly efficient multi-dimensional array of
arbitrary objects (array of structs, AoS), but really uses a struct of
arrays (SoA) memory layout. It's great for writing vectorized code and
its lightning-fast iterators give you access to neighboring elements
with zero address generation overhead.

Use cases include:
- computer simulations (e.g. stencil codes such as Lattice Boltzmann Methods)
- image processing (e.g. Gaussian filters)
- numerical methods (e.g. multiplication of complex matrices)

The library is written in C++ and uses templates to shift the burden
of address computation from runtime to compile time. It shares some
infrastructure with its parent project LibGeoDecomp.
Fedora Account System Username: cicku

NOTE: This library used to be bundled in libgeodecomp(I will package it later), and I splited it out and persuade upstream to release as separate project. Currently it's a header-only project, I've noticed some remarks in FPC so if the way I deal with such packages is wrong, please designate ASAP.

Comment 1 Denis Fateyev 2014-02-08 16:39:09 UTC
Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
[ ] = Manual review needed



===== 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.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses found:
     "BSL (v1.0)", "Unknown or generated". 3 files have unknown license.
     Detailed output of licensecheck in
     /home/mock/sandbox/1057919-libflatarray/licensecheck.txt
[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.
[-]: 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.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 3 files.
[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]: 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.
[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]: 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 do not use a name that already exist
[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]: Packages must not store files under /srv, /opt or /usr/local

===== SHOULD items =====

Generic:
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: 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).
[x]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: 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.
[x]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed files.
[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]: Dist tag is present (not strictly required in GL).
[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: No rpmlint messages.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: libflatarray-devel-0.1.1-1.fc20.noarch.rpm
          libflatarray-0.1.1-1.fc20.src.rpm
libflatarray.src: W: spelling-error Summary(en_US) multi -> mulch, mufti
libflatarray.src: W: spelling-error %description -l en_US multi -> mulch, mufti
libflatarray.src: W: spelling-error %description -l en_US structs -> struts, instructs, destructs
libflatarray.src: W: spelling-error %description -l en_US struct -> strict, strut, struck
libflatarray.src: W: spelling-error %description -l en_US vectorized -> factorized, vectored
libflatarray.src: W: spelling-error %description -l en_US runtime -> run time, run-time, rudiment
libflatarray.src:30: W: macro-in-comment %{name}
libflatarray.src:30: W: macro-in-comment %{version}
libflatarray.src:30: W: macro-in-comment %{release}
2 packages and 0 specfiles checked; 0 errors, 9 warnings.



Rpmlint (installed packages)
----------------------------
# rpmlint libflatarray-devel
1 packages and 0 specfiles checked; 0 errors, 0 warnings.
# echo 'rpmlint-done:'



Requires
--------
libflatarray-devel (rpmlib, GLIBC filtered):



Provides
--------
libflatarray-devel:
    libflatarray-devel



Source checksums
----------------
http://www.libgeodecomp.org/archive/libflatarray-0.1.1.tar.bz2 :
  CHECKSUM(SHA256) this package     : 3287f0ab1e670f3a2c43dd42de6399a8f853453f228e45076339ec31ea68cb56
  CHECKSUM(SHA256) upstream package : 3287f0ab1e670f3a2c43dd42de6399a8f853453f228e45076339ec31ea68cb56


Generated by fedora-review 0.5.1 (bb9bf27) last change: 2013-12-13
Command line :/usr/bin/fedora-review -b 1057919
Buildroot used: fedora-20-x86_64
Active plugins: Generic, Shell-api
Disabled plugins: Java, C/C++, Python, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP, Ruby
Disabled flags: EXARCH, EPEL5, BATCH, DISTTAG



licensecheck.txt:
----------------
BSL (v1.0)
----------
libflatarray-0.1.1/examples/charged_particles/main.cpp
libflatarray-0.1.1/examples/jacobi/main.cpp
libflatarray-0.1.1/examples/lbm/update_lbm_classic.h
libflatarray-0.1.1/examples/lbm/update_lbm_cuda_flat_array.h
libflatarray-0.1.1/examples/lbm/update_lbm_object_oriented.h
libflatarray-0.1.1/examples/lbm/util.h
libflatarray-0.1.1/src/aligned_allocator.hpp
libflatarray-0.1.1/src/cuda_allocator.hpp
libflatarray-0.1.1/src/flat_array.hpp
libflatarray-0.1.1/test/aligned_allocator_test.cpp
libflatarray-0.1.1/test/soa_array_test.cpp
libflatarray-0.1.1/test/soa_grid_test.cpp

Unknown or generated
--------------------
libflatarray-0.1.1/examples/lbm/cell.h
libflatarray-0.1.1/examples/lbm/cudalineupdatefunctorprototype.h
libflatarray-0.1.1/test/test.h


Review summary:
---------------
There are a few files that haven't been covered with a license (see 'licensecheck' above). Except this issue and possible remarks from FPC, everything is fine.

Comment 2 Michael Schwendt 2014-02-09 09:12:08 UTC
> Summary:        A library for highly efficient multi-dimensional array

I would find it worthwhile to mention that it's a header-only library or "header-only API" and written in C++:

  Summary: C++ template library for highly efficient multi-dimensional arrays

Writing "arrays" instead of "array" sounds like more correct English. Unless it can only be used for a single array, and then I would insert "a" before "highly".


> BuildArch:      noarch

It is beneficial to build header-only src.pms arch-specific, which would be the only way to test-build anything for all target archs and to run a test-suite arch-specific (e.g. in a %check section).

The libflatarray build process clearly compiles several files, but I haven't checked whether it runs those from the "test" subdir.

Whether the -devel subpackage may be "noarch" depends solely on its contents.


> %package        devel

Treating them like static libs (since the header-only stuff will be built in) is not a strict requirement yet, but helpful.
  Provides: libflatarray-static = %{version}-%{release}

The FPC ticket "Guidelines needed for header only libraries" is still open:
https://fedorahosted.org/fpc/ticket/337


> %description    devel
> This package contains libraries and header files for
> developing applications that use %{name}.

No libraries included.


> %install
> make install DESTDIR=%{buildroot}

Nowadays there is %make_install (rpm -E %make_install), which saves some typing.

Comment 3 Christopher Meng 2014-02-11 02:11:04 UTC
(In reply to Michael Schwendt from comment #2)
> > Summary:        A library for highly efficient multi-dimensional array
> 
> I would find it worthwhile to mention that it's a header-only library or
> "header-only API" and written in C++:
> 
>   Summary: C++ template library for highly efficient multi-dimensional arrays
> 
> Writing "arrays" instead of "array" sounds like more correct English. Unless
> it can only be used for a single array, and then I would insert "a" before
> "highly".

Ok.

> > BuildArch:      noarch
> 
> It is beneficial to build header-only src.pms arch-specific, which would be
> the only way to test-build anything for all target archs and to run a
> test-suite arch-specific (e.g. in a %check section).
> 
> The libflatarray build process clearly compiles several files, but I haven't
> checked whether it runs those from the "test" subdir.
> 
> Whether the -devel subpackage may be "noarch" depends solely on its contents.

Currently it's noarch, but I will remove the buildarch mark since it may become a shared library in the future.

> > %package        devel
> 
> Treating them like static libs (since the header-only stuff will be built
> in) is not a strict requirement yet, but helpful.
>   Provides: libflatarray-static = %{version}-%{release}
> 
> The FPC ticket "Guidelines needed for header only libraries" is still open:
> https://fedorahosted.org/fpc/ticket/337

I may add this later when the fpc ticket comes true.

> > %description    devel
> > This package contains libraries and header files for
> > developing applications that use %{name}.
> 
> No libraries included.

Preserved for the future. This library may provide shared libraries later(confirmed by upstream), so I don't want to change the description.

> > %install
> > make install DESTDIR=%{buildroot}
> 
> Nowadays there is %make_install (rpm -E %make_install), which saves some
> typing.

Any issues around still? If not I think Denis can approve this, thank you all!

Comment 4 Denis Fateyev 2014-02-11 19:11:41 UTC
I think there are no stoppers, and all the details mentioned above can be fixed shortly or gradually (including missing license header for a couple of files).
Otherwise, this package is APPROVED.

Comment 5 Christopher Meng 2014-02-13 02:00:17 UTC
New Package SCM Request
=======================
Package Name: libflatarray
Short Description: C++ template library for highly efficient multi-dimensional arrays
Owners: cicku
Branches: f20 el6 epel7

Comment 6 Gwyn Ciesla 2014-02-13 12:57:06 UTC
Git done (by process-git-requests).

Comment 7 Christopher Meng 2014-02-14 01:22:28 UTC
(In reply to Michael Schwendt from comment #2)
> > %package        devel
> 
> Treating them like static libs (since the header-only stuff will be built
> in) is not a strict requirement yet, but helpful.
>   Provides: libflatarray-static = %{version}-%{release}
> 
> The FPC ticket "Guidelines needed for header only libraries" is still open:
> https://fedorahosted.org/fpc/ticket/337

Fixed!

Comment 8 Fedora Update System 2014-02-14 01:55:43 UTC
libflatarray-0.1.1-1.el6 has been submitted as an update for Fedora EPEL 6.
https://admin.fedoraproject.org/updates/libflatarray-0.1.1-1.el6

Comment 9 Fedora Update System 2014-02-14 01:55:51 UTC
libflatarray-0.1.1-1.fc20 has been submitted as an update for Fedora 20.
https://admin.fedoraproject.org/updates/libflatarray-0.1.1-1.fc20

Comment 10 Fedora Update System 2014-02-15 06:57:02 UTC
libflatarray-0.1.1-1.fc20 has been pushed to the Fedora 20 testing repository.

Comment 11 Fedora Update System 2014-02-25 07:48:05 UTC
libflatarray-0.1.1-1.fc20 has been pushed to the Fedora 20 stable repository.

Comment 12 Fedora Update System 2014-03-03 20:04:48 UTC
libflatarray-0.1.1-1.el6 has been pushed to the Fedora EPEL 6 stable repository.


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