Bug 2274950 - Review Request: xrgears - OpenXR VR demo using Vulkan for rendering
Summary: Review Request: xrgears - OpenXR VR demo using Vulkan for rendering
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:34 UTC by Jonathan Steffan
Modified: 2024-04-16 18:54 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2024-04-16 18:54:28 UTC
Type: ---
Embargoed:
davide: fedora-review+


Attachments (Terms of Use)

Description Jonathan Steffan 2024-04-14 00:34:50 UTC
Spec URL: https://jsteffan.fedorapeople.org/imrsv/xrgears.spec
SRPM URL: https://jsteffan.fedorapeople.org/imrsv/xrgears-1.0.1-1.20231207git6376389.fc39/xrgears-1.0.1-1.20231207git6376389.fc39.src.rpm
Description: xrgears is an OpenXR VR demo using Vulkan for rendering.
Fedora Account System Username: jsteffan

Comment 1 Davide Cavalca 2024-04-14 22:08:44 UTC
Some notes from a quick pass:
- why the ExclusiveArch: x86_64 ?
- why is it built using clang ?
- consider filing a ticket upstream asking for a new release (and adding it as a comment to justify why we're packaging a snapshot)
- nit: you should be able to use %forgeautosetup` in %setup` to combine forgesetup and autopatch

Comment 2 Jonathan Steffan 2024-04-15 20:07:56 UTC
(In reply to Davide Cavalca from comment #1)
> - why the ExclusiveArch: x86_64 ?

No specific reason, I've just been focused on x86_64. I removed this.

> - why is it built using clang ?

Just have been using a pattern for all of the stuff I've been working on, of which a handful require clang. I've updated it to use gcc.

> - consider filing a ticket upstream asking for a new release (and adding it
> as a comment to justify why we're packaging a snapshot)

Done.

> - nit: you should be able to use %forgeautosetup` in %setup` to combine
> forgesetup and autopatch

I've updated this. I had it split for other packages because I needed to patch after dealing with multiple sources.

Spec URL: https://jsteffan.fedorapeople.org/imrsv/xrgears.spec
SRPM URL: https://jsteffan.fedorapeople.org/imrsv/xrgears-1.0.1-1.20231207git6376389.fc39/xrgears-1.0.1-1.20231207git6376389.fc39.src.rpm

Comment 3 Davide Cavalca 2024-04-16 03:11:16 UTC
This is a review *template*. Besides handling the [ ]-marked tests you are
also supposed to fix the template before pasting into bugzilla:
- Add issues you find to the list of issues on top. If there isn't such
  a list, create one.
- Add your own remarks to the template checks.
- Add new lines marked [!] or [?] when you discover new things not
  listed by fedora-review.
- Change or remove any text in the template which is plain wrong. In this
  case you could also file a bug against fedora-review
- Remove the "[ ] Manual check required", you will not have any such lines
  in what you paste.
- Remove attachments which you deem not really useful (the rpmlint
  ones are mandatory, though)
- Remove this text



Package Review
==============

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



===== 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.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "MIT License", "*No copyright* MIT
     License", "Boost Software License 1.0", "Apache License 2.0". 421
     files have unknown license. Detailed output of licensecheck in
     /tmp/2274950-xrgears/licensecheck.txt
[x]: 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.
[-]: 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]: 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]: 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.
[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 1820 bytes in 1 files.
[x]: Packages must not store files under /srv, /opt or /usr/local

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

Generic:
[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.
[-]: 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.
[x]: %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:
[!]: Spec file according to URL is the same as in SRPM.
     Note: Spec file as given by url is not the same as in SRPM (see
     attached diff).
     See: (this test has no URL)
[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.


Rpmlint
-------
Checking: xrgears-1.0.1-1.20231207git6376389.fc41.x86_64.rpm
          xrgears-debuginfo-1.0.1-1.20231207git6376389.fc41.x86_64.rpm
          xrgears-debugsource-1.0.1-1.20231207git6376389.fc41.x86_64.rpm
          xrgears-1.0.1-1.20231207git6376389.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/tmpi2z90e_u')]
checks: 32, packages: 4

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




Rpmlint (debuginfo)
-------------------
Checking: xrgears-debuginfo-1.0.1-1.20231207git6376389.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/tmp51fvf_qk')]
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

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



Source checksums
----------------
https://gitlab.freedesktop.org/monado/demos/xrgears/-/archive/6376389139a11eec16138148e17073bbe96f137d/xrgears-6376389139a11eec16138148e17073bbe96f137d.tar.bz2 :
  CHECKSUM(SHA256) this package     : ba073c43dfcf1acddce0f03c6dfa74371cc234d7c85f38364220321cc5ab22a6
  CHECKSUM(SHA256) upstream package : ba073c43dfcf1acddce0f03c6dfa74371cc234d7c85f38364220321cc5ab22a6


Requires
--------
xrgears (rpmlib, GLIBC filtered):
    libc.so.6()(64bit)
    libgcc_s.so.1()(64bit)
    libgcc_s.so.1(GCC_3.0)(64bit)
    libgcc_s.so.1(GCC_3.3.1)(64bit)
    libgio-2.0.so.0()(64bit)
    libglib-2.0.so.0()(64bit)
    libm.so.6()(64bit)
    libopenxr_loader.so.1()(64bit)
    libstdc++.so.6()(64bit)
    libstdc++.so.6(CXXABI_1.3)(64bit)
    libstdc++.so.6(CXXABI_1.3.9)(64bit)
    libvulkan.so.1()(64bit)
    rtld(GNU_HASH)

xrgears-debuginfo (rpmlib, GLIBC filtered):

xrgears-debugsource (rpmlib, GLIBC filtered):



Provides
--------
xrgears:
    xrgears
    xrgears(x86-64)

xrgears-debuginfo:
    debuginfo(build-id)
    xrgears-debuginfo
    xrgears-debuginfo(x86-64)

xrgears-debugsource:
    xrgears-debugsource
    xrgears-debugsource(x86-64)



Diff spec file in url and in SRPM
---------------------------------
--- /tmp/2274950-xrgears/srpm/xrgears.spec	2024-04-15 19:45:07.098266737 -0700
+++ /tmp/2274950-xrgears/srpm-unpacked/xrgears.spec	2024-04-14 17:00:00.000000000 -0700
@@ -1,6 +1,6 @@
 %global forgeurl  https://gitlab.freedesktop.org/monado/demos/xrgears
-# Upstream tag request: https://gitlab.freedesktop.org/monado/demos/xrgears/-/issues/16
 %global commit    6376389139a11eec16138148e17073bbe96f137d
 %global date      20231207
+#%%global toolchain clang
 %forgemeta
 
@@ -15,4 +15,6 @@
 
 
+#ExclusiveArch:  x86_64
+#BuildRequires:  clang
 BuildRequires:  gcc-c++
 BuildRequires:  cmake


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

Comment 4 Davide Cavalca 2024-04-16 03:11:57 UTC
The only actual issue remaining is:

[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "MIT License", "*No copyright* MIT
     License", "Boost Software License 1.0", "Apache License 2.0". 421
     files have unknown license. Detailed output of licensecheck in
     /tmp/2274950-xrgears/licensecheck.txt

The license tag needs to be updated, it looks like src/ktx_* are Apache-2.0 (and from a quick look, they come from https://github.com/KhronosGroup/KTX-Software, which should probably be declared as a bundled provides).

Comment 5 Jonathan Steffan 2024-04-16 03:29:35 UTC
Okay, I've updated the license and rebuilt. The spec and the src.rpm will match now.

Spec URL: https://jsteffan.fedorapeople.org/imrsv/xrgears.spec
SRPM URL: https://jsteffan.fedorapeople.org/imrsv/xrgears-1.0.1-1.20231207git6376389.fc39/xrgears-1.0.1-1.20231207git6376389.fc39.src.rpm


I've not done bundled provides yet, but will need to do for a handful of the XR SIG packages. What is the best way to determine the bundling and version numbers?


Also, quickly looking at KTX-Software I'm not sure if it's actually bundled. Maybe a copy-paste of some interface stuff from 4 years ago, but I'd count this as part of xrgears at this point.

Comment 6 Davide Cavalca 2024-04-16 03:40:58 UTC
Thanks, looks good now, this is APPROVED.

> I've not done bundled provides yet, but will need to do for a handful of the XR SIG packages. What is the best way to determine the bundling and version numbers?

Googling the filename and/or some of its content (e.g. a function definition) is usually enough to find where it's from, if the header doesn't state it outright. I generally leave the version out if it can't be determined (i.e. just declare Provides: bundled(KTX-Software) and add a comment before mentioning the files/paths that are actually bundled and the license).

> Also, quickly looking at KTX-Software I'm not sure if it's actually bundled. Maybe a copy-paste of some interface stuff from 4 years ago, but I'd count this as part of xrgears at this point.

https://gitlab.freedesktop.org/monado/demos/xrgears/-/blob/master/src/ktx_stream.c matches pretty closely to https://github.com/KhronosGroup/KTX-Software/blob/main/lib/memstream.c modulo some comments, I assume the others will be similar. IMO in this case it's worth declaring as bundled and leaving it at that (it's modified and deeply entrenched into xrgears, so not much point into attempting to unbundle).

Comment 7 Fedora Admin user for bugzilla script actions 2024-04-16 17:02:47 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/xrgears

Comment 8 Fedora Update System 2024-04-16 18:52:13 UTC
FEDORA-2024-10bb8a0c7b (xrgears-1.0.1-3.20231207git6376389.fc41) has been submitted as an update to Fedora 41.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-10bb8a0c7b

Comment 9 Fedora Update System 2024-04-16 18:54:28 UTC
FEDORA-2024-10bb8a0c7b (xrgears-1.0.1-3.20231207git6376389.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.