Bug 2274949 - Review Request: openxr-simple-playground - OpenXR C Playground
Summary: Review Request: openxr-simple-playground - OpenXR C Playground
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Davide Cavalca
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2024-04-14 00:32 UTC by Jonathan Steffan
Modified: 2024-05-04 19:17 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2024-05-04 19:17:51 UTC
Type: ---
Embargoed:
davide: fedora-review+


Attachments (Terms of Use)

Description Jonathan Steffan 2024-04-14 00:32:13 UTC
Spec URL: https://jsteffan.fedorapeople.org/imrsv/openxr-simple-playground.spec
SRPM URL: https://jsteffan.fedorapeople.org/imrsv/openxr-simple-playground-0-1.20240318git811d06a.fc39/openxr-simple-playground-0-1.20240318git811d06a.fc39.src.rpm
Description:

This example exercises many areas of the OpenXR API. Some 
parts of the API are abstracted, though the abstractions 
are intentionally kept simple for simple editing.

This is valuable to add to Fedora for debugging/testing/QA purposes.

Fedora Account System Username: jsteffan

Comment 1 Davide Cavalca 2024-04-21 03:05:25 UTC
===== MUST items =====

C/C++:
[-]: Provides: bundled(gnulib) in place as required.
     Note: Sources not installed
[x]: Package does not contain kernel modules.
[x]: If your application is a C or C++ application you must list a
     BuildRequires against gcc, gcc-c++ or clang.
[x]: Header files in -devel subpackage, if present.
[x]: Package does not contain any libtool archives (.la)
[x]: Package contains no static executables.
[x]: Rpath absent or only used for internal libs.

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.
[-]: 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 %license.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "Boost Software License 1.0", "*No
     copyright* MIT License", "Apache License 2.0". 3 files have unknown
     license. Detailed output of licensecheck in /tmp/2274949-openxr-
     simple-playground/licensecheck.txt
[-]: License file installed when any subpackage combination is installed.
[x]: %build honors applicable compiler flags or justifies otherwise.
[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.
[x]: Package contains systemd file(s) if in need.
[x]: Useful -debuginfo package or justification otherwise.
[x]: Package is not known to require an ExcludeArch tag.
[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]: The License field must be a valid SPDX expression.
[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]: 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]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package must not depend on deprecated() packages.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[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]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 1134 bytes in 1 files.
[x]: Packages must not store files under /srv, /opt or /usr/local

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

Generic:
[!]: 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.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[-]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[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]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Fully versioned dependency in subpackages if applicable.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on debuginfo package(s).
     Note: No rpmlint messages.
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: openxr-simple-playground-0-1.20240318git811d06a.fc41.x86_64.rpm
          openxr-simple-playground-debuginfo-0-1.20240318git811d06a.fc41.x86_64.rpm
          openxr-simple-playground-debugsource-0-1.20240318git811d06a.fc41.x86_64.rpm
          openxr-simple-playground-0-1.20240318git811d06a.fc41.src.rpm
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.12/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmpy24wptmd')]
checks: 32, packages: 4

openxr-simple-playground.x86_64: W: no-manual-page-for-binary openxr-playground
 4 packages and 0 specfiles checked; 0 errors, 1 warnings, 16 filtered, 0 badness; has taken 0.4 s 




Rpmlint (debuginfo)
-------------------
Checking: openxr-simple-playground-debuginfo-0-1.20240318git811d06a.fc41.x86_64.rpm
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.12/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmpab_adpt2')]
checks: 32, packages: 1

 1 packages and 0 specfiles checked; 0 errors, 0 warnings, 5 filtered, 0 badness; has taken 0.1 s 





Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.12/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 3

openxr-simple-playground.x86_64: W: no-manual-page-for-binary openxr-playground
 3 packages and 0 specfiles checked; 0 errors, 1 warnings, 13 filtered, 0 badness; has taken 0.4 s 



Source checksums
----------------
https://gitlab.freedesktop.org/monado/demos/openxr-simple-playground/-/archive/811d06a34db1e31611ebca4bda963bc60a2e20ea/openxr-simple-playground-811d06a34db1e31611ebca4bda963bc60a2e20ea.tar.bz2 :
  CHECKSUM(SHA256) this package     : 6e1e1a773c9940d3e043132f222f68f322eb1adeb5584599985adf1f57643784
  CHECKSUM(SHA256) upstream package : 6e1e1a773c9940d3e043132f222f68f322eb1adeb5584599985adf1f57643784


Requires
--------
openxr-simple-playground (rpmlib, GLIBC filtered):
    libGLX.so.0()(64bit)
    libOpenGL.so.0()(64bit)
    libSDL2-2.0.so.0()(64bit)
    libX11.so.6()(64bit)
    libc.so.6()(64bit)
    libm.so.6()(64bit)
    libopenxr_loader.so.1()(64bit)
    rtld(GNU_HASH)

openxr-simple-playground-debuginfo (rpmlib, GLIBC filtered):

openxr-simple-playground-debugsource (rpmlib, GLIBC filtered):



Provides
--------
openxr-simple-playground:
    openxr-simple-playground
    openxr-simple-playground(x86-64)

