Bug 1909390 - Review Request: gn - Meta-build system that generates build files for Ninja
Summary: Review Request: gn - Meta-build system that generates build files for Ninja
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-12-19 16:27 UTC by Ben Beasley
Modified: 2021-04-14 14:27 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-03-22 02:09:20 UTC
Type: ---
Embargoed:
zebob.m: fedora-review+


Attachments (Terms of Use)

Description Ben Beasley 2020-12-19 16:27:45 UTC
Spec URL: https://gitlab.com/musicinmybrain/gn-rpm/-/raw/19a0beed4529d1aab4502410f83e8b0a17f59ece/gn.spec

SRPM URL: https://kojipkgs.fedoraproject.org//work/tasks/168/57800168/gn-1875-1.20201219git4e260f1d.fc34.src.rpm

Description:

GN is a meta-build system that generates build files for Ninja.

Fedora Account System Username: music

Koji builds:

F34: https://koji.fedoraproject.org/koji/taskinfo?taskID=57800164
F33: https://koji.fedoraproject.org/koji/taskinfo?taskID=57800165
F33: https://koji.fedoraproject.org/koji/taskinfo?taskID=57800166
EL8: https://koji.fedoraproject.org/koji/taskinfo?taskID=57800167
(EL7 lacks the necessary C++17 support.)

This is used to build a number of large Google open-source projects, including Skia, V8, and Chromium. The Chromium RPM is currently built with a bundled copy; this would probably continue, as building Chromium is such a house of cards already.

See the comments near the beginning of the spec file regarding the wildly idiosyncratic versioning scheme. This is a Google project, so different-for-difference’s-sake is par for the course.

Note also that the source URL exports a tarball directly from git; while the contents are stable since it references a particular commit, the tarball checksum and even file size are different every time. I haven’t looked too closely, but I suspect this is due to timestamps in the tar stream being based on the access time rather than the time of the commit.

Otherwise this is mostly straightforward. It’s a substantial C++17 code base, so it will take a while to build.

Comments on rpmlint findings:

gn-doc.noarch: E: version-control-internal-file /usr/share/doc/gn-doc/examples/ios/.gitignore
gn-doc.noarch: W: hidden-file-or-dir /usr/share/doc/gn-doc/examples/ios/.gn
gn-doc.noarch: E: zero-length /usr/share/doc/gn-doc/examples/ios/app/Foo-Bridging-Header.h
gn-doc.noarch: W: hidden-file-or-dir /usr/share/doc/gn-doc/examples/rust_example/.gn
gn-doc.noarch: W: hidden-file-or-dir /usr/share/doc/gn-doc/examples/simple_build/.gn

All of these belong in the sample projects as-is. The .gn files are sample GN configurations, and the .gitignore files are samples as well, not accidental leftovers.

gn.src: W: strange-permission update-version 775

This should indeed be executable, as it is a maintainer script.

gn.src: W: file-size-mismatch 4e260f1dc17864cdedc31bec1ff658404a9d703e.tar.gz = 1005364, https://gn.googlesource.com/gn/+archive/4e260f1dc17864cdedc31bec1ff658404a9d703e.tar.gz = 1005341

As noted before, the git exporter produces a different tarball every time. I believe only the timestamps differ.

gn.x86_64: W: no-documentation

It’s all in the -doc subpackage.

(I will be adding a gn.rpmlintrc file to the git repo to filter these warnings.)

Comment 1 Ben Beasley 2021-01-01 18:58:59 UTC
This submission follows https://docs.fedoraproject.org/en-US/packaging-guidelines/Emacs/; however, I am tracking current discussion of deprecating XEmacs on the fedora-devel list, and am prepared to remove the XEmacs versions of the Emacs extensions once that deprecation occurs.

Comment 6 Ben Beasley 2021-03-05 23:29:43 UTC
It appears gitlab is serving a 403 error to the fedora-review tool even though the spec URL is otherwise good, perhaps by blocking user-agents not on a whitelist. This is obnoxious. The following URL should work for everyone: https://music.fedorapeople.org/gn.spec

Comment 8 Robert-André Mauchin 🐧 2021-03-17 09:24:49 UTC
 - Consider adding the name to the archive filename:

Source0:        %{url}/+archive/%{commit}.tar.gz#/%{name}-%{shortcommit}.tar.gz


Package approved, please fix the aforementioned issue before import.



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

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


===== MUST items =====

C/C++:
[x]: Package does not contain kernel modules.
[x]: Package contains no static executables.
[x]: If your application is a C or C++ application you must list a
     BuildRequires against gcc, gcc-c++ or clang.
[x]: Package does not contain any libtool archives (.la)
[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.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "BSD 3-clause "New" or "Revised"
     License", "Public domain", "Apache License 2.0". 800 files have
     unknown license. Detailed output of licensecheck in
     /home/bob/packaging/review/gn/review-gn/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[x]: If the package is under multiple licenses, the licensing breakdown
     must be documented in the spec.
[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]: Package requires other packages for directories it uses.
[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 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]: 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 0 bytes in 0 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).
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: 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.
[-]: %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.


Rpmlint
-------
Checking: gn-1893-1.20210314git64b3b940.fc35.x86_64.rpm
          gn-doc-1893-1.20210314git64b3b940.fc35.noarch.rpm
          gn-debuginfo-1893-1.20210314git64b3b940.fc35.x86_64.rpm
          gn-debugsource-1893-1.20210314git64b3b940.fc35.x86_64.rpm
          gn-1893-1.20210314git64b3b940.fc35.src.rpm
