Bug 2196601 - Review Request: zycore-c - Zyan Core Library for C
Summary: Review Request: zycore-c - Zyan Core Library for C
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Linux
unspecified
medium
Target Milestone: ---
Assignee: Benson Muite
QA Contact: Fedora Extras Quality Assurance
URL: https://github.com/zyantific/zycore-c
Whiteboard:
Depends On:
Blocks: 2196603
TreeView+ depends on / blocked
 
Reported: 2023-05-09 13:38 UTC by Felix Wang
Modified: 2023-06-16 16:15 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-06-16 16:15:04 UTC
Type: ---
Embargoed:
benson_muite: fedora-review+


Attachments (Terms of Use)
The .spec file difference from Copr build 5901549 to 5945204 (1.41 KB, patch)
2023-05-23 02:14 UTC, Fedora Review Service
no flags Details | Diff
The .spec file difference from Copr build 5945204 to 6012264 (1.06 KB, patch)
2023-06-07 08:45 UTC, Fedora Review Service
no flags Details | Diff
The .spec file difference from Copr build 6012264 to 6078893 (583 bytes, patch)
2023-06-14 02:24 UTC, Fedora Review Service
no flags Details | Diff

Description Felix Wang 2023-05-09 13:38:29 UTC
SPEC URL: https://topazus.fedorapeople.org/rpms/zycore-c.spec
SRPM URL: https://topazus.fedorapeople.org/rpms/zycore-c-1.4.1-1.fc39.src.rpm

Description:
The Zyan Core Library for C is an internal library providing platform
independent types, macros and a fallback for environments without LibC.

Fedora Account System Username: topazus

Reproducible: Always

Comment 1 Fedora Review Service 2023-05-09 13:53:13 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/5901549
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2196601-zycore-c/fedora-rawhide-x86_64/05901549-zycore-c/fedora-review/review.txt

Please take a look if any issues were found.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 2 Benson Muite 2023-05-22 14:30:09 UTC
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]: Header files in -devel subpackage, if present.
[x]: ldconfig not called in %post and %postun for Fedora 28 and later.
[x]: Package does not contain any libtool archives (.la)
[x]: Rpath absent or only used for internal libs.
[x]: Development (unversioned) .so files in -devel subpackage, if present.

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", "MIT License", "*No copyright* MIT
     License". 6 files have unknown license. Detailed output of
     licensecheck in
     /home/FedoraPackaging/reviews/zycore-c/2196601-zycore-c/licensecheck.txt
[ ]: License file installed when any subpackage combination is installed.
[!]: Package requires other packages for directories it uses.
     Note: No known owner of /usr/lib64/cmake/zycore
[!]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib64/cmake/zycore
[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.
[ ]: 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.
[ ]: Package is not known to require an ExcludeArch tag.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 1 files.
[ ]: 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 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]: 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).
[!]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in zycore-
     c-devel
[ ]: 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.
[ ]: 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]: 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: zycore-c-1.4.1-1.fc39.x86_64.rpm
          zycore-c-devel-1.4.1-1.fc39.x86_64.rpm
          zycore-c-doc-1.4.1-1.fc39.noarch.rpm
          zycore-c-debuginfo-1.4.1-1.fc39.x86_64.rpm
          zycore-c-debugsource-1.4.1-1.fc39.x86_64.rpm
          zycore-c-1.4.1-1.fc39.src.rpm
============================================== rpmlint session starts ==============================================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.11/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/tmpmnx97gc1')]
checks: 31, packages: 6

zycore-c-doc.noarch: W: summary-not-capitalized the documentation of zycore-c
zycore-c-devel.x86_64: W: no-documentation
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/variables_4.js /usr/share/doc/Zycore/api/search/all_4.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/variables_6.js /usr/share/doc/Zycore/api/search/all_6.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/variables_7.js /usr/share/doc/Zycore/api/search/all_7.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/files_5.js /usr/share/doc/Zycore/api/search/all_8.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/variables_9.js /usr/share/doc/Zycore/api/search/all_a.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/files_7.js /usr/share/doc/Zycore/api/search/all_b.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/variables_b.js /usr/share/doc/Zycore/api/search/all_d.js
=============== 6 packages and 0 specfiles checked; 0 errors, 9 warnings, 0 badness; has taken 4.4 s ===============




Rpmlint (debuginfo)
-------------------
Checking: zycore-c-debuginfo-1.4.1-1.fc39.x86_64.rpm
============================================== rpmlint session starts ==============================================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.11/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/tmp6ynl5jk_')]
checks: 31, packages: 1