openxr-simple-playground-debuginfo:
    debuginfo(build-id)
    openxr-simple-playground-debuginfo
    openxr-simple-playground-debuginfo(x86-64)

openxr-simple-playground-debugsource:
    openxr-simple-playground-debugsource
    openxr-simple-playground-debugsource(x86-64)



Generated by fedora-review 0.10.0 (e79b66b) last change: 2023-07-24
Command line :/usr/bin/fedora-review -b 2274949
Buildroot used: fedora-rawhide-x86_64
Active plugins: C/C++, Shell-api, Generic
Disabled plugins: Perl, R, Haskell, fonts, Python, Ocaml, Java, SugarActivity, PHP
Disabled flags: EXARCH, EPEL6, EPEL7, DISTTAG, BATCH

Comment 2 Davide Cavalca 2024-04-21 03:07:18 UTC
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "Boost Software License 1.0", "*No
     copyright* MIT License", "Apache License 2.0". 3 files have unknown
     license. Detailed output of licensecheck in /tmp/2274949-openxr-
     simple-playground/licensecheck.txt

This project looks like a mix of multiple things and the bundled dependencies should be declared:

*No copyright* MIT License
--------------------------
openxr-simple-playground-811d06a34db1e31611ebca4bda963bc60a2e20ea/math_3d.h

Apache License 2.0
------------------
openxr-simple-playground-811d06a34db1e31611ebca4bda963bc60a2e20ea/openxr_headers/loader_interfaces.h
openxr-simple-playground-811d06a34db1e31611ebca4bda963bc60a2e20ea/openxr_headers/openxr.h
openxr-simple-playground-811d06a34db1e31611ebca4bda963bc60a2e20ea/openxr_headers/openxr_platform.h
openxr-simple-playground-811d06a34db1e31611ebca4bda963bc60a2e20ea/openxr_headers/openxr_platform_defines.h
openxr-simple-playground-811d06a34db1e31611ebca4bda963bc60a2e20ea/openxr_headers/openxr_reflection.h

Boost Software License 1.0
--------------------------
openxr-simple-playground-811d06a34db1e31611ebca4bda963bc60a2e20ea/main.c

[!]: Package contains desktop file if it is a GUI application.

This is probably not needed as it's not an end user app, but heads up.

[!]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.

Please file an issue and ask upstream to add this.

Comment 3 Davide Cavalca 2024-04-21 03:08:16 UTC
Also I would probably rework the description to move "Note: Currently this application only supports Linux/X11." to the end and just say Xorg instead of Linux/X11. On that note, does this really only support Xorg and not Wayland?

Comment 4 Jonathan Steffan 2024-04-23 23:40:57 UTC
Spec URL: https://jsteffan.fedorapeople.org/imrsv/openxr-simple-playground.spec
SRPM URL: https://jsteffan.fedorapeople.org/imrsv/openxr-simple-playground-0-1.20240318git811d06a.fc39/openxr-simple-playground-0-1.20240318git811d06a.fc39.src.rpm

Updated the licenses.
Added two bundled provides. Please review as neither package name exists so I guessed at the best way to document this.
For this one, I agree a .desktop file is not needed.
https://gitlab.freedesktop.org/monado/demos/openxr-simple-playground/-/issues/2 filed to request the LICENSE file addition.

Yes, this application will only run in Xorg.

Comment 5 Jonathan Steffan 2024-04-24 16:11:52 UTC
Spec URL: https://jsteffan.fedorapeople.org/imrsv/openxr-simple-playground.spec
SRPM URL: https://jsteffan.fedorapeople.org/imrsv/openxr-simple-playground-0-1.20240424git3b3c91f.fc39/openxr-simple-playground-0-1.20240424git3b3c91f.fc39.src.rpm

Updated based on upstream changes from the LICENSE ticket.

Clarified the application will run on Wayland via XrGraphicsBindingOpenGLXlibKHR (glx) graphics binding.

Comment 6 Davide Cavalca 2024-04-27 18:35:29 UTC
> Provides:       bundled(openxr-sdk-source)

I'd use Provides: bundled(openxr) here as that's the name of the Fedora package.

Comment 7 Davide Cavalca 2024-04-27 18:36:58 UTC
> %doc Readme.md LICENSE external/math_3d/LICENSE external/openxr_headers/LICENSE

The license files need to be renamed in %prep (as otherwise they'll overwrite each other in the package) and then marked as %license, not %doc.

Comment 9 Davide Cavalca 2024-04-28 21:29:36 UTC
APPROVED, thank you!

Comment 10 Fedora Admin user for bugzilla script actions 2024-05-04 18:55:35 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/openxr-simple-playground

Comment 11 Fedora Update System 2024-05-04 19:15:35 UTC
FEDORA-2024-175bed9ff7 (openxr-simple-playground-0-2.20240424git3b3c91f.fc41) has been submitted as an update to Fedora 41.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-175bed9ff7

Comment 12 Fedora Update System 2024-05-04 19:17:51 UTC
FEDORA-2024-175bed9ff7 (openxr-simple-playground-0-2.20240424git3b3c91f.fc41) has been pushed to the Fedora 41 stable repository.
If problem still persists, 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.