https://bugzilla.redhat.com/show_bug.cgi?id=2168546
Bug ID: 2168546 Summary: ReviewRequest: python-sphinxygen - A script to read Doxygen XML output and emit ReST for Sphinx Product: Fedora Version: rawhide Status: NEW Component: Package Review Assignee: nobody@fedoraproject.org Reporter: benson_muite@emailplus.org QA Contact: extras-qa@fedoraproject.org CC: package-review@lists.fedoraproject.org Target Milestone: --- Classification: Fedora
Spec URL: https://download.copr.fedorainfracloud.org/results/fed500/python-sphinxgen/f... SRPM URL: https://download.copr.fedorainfracloud.org/results/fed500/python-sphinxgen/f...
Description: Sphinxygen is a Python module/script that generates Sphinx markup to describe a C API, from an XML description extracted by Doxygen.
Fedora Account System Username: fed500
This is a documentation generation dependency of the next version of zix.
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
Benson Muite benson_muite@emailplus.org changed:
What |Removed |Added ---------------------------------------------------------------------------- Blocks| |2167178
Referenced Bugs:
https://bugzilla.redhat.com/show_bug.cgi?id=2167178 [Bug 2167178] Review Request: zix - A lightweight C99 portability and data structure library
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
lichaoran pkwarcraft@gmail.com changed:
What |Removed |Added ---------------------------------------------------------------------------- CC| |jkadlcik@redhat.com, | |pkwarcraft@gmail.com
--- Comment #1 from lichaoran pkwarcraft@gmail.com --- Hi Benson, I'd like to take this ticket as my first review package, @Jaku
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
lichaoran pkwarcraft@gmail.com changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags| |fedora-review?
--- Comment #2 from lichaoran pkwarcraft@gmail.com ---
# All files under ISC, though some tests and # unpackaged files are under 0BSD License: ISC
I think the license
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
--- Comment #3 from lichaoran pkwarcraft@gmail.com ---
I think the license
Sorry for may mistaken type :-
# All files under ISC, though some tests and # unpackaged files are under 0BSD License: ISC
I think the license should also contain 0BSD as the licensecheck says:
BSD 0-Clause License -------------------- sphinxygen-v1.0.0/.clang-format sphinxygen-v1.0.0/LICENSES/0BSD.txt sphinxygen-v1.0.0/test/c/Doxyfile sphinxygen-v1.0.0/test/c/conf.py
ISC License ----------- sphinxygen-v1.0.0/doc/sphinxygen.1 sphinxygen-v1.0.0/src/sphinxygen/sphinxygen.py sphinxygen-v1.0.0/test/c/include/testlib.h sphinxygen-v1.0.0/test/c/index.rst sphinxygen-v1.0.0/test/test_sphinxygen.py
ISC License BSD 0-Clause License -------------------------------- sphinxygen-v1.0.0/.reuse/dep5 sphinxygen-v1.0.0/meson.build sphinxygen-v1.0.0/pyproject.toml
Unknown or generated -------------------- sphinxygen-v1.0.0/.pylintrc sphinxygen-v1.0.0/CONTRIBUTING.md sphinxygen-v1.0.0/LICENSE sphinxygen-v1.0.0/MANIFEST.in sphinxygen-v1.0.0/NEWS sphinxygen-v1.0.0/README.md
so maybe update the License field to mention both, like this:
License: ISC AND 0BSD
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
--- Comment #4 from lichaoran pkwarcraft@gmail.com --- Some comments:
- python3-sphinxygen.noarch: W: spurious-executable-perm /usr/share/man/man1/sphinxygen.1.gz - source0 cannot be downloaded, maybe it should be Source0: %{forgeurl}/-/archive/v%{version}/%{srcname}-v%{version}.tar.gz
------
Generic: [x]: Package successfully compiles and builds into binary rpms on at least one supported primary architecture. Note: Using prebuilt packages [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: "BSD 0-Clause License", "Unknown or generated", "ISC License BSD 0-Clause License", "ISC License". 6 files have unknown license. Detailed output of licensecheck in /root/python- sphinxygen/result/python-sphinxygen/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. [?]: 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. [x]: 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. [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 2 files. [x]: Package complies to the Packaging Guidelines [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 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
[71/1940] 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
Python: [x]: Python eggs must not download any dependencies during the build process. [x]: A package which is used by another package via an egg interface should provide egg info. [x]: Package meets the Packaging Guidelines::Python [x]: Package contains BR: python2-devel or python3-devel [x]: Packages MUST NOT have dependencies (either build-time or runtime) on packages named with the unversioned python- prefix unless no properly versioned package exists. Dependencies on Python packages instead MUST use names beginning with python2- or python3- as appropriate. [x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files [x]: Binary eggs must be removed in %prep
===== SHOULD items =====
Generic: [x]: Reviewer should test that the package builds in mock. [!]: Sources can be downloaded from URI in Source: tag Note: Could not download Source0:
https://gitlab.com/drobilla/sphinxygen-/archive/v1.0.0/sphinxygen-v1.0.0.tar... See: https://docs.fedoraproject.org/en-US/packaging- guidelines/SourceURL/ [ ]: If the source package does not include license text(s) as a separate file from upstream, the packager SHOULD query upstream to include it. [ ]: Final provides and requires are sane (see attachments). [ ]: Package functions as described. [ ]: Latest version is packaged. [ ]: Package does not include license text files separate from upstream. [ ]: SourceX tarball generation or download is documented. Note: Package contains tarball without URL, check comments [ ]: 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. [ ]: %check is present and all tests pass. [ ]: Packages should try to preserve timestamps of original installed files. [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]: 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: There are rpmlint messages (see attachment).
Rpmlint ------- Checking: python3-sphinxygen-1.0.0-1.fc39.noarch.rpm python-sphinxygen-1.0.0-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/tmp45eiui7y')] checks: 31, packages: 2
python3-sphinxygen.noarch: W: spurious-executable-perm /usr/share/man/man1/sphinxygen.1.gz python3-sphinxygen.noarch: E: non-executable-script /usr/lib/python3.11/site-packages/sphinxygen/sphinxygen.py 644 /usr/bin/env python3 =========================================================================== 2 packages and 0 specfiles checked; 1 errors, 1 warnings, 1 badness; has taken 0.1 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: 1
python3-sphinxygen.noarch: W: spurious-executable-perm /usr/share/man/man1/sphinxygen.1.gz python3-sphinxygen.noarch: E: non-executable-script /usr/lib/python3.11/site-packages/sphinxygen/sphinxygen.py 644 /usr/bin/env python3 1 packages and 0 specfiles checked; 1 errors, 1 warnings, 1 badness; has taken 0.0 s
Requires -------- python3-sphinxygen (rpmlib, GLIBC filtered): /usr/bin/python3 python(abi)
Provides -------- python3-sphinxygen: python-sphinxygen python3-sphinxygen python3.11-sphinxygen python3.11dist(sphinxygen) python3dist(sphinxygen)
Generated by fedora-review 0.9.0 (6761b6c) last change: 2022-08-23 Command line :/usr/bin/fedora-review --no-colors --prebuilt --rpm-spec --name python-sphinxygen --mock-config /etc/mock/fedora-rawhide-x86_64.cfg Buildroot used: fedora-rawhide-x86_64 Active plugins: Generic, Python, Shell-api Disabled plugins: Ocaml, PHP, Perl, R, fonts, SugarActivity, Haskell, C/C++, Java Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
Benson Muite benson_muite@emailplus.org changed:
What |Removed |Added ---------------------------------------------------------------------------- Doc Type|--- |If docs needed, set a value
--- Comment #5 from Benson Muite benson_muite@emailplus.org --- Thanks for taking the review.
The licensing is ok, files with 0BSD are not packaged and do not end up in the binary RPM: https://docs.fedoraproject.org/en-US/packaging-guidelines/LicensingGuideline...
Will update the file permissions.
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
Maxwell G maxwell@gtmx.me changed:
What |Removed |Added ---------------------------------------------------------------------------- CC| |maxwell@gtmx.me
--- Comment #6 from Maxwell G maxwell@gtmx.me --- Thanks, lichaoran, for preforming an informal review and completing the template. Here are some comments of my own:
%global srcname sphinxygen
This macro is unnecessary and makes the specfile harder to read IMO. I'd use the literal values, but that's up to you.
%global forgeurl https://gitlab.com/drobilla/sphinxygen Version: 1.0.0 %global tag %{version} %forgemeta
I'd avoid the forge macros outside of Go and Fonts packaging. They aren't really maintained anymore.
Name: python-%{srcname}
Optionally, remove %{srcname} here.
URL: %forgeurl # Source from Pypi does not include all test files Source0: %{forgeurl}-/archive/v%{version}/%{srcname}-v%{version}.tar.gz
Optionally, remove %forgeurl here. Also, you can replace Source0 with Source. Manually numbering sources is no longer required.
BuildRequires: gzip
No need to manually BuildRequire this.
BuildRequires: python3dist(setuptools)
This is generated by %pyproject_buildrequires. You should remove it.
%package -n python3-%{srcname}
Optionally, remove %{srcname}.
Summary: %{summary} %{?python_provide:%python_provide python3-%{srcname}}
%python_provide is deprecated and unnecessary. Let the generators handle this.
%prep %autosetup -n %{srcname}-v%{version}
Optionally, remove %{srcname}.
%build %pyproject_wheel #compress man page gzip doc/%{srcname}.1
Don't compress the manpage manually.
mkdir -p %{buildroot}%{_mandir}/man1 install doc/%{srcname}.1.gz %{buildroot}%{_mandir}/man1/
You should preserve mtimes by using `-p`. You could use:
install -Dpm 0644 doc/sphinxygen.1 -t %{builroot}%{_mandir}/man1/
%files -n python3-%{srcname} -f %{pyproject_files} %doc README.md NEWS %{_bindir}/%{srcname}
Optionally, remove %{srcname}.
%{_mandir}/man1/%{srcname}.1.gz
Replace this with
%{_mandir}/man1/%{srcname}.1*
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
--- Comment #7 from Maxwell G maxwell@gtmx.me ---
python3-sphinxygen.noarch: E: non-executable-script /usr/lib/python3.11/site-packages/sphinxygen/sphinxygen.py 644 /usr/bin/env python3
You should both remove the executable bit and remove the shebang, it seems.
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
--- Comment #8 from Benson Muite benson_muite@emailplus.org --- Thanks for the feedback. Updated. spec: https://download.copr.fedorainfracloud.org/results/fed500/python-sphinxgen/f... srpm: https://download.copr.fedorainfracloud.org/results/fed500/python-sphinxgen/f...
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
--- Comment #9 from Maxwell G maxwell@gtmx.me --- [fedora-review-service-build]
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
Maxwell G maxwell@gtmx.me changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags|fedora-review? | Status|NEW |POST Assignee|nobody@fedoraproject.org |maxwell@gtmx.me
--- Comment #10 from Maxwell G maxwell@gtmx.me --- sed is part of the buildroot, so you don't really need to manually require it. Also, I'd add a comment saying that the license is handled by %pyproject_savefiles.
Anyways:
- License expression is valid and matches the sources. - License file is included and marked with %license (handled by %pyproject_save_files.) - License is allowed for Fedora. - Package complies with the new Python Packaging Guidelines and the general Packaging Guidelines - No relevant rpmlint errors - No bundled content - Package builds in mock - Unit tests are run in %check
Package approved. Thanks to lichaoran for preforming the initial review.
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
Maxwell G maxwell@gtmx.me changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags| |fedora-review+
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
--- Comment #11 from Fedora Admin user for bugzilla script actions fedora-admin-xmlrpc@fedoraproject.org --- The Pagure repository was created at https://src.fedoraproject.org/rpms/python-sphinxygen
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
--- Comment #12 from Benson Muite benson_muite@emailplus.org --- Thanks for the review.
https://bugzilla.redhat.com/show_bug.cgi?id=2168546
Benson Muite benson_muite@emailplus.org changed:
What |Removed |Added ---------------------------------------------------------------------------- Status|POST |CLOSED Resolution|--- |RAWHIDE Last Closed| |2023-02-24 13:04:31
package-review@lists.fedoraproject.org