Bug 1854392 - Review Request: gstreamer1-doc - GStreamer 1.0 documentation
Summary: Review Request: gstreamer1-doc - GStreamer 1.0 documentation
Keywords:
Status: CLOSED RAWHIDE
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-07-07 11:56 UTC by Wim Taymans
Modified: 2020-07-09 09:10 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2020-07-09 09:10:16 UTC
Type: ---
Embargoed:
eclipseo: fedora-review+


Attachments (Terms of Use)

Description Wim Taymans 2020-07-07 11:56:59 UTC
Spec URL: https://people.freedesktop.org/~wtay/SPECS/gstreamer1-doc.spec
SRPM URL: https://people.freedesktop.org/~wtay/SRPMS/gstreamer1-doc-1.17.2-1.fc32.src.rpm
Description: GStreamer 1.0 plugin documentation and manuals
Fedora Account System Username: wtaymans

The GStreamer project recommends shipping their prebuild documentation instead of building our own per module documentation blob.

Comment 1 Robert-André Mauchin 🐧 2020-07-07 16:36:32 UTC
 - Don't mix tabs and spaces (tab line 10)

 - add a full stop for the description

 - %dir %{_datadir}/gtk-doc/html/GStreamer-%{majorminor}/ is not needed, it is redundant with %{_datadir}/gtk-doc/html/GStreamer-%{majorminor}/

 - It includes libraries under MIT

Expat License
-------------
gstreamer-docs-1.17.2/devhelp/books/GStreamer/assets/css/bootstrap-toc.min.css
gstreamer-docs-1.17.2/devhelp/books/GStreamer/assets/css/custom_bootstrap.css
gstreamer-docs-1.17.2/devhelp/books/GStreamer/assets/js/bootstrap-toc.min.js
gstreamer-docs-1.17.2/devhelp/books/GStreamer/assets/js/bootstrap.js
gstreamer-docs-1.17.2/devhelp/books/GStreamer/assets/js/jquery.js
gstreamer-docs-1.17.2/devhelp/books/GStreamer/assets/js/jquery.touchSwipe.min.js
gstreamer-docs-1.17.2/devhelp/books/GStreamer/assets/js/scrollspy.js
gstreamer-docs-1.17.2/html/assets/css/bootstrap-toc.min.css
gstreamer-docs-1.17.2/html/assets/css/custom_bootstrap.css
gstreamer-docs-1.17.2/html/assets/js/bootstrap-toc.min.js
gstreamer-docs-1.17.2/html/assets/js/bootstrap.js
gstreamer-docs-1.17.2/html/assets/js/jquery.js
gstreamer-docs-1.17.2/html/assets/js/jquery.touchSwipe.min.js
gstreamer-docs-1.17.2/html/assets/js/scrollspy.js

 Add the license to the License field and explain the breakdown


 - Shouldn't that whole package be noarch?




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.
[-]: Development (unversioned) .so files in -devel subpackage, if present.
     Note: Unversioned so-files in private %_libdir subdirectory (see
     attachment). Verify they are not in ld path.
[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.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "*No copyright* GPL (v3)", "Expat
     License", "GNU Lesser General Public License (v2.1 or later)", "*No
     copyright* GNU Lesser General Public License". 163176 files have
     unknown license. Detailed output of licensecheck in
     /home/bob/packaging/review/gstreamer1-doc/review-
     gstreamer1-doc/licensecheck.txt
[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.
[-]: 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]: 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]: 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]: 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 0 bytes in 0 files.
[x]: Packages must not store files under /srv, /opt or /usr/local

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

Generic:
[-]: Avoid bundling fonts in non-fonts packages.
     Note: Package contains font files
[-]: 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.
[-]: 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]: 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:
[!]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
     Note: Arch-ed rpms have a total of 490915840 bytes in /usr/share
     gstreamer1-doc-1.17.2-1.fc33.x86_64.rpm:490915840
     See:
     https://fedoraproject.org/wiki/Packaging:ReviewGuidelines#Package_Review_Guidelines
[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
-------
Checking: gstreamer1-doc-1.17.2-1.fc33.x86_64.rpm
          gstreamer1-doc-1.17.2-1.fc33.src.rpm
gstreamer1-doc.x86_64: E: no-binary
gstreamer1-doc.x86_64: E: zero-length /usr/share/doc/gstreamer1-doc/html/assets/templates/navbar_center.html
gstreamer1-doc.x86_64: E: zero-length /usr/share/doc/gstreamer1-doc/html/assets/templates/stylesheets.html
gstreamer1-doc.x86_64: E: zero-length /usr/share/gtk-doc/html/GStreamer-1.0/assets/templates/navbar_center.html
gstreamer1-doc.x86_64: E: zero-length /usr/share/gtk-doc/html/GStreamer-1.0/assets/templates/stylesheets.html
gstreamer1-doc.src: W: no-%build-section
gstreamer1-doc.src:10: W: mixed-use-of-spaces-and-tabs (spaces: line 1, tab: line 10)
2 packages and 0 specfiles checked; 5 errors, 2 warnings.

Comment 2 Wim Taymans 2020-07-08 09:38:45 UTC
Thanks for review, updated spec and srpm are available now:

Spec URL: https://people.freedesktop.org/~wtay/SPECS/gstreamer1-doc.spec
SRPM URL: https://people.freedesktop.org/~wtay/SRPMS/gstreamer1-doc-1.17.2-2.fc32.src.rpm

I'm not sure what to do about the empty files reported by rpmlint:

# rpmlint gstreamer1-doc
gstreamer1-doc.noarch: E: zero-length /usr/share/doc/gstreamer1-doc/html/assets/templates/navbar_center.html
gstreamer1-doc.noarch: E: zero-length /usr/share/doc/gstreamer1-doc/html/assets/templates/stylesheets.html
gstreamer1-doc.noarch: E: zero-length /usr/share/gtk-doc/html/GStreamer-1.0/assets/templates/navbar_center.html
gstreamer1-doc.noarch: E: zero-length /usr/share/gtk-doc/html/GStreamer-1.0/assets/templates/stylesheets.html
1 packages and 0 specfiles checked; 4 errors, 0 warnings.

Comment 3 Robert-André Mauchin 🐧 2020-07-08 12:58:51 UTC
> I'm not sure what to do about the empty files reported by rpmlint:

 I wouldn't worry about it, I'm expecting that they are needed by gtk-doc as placeholder?



Package is approved.

Comment 4 Gwyn Ciesla 2020-07-08 15:47:01 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/gstreamer1-doc


Note You need to log in before you can comment on or make changes to this bug.