=============== 1 packages and 0 specfiles checked; 0 errors, 0 warnings, 0 badness; has taken 1.3 s ===============





Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.11/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: 31, packages: 5

zycore-c-doc.noarch: W: summary-not-capitalized the documentation of zycore-c
zycore-c-devel.x86_64: W: no-documentation
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/variables_4.js /usr/share/doc/Zycore/api/search/all_4.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/variables_6.js /usr/share/doc/Zycore/api/search/all_6.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/variables_7.js /usr/share/doc/Zycore/api/search/all_7.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/files_5.js /usr/share/doc/Zycore/api/search/all_8.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/variables_9.js /usr/share/doc/Zycore/api/search/all_a.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/files_7.js /usr/share/doc/Zycore/api/search/all_b.js
zycore-c-doc.noarch: W: files-duplicate /usr/share/doc/Zycore/api/search/variables_b.js /usr/share/doc/Zycore/api/search/all_d.js
 5 packages and 0 specfiles checked; 0 errors, 9 warnings, 0 badness; has taken 3.5 s 



Source checksums
----------------
https://github.com/zyantific/zycore-c/archive/v1.4.1/zycore-c-1.4.1.tar.gz :
  CHECKSUM(SHA256) this package     : 8f610917c4254a69ec7e0c63492e9d0be9d18f4bb8fe91a3ff6ebed917d1f0f8
  CHECKSUM(SHA256) upstream package : 8f610917c4254a69ec7e0c63492e9d0be9d18f4bb8fe91a3ff6ebed917d1f0f8


Requires
--------
zycore-c (rpmlib, GLIBC filtered):
    libc.so.6()(64bit)
    rtld(GNU_HASH)

zycore-c-devel (rpmlib, GLIBC filtered):
    cmake-filesystem(x86-64)
    libZycore.so.1.4()(64bit)
    zycore-c(x86-64)

zycore-c-doc (rpmlib, GLIBC filtered):

zycore-c-debuginfo (rpmlib, GLIBC filtered):

zycore-c-debugsource (rpmlib, GLIBC filtered):



Provides
--------
zycore-c:
    libZycore.so.1.4()(64bit)
    zycore-c
    zycore-c(x86-64)

zycore-c-devel:
    cmake(zycore)
    zycore-c-devel
    zycore-c-devel(x86-64)

zycore-c-doc:
    zycore-c-doc

zycore-c-debuginfo:
    debuginfo(build-id)
    libZycore.so.1.4.0.0-1.4.1-1.fc39.x86_64.debug()(64bit)
    zycore-c-debuginfo
    zycore-c-debuginfo(x86-64)

zycore-c-debugsource:
    zycore-c-debugsource
    zycore-c-debugsource(x86-64)