gn-doc.noarch: E: version-control-internal-file /usr/share/doc/gn-doc/examples/ios/.gitignore
gn-doc.noarch: W: hidden-file-or-dir /usr/share/doc/gn-doc/examples/ios/.gn
gn-doc.noarch: E: zero-length /usr/share/doc/gn-doc/examples/ios/app/Foo-Bridging-Header.h
gn-doc.noarch: W: hidden-file-or-dir /usr/share/doc/gn-doc/examples/rust_example/.gn
gn-doc.noarch: W: hidden-file-or-dir /usr/share/doc/gn-doc/examples/simple_build/.gn
gn.src: W: strange-permission update-version 755
gn.src: E: specfile-error warning: line 70: Possible unexpanded macro in: Requires:       emacs-filesystem >= %{_emacs_version}
gn.src: E: specfile-error warning: line 73: Possible unexpanded macro in: Requires:       xemacs-filesystem >= %{_xemacs_version}
5 packages and 0 specfiles checked; 4 errors, 4 warnings.

Comment 9 Ben Beasley 2021-03-17 11:42:04 UTC
Thanks for the review!

>  - Consider adding the name to the archive filename:
>
> Source0:        %{url}/+archive/%{commit}.tar.gz#/%{name}-%{shortcommit}.tar.gz

It’s funny—I think I remember getting feedback to remove this trick in another package! I like the nicer filename, though. I’ll adjust it.

Repository requested: https://pagure.io/releng/fedora-scm-requests/issue/32954

Comment 10 Ben Beasley 2021-03-17 11:46:14 UTC
It looks like https://fedoraproject.org/wiki/Changes/Deprecate_xemacs was accepted (https://pagure.io/fesco/issue/2540), so I will also remove the xemacs support from the spec file before submitting a build to Rawhide.

Comment 11 Robert-André Mauchin 🐧 2021-03-17 12:51:32 UTC
(In reply to code from comment #10)
> It looks like https://fedoraproject.org/wiki/Changes/Deprecate_xemacs was
> accepted (https://pagure.io/fesco/issue/2540), so I will also remove the
> xemacs support from the spec file before submitting a build to Rawhide.

On Github this is not necessary, you can pass the filename directly.

Comment 12 Ben Beasley 2021-03-17 13:13:20 UTC
> On Github this is not necessary, you can pass the filename directly.

Indeed, that’s probably what it was.

Comment 13 Tomas Hrcka 2021-03-17 13:45:42 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/gn

Comment 14 Fedora Update System 2021-03-17 18:57:37 UTC
FEDORA-2021-0974eec362 has been submitted as an update to Fedora 34. https://bodhi.fedoraproject.org/updates/FEDORA-2021-0974eec362

Comment 15 Fedora Update System 2021-03-17 19:23:42 UTC
FEDORA-2021-9607a96485 has been submitted as an update to Fedora 33. https://bodhi.fedoraproject.org/updates/FEDORA-2021-9607a96485

Comment 16 Fedora Update System 2021-03-17 20:44:05 UTC
FEDORA-2021-98ee255ae8 has been submitted as an update to Fedora 32. https://bodhi.fedoraproject.org/updates/FEDORA-2021-98ee255ae8

Comment 17 Fedora Update System 2021-03-17 20:58:34 UTC
FEDORA-EPEL-2021-8130010c8b has been submitted as an update to Fedora EPEL 8. https://bodhi.fedoraproject.org/updates/FEDORA-EPEL-2021-8130010c8b

Comment 18 Fedora Update System 2021-03-18 03:29:04 UTC
FEDORA-2021-9607a96485 has been pushed to the Fedora 33 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2021-9607a96485 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-9607a96485

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 19 Fedora Update System 2021-03-18 03:42:46 UTC
FEDORA-2021-98ee255ae8 has been pushed to the Fedora 32 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2021-98ee255ae8 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-98ee255ae8

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 20 Fedora Update System 2021-03-18 04:48:12 UTC
FEDORA-EPEL-2021-8130010c8b has been pushed to the Fedora EPEL 8 testing repository.

You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-EPEL-2021-8130010c8b

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 21 Fedora Update System 2021-03-18 21:49:13 UTC
FEDORA-2021-cc19efedc0 has been pushed to the Fedora 34 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf upgrade --enablerepo=updates-testing --advisory=FEDORA-2021-cc19efedc0`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-cc19efedc0

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 22 Fedora Update System 2021-03-22 02:09:20 UTC
FEDORA-2021-cc19efedc0 has been pushed to the Fedora 34 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 23 Fedora Update System 2021-03-26 00:54:42 UTC
FEDORA-2021-98ee255ae8 has been pushed to the Fedora 32 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 24 Fedora Update System 2021-03-26 17:52:44 UTC
FEDORA-2021-9607a96485 has been pushed to the Fedora 33 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 25 Fedora Update System 2021-03-31 02:08:40 UTC
FEDORA-EPEL-2021-d72bcdda41 has been pushed to the Fedora EPEL 8 testing repository.

You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-EPEL-2021-d72bcdda41

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 26 Fedora Update System 2021-04-14 14:27:00 UTC
FEDORA-EPEL-2021-d72bcdda41 has been pushed to the Fedora EPEL 8 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.