[Bug 2121594] Review Request: python-furo - Clean customizable Sphinx documentation theme

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



https://bugzilla.redhat.com/show_bug.cgi?id=2121594



--- Comment #2 from Peter Lemenkov <lemenkov@xxxxxxxxx> ---
The package looks qite good to me. Except for the way we have to deal with JS
bundling but this is a thing which won't change anytime soon.


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

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


Issues:
=======
- 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.
  Note: Unversionned Python dependency found.
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/Python/#_dependencies

^^^ I guess this is something went wrong on my machine. It should be
autogenerated I believe.


- 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.
  Note: License file furo.js.LICENSE.txt is not marked as %license
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/LicensingGuidelines/#_license_text

^^^ I cannot see it in a source tarball. Likely a build artefact so it can be
omitted as well as the previous one.


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

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 -
MIT. Also please check rpmlint messages for *-doc subpackage.

[!]: License file installed when any subpackage combination is installed. I
suggest you to explicitly add %license file to the main package as well as for
%doc.

[X +/-]: Package contains no bundled libraries without FPC exception. It's JS.

[X]: Changelog in prescribed format.
[X]: Sources contain only permissible code or content.
[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]: Requires correct, justified where necessary.
[X]: Spec file is legible and written in American English.
[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.
[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]: 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]: Packages must not store files under /srv, /opt or /usr/local

Python:
[x]: Package contains BR: python2-devel or python3-devel
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
[x]: Binary eggs must be removed in %prep

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

Generic:
[X]: Final provides and requires are sane (see attachments).
[X]: Package does not include license text files separate from upstream.
[X]: SourceX tarball generation or download is documented. See comments above.
[X]: Package should compile and build into binary rpms on all supported
     architectures.
[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 all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


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

python-furo-doc.noarch: E: zero-length
/usr/share/doc/python-furo-doc/html/_static/scripts/furo-extensions.js
python3-furo.noarch: E: zero-length
/usr/lib/python3.11/site-packages/furo/theme/furo/static/scripts/furo-extensions.js
python-furo-doc.noarch: W: invalid-license BSD-2-Clause
python-furo-doc.noarch: W: invalid-license CC-BY-SA-4.0
python-furo-doc.noarch: W: files-duplicate
/usr/share/doc/python-furo-doc/html/_static/design-style.4045f2051d55cab465a707391d5b2007.min.css
/usr/share/doc/python-furo-doc/html/_sphinx_design_static/design-style.4045f2051d55cab465a707391d5b2007.min.css
python-furo-doc.noarch: W: files-duplicate
/usr/share/doc/python-furo-doc/html/_static/design-tabs.js
/usr/share/doc/python-furo-doc/html/_sphinx_design_static/design-tabs.js
 2 packages and 0 specfiles checked; 2 errors, 4 warnings, 2 badness; has taken
0.1 s 


^^^ Please check these invalid-license messages before uploading.


Source checksums
----------------
https://github.com/pradyunsg/furo/archive/2022.06.21/furo-2022.06.21.tar.gz :
  CHECKSUM(SHA256) this package     :
d23ee549c4275e68e7fd498055e9e7c854a98bdd81522e0303947e3a25defb3e
  CHECKSUM(SHA256) upstream package :
d23ee549c4275e68e7fd498055e9e7c854a98bdd81522e0303947e3a25defb3e


Requires
--------
python3-furo (rpmlib, GLIBC filtered):
    (python3.11dist(sphinx) < 6~~ with python3.11dist(sphinx) >= 4)
    python(abi)
    python3.11dist(beautifulsoup4)
    python3.11dist(pygments)
    python3.11dist(sphinx-basic-ng)

python-furo-doc (rpmlib, GLIBC filtered):



Provides
--------
python3-furo:
    python-furo
    python3-furo
    python3.11-furo
    python3.11dist(furo)
    python3dist(furo)

python-furo-doc:
    python-furo-doc



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



It looks good to me. I am going to approve it as is but please address my minor
remarks before uploading.


-- 
You are receiving this mail because:
You are always notified about changes to this product and component
You are on the CC list for the bug.
https://bugzilla.redhat.com/show_bug.cgi?id=2121594
_______________________________________________
package-review mailing list -- package-review@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to package-review-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/package-review@xxxxxxxxxxxxxxxxxxxxxxx
Do not reply to spam, report it: https://pagure.io/fedora-infrastructure/new_issue




[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Yosemite Conditions]     [KDE Users]

  Powered by Linux