Generated by fedora-review 0.9.0 (6761b6c) last change: 2022-08-23
Command line :/usr/bin/fedora-review -b 2196601
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Generic, C/C++
Disabled plugins: Haskell, SugarActivity, Python, R, Ruby, Perl, Java, fonts, Ocaml, PHP
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comments:
a) Please add %dir directives
%dir %{_libdir}/cmake/zycore
%dir %{_includedir}/Zycore/
%dir %{_datadir}/doc/Zycore/
If can indicate type of files included by
extensions rather than globbing the entire directory,
this is also helpful for maintenance. eg.
%{_includedir}/Zycore/*.h
b) Doxygen can generate man pages without javascript:
https://www.doxygen.nl/manual/starting.html
Perhaps these can be made available in the main package?
c) The spec file indicates that devel package should require
the main package using %{name}%{?_isa} = %{version}-%{release}
unclear why getting an error for this.
d) Maybe powerpc should also be excluded as an architecture
in addition to s390x?
https://github.com/zyantific/zycore-c/issues/59

Comment 3 Felix Wang 2023-05-23 02:07:20 UTC
> a) Please add %dir directives
> %dir %{_libdir}/cmake/zycore
> %dir %{_includedir}/Zycore/

Added.

> %dir %{_datadir}/doc/Zycore/

There are various types of filename extensions in this doc directory. Do I really need to add all of them?

> b) Doxygen can generate man pages without javascript:
> https://www.doxygen.nl/manual/starting.html
> Perhaps these can be made available in the main package?

Do you mean this? ref: https://www.doxygen.nl/manual/config.html#cfg_generate_man

c) The spec file indicates that devel package should require
the main package using %{name}%{?_isa} = %{version}-%{release}
unclear why getting an error for this.
d) Maybe powerpc should also be excluded as an architecture
in addition to s390x?
https://github.com/zyantific/zycore-c/issues/59

Dis this.

Comment 5 Fedora Review Service 2023-05-23 02:14:54 UTC
Created attachment 1966328 [details]
The .spec file difference from Copr build 5901549 to 5945204

Comment 6 Fedora Review Service 2023-05-23 02:14:56 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/5945204
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2196601-zycore-c/fedora-rawhide-x86_64/05945204-zycore-c/fedora-review/review.txt

Please take a look if any issues were found.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 7 Benson Muite 2023-05-27 04:18:36 UTC
> Do you mean this? ref: https://www.doxygen.nl/manual/config.html#cfg_generate_man
Yes. Would be great to have man pages in the main package.

Comment 8 Felix Wang 2023-06-07 08:33:17 UTC
(In reply to Benson Muite from comment #7)
> > Do you mean this? ref: https://www.doxygen.nl/manual/config.html#cfg_generate_man
> Yes. Would be great to have man pages in the main package.

Ok, I do not know the benefits of generating man pages for the C/C++ project. Anyway, I opened a PR on the upstream, which is supposed to generate man pages by default when making documentation. Ref: https://github.com/zyantific/zycore-c/pull/65

Comment 10 Fedora Review Service 2023-06-07 08:45:09 UTC
Created attachment 1969479 [details]
The .spec file difference from Copr build 5945204 to 6012264

Comment 11 Fedora Review Service 2023-06-07 08:45:11 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/6012264
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2196601-zycore-c/fedora-rawhide-x86_64/06012264-zycore-c/fedora-review/review.txt

Please take a look if any issues were found.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 12 Felix Wang 2023-06-07 09:08:14 UTC
> d) Maybe powerpc should also be excluded as an architecture
> in addition to s390x?
> https://github.com/zyantific/zycore-c/issues/59

The ppc64le architecture in Fedora is little-endian, the linking issue is about problems of running on the big-endian architecture.
Ref: https://fedoraproject.org/wiki/Architectures#Primary_Architectures

Comment 13 Felix Wang 2023-06-10 08:27:25 UTC
Any more comments with this package review?

Comment 14 Benson Muite 2023-06-12 17:31:37 UTC
Thanks. man pages can go in the main package. HTML can remain as a separate docs package.

The docs package should probably require the main package or also have the license file included.

Comment 15 Felix Wang 2023-06-14 02:16:30 UTC
> man pages can go in the main package.

I think it is more appropriate  to put the man pages into -devel package, as the normal user at most cases will not care about these, which they provide the documentation of C library function.

> HTML can remain as a separate docs package.
> The docs package should probably require the main package or also have the license file included.

Thanks for the advice. fixed.

with updated.

SPEC URL: https://topazus.fedorapeople.org/rpms/zycore-c.spec
SRPM URL: https://topazus.fedorapeople.org/rpms/zycore-c-1.4.1-1.fc39.src.rpm

Comment 16 Fedora Review Service 2023-06-14 02:24:29 UTC
Created attachment 1970799 [details]
The .spec file difference from Copr build 6012264 to 6078893

Comment 17 Fedora Review Service 2023-06-14 02:24:31 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/6078893
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2196601-zycore-c/fedora-rawhide-x86_64/06078893-zycore-c/fedora-review/review.txt

Please take a look if any issues were found.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 18 Benson Muite 2023-06-16 15:04:49 UTC
Seems ok.  If the docs package has the license file it need not require the main package,
to have it but if it does not require the main package, then it should have the license file.

Approved.

Comment 19 Fedora Admin user for bugzilla script actions 2023-06-16 15:15:44 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/zycore-c

Comment 20 Felix Wang 2023-06-16 15:17:23 UTC
Many thanks for the reviewing work.

Comment 21 Felix Wang 2023-06-16 15:45:07 UTC
> If the docs package has the license file it need not require the main package,
> to have it but if it does not require the main package, then it should have the license file.

And thanks for the advice.

Comment 22 Fedora Update System 2023-06-16 16:12:57 UTC
FEDORA-2023-cc39ce5e48 has been submitted as an update to Fedora 39. https://bodhi.fedoraproject.org/updates/FEDORA-2023-cc39ce5e48

Comment 23 Fedora Update System 2023-06-16 16:15:04 UTC
FEDORA-2023-cc39ce5e48 has been pushed to the Fedora 39 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.