Bug 1582829 - Review Request: scdoc - Tool for generating roff manual pages
Summary: Review Request: scdoc - Tool for generating roff manual pages
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Artur Frenszek-Iwicki
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-05-27 07:58 UTC by Timothée Floure
Modified: 2018-06-27 13:11 UTC (History)
3 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2018-06-27 13:11:35 UTC
Type: ---
Embargoed:
fedora: fedora-review+


Attachments (Terms of Use)

Description Timothée Floure 2018-05-27 07:58:06 UTC
Spec URL: https://fnux.fedorapeople.org/pkg-reviews/scdoc/1/scdoc.spec
SRPM URL: https://fnux.fedorapeople.org/pkg-reviews/scdoc/1/scdoc-1.3.3-1.fc28.src.rpm
Description: scdoc is a tool designed to make the process of writing man pages more friendly. It reads scdoc syntax from stdin and writes roff to stdout, suitable for reading with man.
Fedora Account System Username: fnux

Comment 1 Artur Frenszek-Iwicki 2018-05-27 09:33:20 UTC
Just a couple minor issues:
>URL:     https://git.sr.ht/~sircmpwn/%{name}/
>Source0: https://git.sr.ht/~sircmpwn/%{name}/snapshot/%{name}-%{version}.tar.xz
You could use %{URL} as part of Source0 to avoid repetition.

>%setup -q -n %{name}-%{version}
%{name}-%{version} is the default and be left out.

Inside the Makefile:
>CFLAGS=-g -DVERSION='"$(VERSION)"' -Wall -Wextra -Werror -Wno-unused-parameter
I may be wrong, but I think this overrides the distro-specific CFLAGS. Patch this to 'CFLAGS+=', maybe.


Apart from the CFLAGS issue, the package's approved.


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]: 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.
[x]: License file installed when any subpackage combination is installed.
[x]: Package does not own files or directories owned by other packages.
[!]: %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.
[-]: 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]: 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 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]: 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.
[x]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[?]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: %check is present and all tests pass.
[-]: 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]: Uses parallel make %{?_smp_mflags} macro.
[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: scdoc-1.3.3-1.fc27.x86_64.rpm
          scdoc-debuginfo-1.3.3-1.fc27.x86_64.rpm
          scdoc-debugsource-1.3.3-1.fc27.x86_64.rpm
          scdoc-1.3.3-1.fc27.src.rpm
scdoc.x86_64: W: spelling-error Summary(en_US) roff -> toff, riff, off
scdoc.x86_64: W: spelling-error %description -l en_US stdin -> stein, stain, stdio
scdoc.x86_64: W: spelling-error %description -l en_US roff -> toff, riff, off
scdoc.x86_64: W: spelling-error %description -l en_US stdout -> stout, std out, std-out
scdoc.x86_64: W: only-non-binary-in-usr-lib
scdoc-debugsource.x86_64: W: no-documentation
scdoc.src: W: spelling-error Summary(en_US) roff -> toff, riff, off
scdoc.src: W: spelling-error %description -l en_US stdin -> stein, stain, stdio
scdoc.src: W: spelling-error %description -l en_US roff -> toff, riff, off
scdoc.src: W: spelling-error %description -l en_US stdout -> stout, std out, std-out
4 packages and 0 specfiles checked; 0 errors, 10 warnings.




Rpmlint (debuginfo)
-------------------
Checking: scdoc-debuginfo-1.3.3-1.fc27.x86_64.rpm
1 packages and 0 specfiles checked; 0 errors, 0 warnings.





Rpmlint (installed packages)
----------------------------
sh: /usr/bin/python: No such file or directory
scdoc-debugsource.x86_64: W: invalid-url URL: https://git.sr.ht/~sircmpwn/scdoc/ <urlopen error [Errno -2] Name or service not known>
scdoc-debugsource.x86_64: W: no-documentation
scdoc.x86_64: W: spelling-error Summary(en_US) roff -> toff, riff, off
scdoc.x86_64: W: spelling-error %description -l en_US stdin -> stein, stain, stdio
scdoc.x86_64: W: spelling-error %description -l en_US roff -> toff, riff, off
scdoc.x86_64: W: spelling-error %description -l en_US stdout -> stout, std out, std-out
scdoc.x86_64: W: invalid-url URL: https://git.sr.ht/~sircmpwn/scdoc/ <urlopen error [Errno -2] Name or service not known>
scdoc.x86_64: W: only-non-binary-in-usr-lib
scdoc-debuginfo.x86_64: W: invalid-url URL: https://git.sr.ht/~sircmpwn/scdoc/ <urlopen error [Errno -2] Name or service not known>
3 packages and 0 specfiles checked; 0 errors, 9 warnings.



Requires
--------
scdoc-debugsource (rpmlib, GLIBC filtered):

scdoc (rpmlib, GLIBC filtered):
    libc.so.6()(64bit)
    rtld(GNU_HASH)

scdoc-debuginfo (rpmlib, GLIBC filtered):



Provides
--------
scdoc-debugsource:
    scdoc-debugsource
    scdoc-debugsource(x86-64)

scdoc:
    scdoc
    scdoc(x86-64)

scdoc-debuginfo:
    debuginfo(build-id)
    scdoc-debuginfo
    scdoc-debuginfo(x86-64)



Source checksums
----------------
https://git.sr.ht/~sircmpwn/scdoc/snapshot/scdoc-1.3.3.tar.xz :
  CHECKSUM(SHA256) this package     : b2f1d7e0d82f87e2490c2c2477396d65710b5f4bb4b6b08428c8d4757fd66ef6
  CHECKSUM(SHA256) upstream package : b2f1d7e0d82f87e2490c2c2477396d65710b5f4bb4b6b08428c8d4757fd66ef6


Generated by fedora-review 0.6.1 (f03e4e7) last change: 2016-05-02
Command line :/usr/bin/fedora-review -rn ./scdoc-1.3.3-1.fc28.src.rpm
Buildroot used: fedora-27-x86_64
Active plugins: Generic, Shell-api, C/C++
Disabled plugins: Java, Python, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP
Disabled flags: EXARCH, DISTTAG, EPEL5, BATCH, EPEL6

Comment 2 Robert-André Mauchin 🐧 2018-05-27 15:34:45 UTC
I would also patch the Makefile to replace "install" with "$(INSTALL)" and use:

   %make_install PREFIX=%{_prefix}

in order to keep the file timestamps.

Comment 3 Timothée Floure 2018-06-02 10:16:15 UTC
Spec URL: https://fnux.fedorapeople.org/pkg-reviews/scdoc/2/scdoc.spec
SRPM URL: https://fnux.fedorapeople.org/pkg-reviews/scdoc/2/scdoc-1.3.3-1.fc28.src.rpm

I already discussed the Makefile's issues with upstream and will submit a patch that should be included in future releases.

Comment 4 Artur Frenszek-Iwicki 2018-06-13 08:17:05 UTC
Package approved.

Comment 5 Timothée Floure 2018-06-13 08:29:32 UTC
Thanks for the review. Can you set the fedora-review flag to `+` ? It would be weird to do it myself.

Comment 6 Artur Frenszek-Iwicki 2018-06-19 21:34:21 UTC
Done. Sorry for making you wait so long.

Comment 7 Timothée Floure 2018-06-20 13:36:19 UTC
I assign this bug to Artur since it's required [0] to create the repo on src.fp.org;

[0] https://pagure.io/releng/fedora-scm-requests/issue/7070

Comment 8 Gwyn Ciesla 2018-06-20 13:47:15 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/scdoc


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