Spec URL: http://people.redhat.com/nmavrogi/fedora/doxy2man.spec SRPM URL: http://people.redhat.com/nmavrogi/fedora/doxy2man-0-1.20150609git8332014.fc22.src.rpm Description: Doxy2man takes the XML generated by Doxygen as input and creates several man pages from that. It creates a summary man page for a header and for each function a detailed man page. The output is optimized for C projects. It supports the most common doxygen features, e.g. implicit and explicit see also tags, copyright, author information, brief and detailed descriptions, etc. Fedora Account System Username: nmav
Hi Nikos, I took a first pass at reviewing your package. The full review is listed below, but here are the highlights: * Please get in touch with upstream and have them include the LICENSE file. * %build fails to honor applicable compiler flags. With qmake, you need to export the flags first. e.g.: export CFLAGS=$RPM_OPT_FLAGS export CXXFLAGS=$RPM_OPT_FLAGS qmake-qt5 For an example, please refer to the spec file for KeePassX: http://pkgs.fedoraproject.org/cgit/keepassx.git/tree/keepassx.spec * Changelog needs the correct version number: 0-1.20150609git8332014 * Please do not hard-code directory names like you did with manpage.xsl on line 40. * Please provide koji scratch builds for F21, F22, and Rawhide. * SourceX entries need URLs. Source1 doesn't have a URL at all. For Source0, I've been pretty successful with the following GitHub URL scheme: %{url}/archive/%{git_commit_hash}/%{name}-%{git_commit_hash}.tar.gz * Please use %{name} anywhere you can, such as the URL and source file names. I'm happy to complete the review if you can address the above issues. I didn't get a chance to ensure that it works as advertised, but will do so when I get a chance. Regards, Jeff Package Review ============== Legend: [x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated [ ] = Manual review needed ===== 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. [-]: 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]: License field in the package spec file matches the actual license. Note: Checking patched sources after %prep for licenses. Licenses found: "Unknown or generated". 2 files have unknown license. Detailed output of licensecheck in /mnt/storage/homes/jeff/tmp/reviews/doxy2man /review-doxy2man/licensecheck.txt [!]: %build honors applicable compiler flags or justifies otherwise. With qmake, you need to add the following: export CFLAGS=$RPM_OPT_FLAGS export CXXFLAGS=$RPM_OPT_FLAGS See the spec file for keepassx as an example: http://pkgs.fedoraproject.org/cgit/keepassx.git/tree/keepassx.spec [x]: Package contains no bundled libraries without FPC exception. [!]: Changelog in prescribed format. Version number is wrong. Needs to be: 0-1.20150609git8332014 See: https://fedoraproject.org/wiki/Packaging:NamingGuidelines#Snapshot_packages [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. [!]: Package consistently uses macros (instead of hard-coded directory names). Need to change path to manpage.xsl in the call to xsltproc in %build to use macros. [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. [!]: Package complies to the Packaging Guidelines See other notes [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]: All build dependencies are listed in BuildRequires, except for any that are listed in the exceptions section of Packaging Guidelines. [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]: 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: [!]: If the source package does not include license text(s) as a separate file from upstream, the packager SHOULD query upstream to include it. Please encourage upstream to include LICENSE file. [x]: Final provides and requires are sane (see attachments). [x]: Package functions as described. [x]: Latest version is packaged. [x]: 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 Source1 url? [-]: 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. Koji builds? [-]: %check is present and all tests pass. [x]: Packages should try to preserve timestamps of original installed files. [x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file [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]: Uses parallel make %{?_smp_mflags} macro. [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: doxy2man-0-1.20150609git8332014.fc22.i686.rpm doxy2man-0-1.20150609git8332014.fc22.src.rpm doxy2man.i686: W: spelling-error Summary(en_US) doxygen -> oxygen, d oxygen doxy2man.i686: W: spelling-error %description -l en_US doxygen -> oxygen, d oxygen doxy2man.i686: W: incoherent-version-in-changelog 0-1.20150609 ['0-1.20150609git8332014.fc22', '0-1.20150609git8332014'] doxy2man.src: W: spelling-error Summary(en_US) doxygen -> oxygen, d oxygen doxy2man.src: W: spelling-error %description -l en_US doxygen -> oxygen, d oxygen doxy2man.src:14: W: macro-in-comment %{git_commit_hash} doxy2man.src: W: invalid-url Source0: gsauthof-doxy2man-8332014.tar.gz 2 packages and 0 specfiles checked; 0 errors, 7 warnings. Rpmlint (debuginfo) ------------------- Checking: doxy2man-debuginfo-0-1.20150609git8332014.fc22.i686.rpm 1 packages and 0 specfiles checked; 0 errors, 0 warnings. Rpmlint (installed packages) ---------------------------- doxy2man.i686: W: spelling-error Summary(en_US) doxygen -> oxygen, d oxygen doxy2man.i686: W: spelling-error %description -l en_US doxygen -> oxygen, d oxygen doxy2man.i686: W: incoherent-version-in-changelog 0-1.20150609 ['0-1.20150609git8332014.fc22', '0-1.20150609git8332014'] 2 packages and 0 specfiles checked; 0 errors, 3 warnings. Requires -------- doxy2man (rpmlib, GLIBC filtered): libGL.so.1 libQt5Core.so.5 libQt5Gui.so.5 libQt5Network.so.5 libQt5Xml.so.5 libQt5XmlPatterns.so.5 libc.so.6 libgcc_s.so.1 libgcc_s.so.1(GCC_3.0) libm.so.6 libpthread.so.0 libstdc++.so.6 libstdc++.so.6(CXXABI_1.3) rtld(GNU_HASH) Provides -------- doxy2man: doxy2man doxy2man(x86-32) Generated by fedora-review 0.6.0 (3c5c9d7) last change: 2015-05-20 Command line :/usr/bin/fedora-review -n doxy2man Buildroot used: fedora-22-i386 Active plugins: Generic, Shell-api Disabled plugins: Java, C/C++, Python, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP, Ruby Disabled flags: EXARCH, DISTTAG, EPEL5, BATCH, EPEL6
(In reply to Jeff Backus from comment #1) > Hi Nikos, Thank you for the review. > I took a first pass at reviewing your package. The full review is listed > below, but here are the highlights: > * Please get in touch with upstream and have them include the LICENSE file. Done. https://github.com/gsauthof/doxy2man/issues/2 > * %build fails to honor applicable compiler flags. With qmake, you need to > export the flags first. e.g.: > export CFLAGS=$RPM_OPT_FLAGS > export CXXFLAGS=$RPM_OPT_FLAGS > qmake-qt5 Done. > * Changelog needs the correct version number: 0-1.20150609git8332014 > * Please do not hard-code directory names like you did with manpage.xsl on > line 40. There is no other way for it. Anyway it is no longer needed in the spec since the manpage is now upstream. > * Please provide koji scratch builds for F21, F22, and Rawhide. F21: http://koji.fedoraproject.org/koji/taskinfo?taskID=10196035 F22: http://koji.fedoraproject.org/koji/taskinfo?taskID=10195969 rawhide: http://koji.fedoraproject.org/koji/taskinfo?taskID=10196039 > * SourceX entries need URLs. Source1 doesn't have a URL at all. For Source0, > I've been pretty successful with the following GitHub URL scheme: Updated and simplified versioning by removing the hash. > * Please use %{name} anywhere you can, such as the URL and source file names. I'd prefer not. I believe the URL should be available directly to someone reading the spec file without any need to replace parts to access it. About the files I'd also prefer to have things simple. I'll only change that if you insist for accepting the package. > I'm happy to complete the review if you can address the above issues. I > didn't get a chance to ensure that it works as advertised, but will do so > when I get a chance. The simplest way to check it if it works to generate the manpages in https://github.com/radcli/radcli (./configure && make && cd doc/man/) Updated URLs: http://people.redhat.com/nmavrogi/fedora/doxy2man.spec http://people.redhat.com/nmavrogi/fedora/doxy2man-0-1.20150624git.fc22.src.rpm
(In reply to Nikos Mavrogiannopoulos from comment #2) > Thank you for the review. Welcome! > > * Please get in touch with upstream and have them include the LICENSE file. > > Done. > https://github.com/gsauthof/doxy2man/issues/2 Thanks! Looks like upstream has already addressed the issue. > > * %build fails to honor applicable compiler flags. With qmake, you need to > > export the flags first. e.g.: > > export CFLAGS=$RPM_OPT_FLAGS > > export CXXFLAGS=$RPM_OPT_FLAGS > > qmake-qt5 > > Done. Looks good. Thanks! > > * Please do not hard-code directory names like you did with manpage.xsl on > > line 40. > > There is no other way for it. Anyway it is no longer needed in the spec > since the manpage is now upstream. Glad the point is now moot. > > * Please provide koji scratch builds for F21, F22, and Rawhide. > > F21: http://koji.fedoraproject.org/koji/taskinfo?taskID=10196035 > F22: http://koji.fedoraproject.org/koji/taskinfo?taskID=10195969 > rawhide: http://koji.fedoraproject.org/koji/taskinfo?taskID=10196039 Builds look good. > > * SourceX entries need URLs. Source1 doesn't have a URL at all. For Source0, > > I've been pretty successful with the following GitHub URL scheme: > > Updated and simplified versioning by removing the hash. Looks good - and more legible. Thanks. > > * Please use %{name} anywhere you can, such as the URL and source file names. > > I'd prefer not. I believe the URL should be available directly to someone > reading the spec file without any need to replace parts to access it. About > the files I'd also prefer to have things simple. I'll only change that if > you insist for accepting the package. Fair enough. I won't push, as you are using macros for everything else. > > I'm happy to complete the review if you can address the above issues. I > > didn't get a chance to ensure that it works as advertised, but will do so > > when I get a chance. > > The simplest way to check it if it works to generate the manpages in > https://github.com/radcli/radcli (./configure && make && cd doc/man/) > > Updated URLs: > http://people.redhat.com/nmavrogi/fedora/doxy2man.spec > http://people.redhat.com/nmavrogi/fedora/doxy2man-0-1.20150624git.fc22.src. > rpm Thanks for addressing all of the issues I raised. Package looks good, though I do have one last request: please update to the latest version since it does contain a license file. Regards, Jeff
(In reply to Jeff Backus from comment #3) > > > I'm happy to complete the review if you can address the above issues. I > > > didn't get a chance to ensure that it works as advertised, but will do so > > > when I get a chance. > > The simplest way to check it if it works to generate the manpages in > > https://github.com/radcli/radcli (./configure && make && cd doc/man/) > > Updated URLs: > > http://people.redhat.com/nmavrogi/fedora/doxy2man.spec > > http://people.redhat.com/nmavrogi/fedora/doxy2man-0-1.20150624git.fc22.src. > > rpm > Thanks for addressing all of the issues I raised. Package looks good, though > I do have one last request: please update to the latest version since it > does contain a license file. Done. Thanks. http://people.redhat.com/nmavrogi/fedora/doxy2man.spec http://people.redhat.com/nmavrogi/fedora/doxy2man-0-1.20150625git.fc22.src.rpm
(In reply to Nikos Mavrogiannopoulos from comment #4) > (In reply to Jeff Backus from comment #3) > > Thanks for addressing all of the issues I raised. Package looks good, though > > I do have one last request: please update to the latest version since it > > does contain a license file. > > Done. Thanks. > > http://people.redhat.com/nmavrogi/fedora/doxy2man.spec > http://people.redhat.com/nmavrogi/fedora/doxy2man-0-1.20150625git.fc22.src. > rpm Looks good! Package PASSES. Package Review ============== Legend: [x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated [ ] = Manual review needed ===== 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. Note: Checking patched sources after %prep for licenses. Licenses found: "Unknown or generated". 2 files have unknown license. Detailed output of licensecheck in /mnt/storage/homes/jeff/tmp/reviews/doxy2man /review-doxy2man/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. [x]: 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]: 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]: All build dependencies are listed in BuildRequires, except for any that are listed in the exceptions section of Packaging Guidelines. [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]: 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: [x]: 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). [x]: Package functions as described. [x]: Latest version is packaged. [x]: Package does not include license text files separate from upstream. [x]: 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]: Packager, Vendor, PreReq, Copyright tags should not be in spec file [x]: Sources can be downloaded from URI in Source: tag [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]: Uses parallel make %{?_smp_mflags} macro. [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: doxy2man-0-1.20150625git.fc22.i686.rpm doxy2man-0-1.20150625git.fc22.src.rpm doxy2man.i686: W: spelling-error Summary(en_US) doxygen -> oxygen, d oxygen doxy2man.i686: W: spelling-error %description -l en_US doxygen -> oxygen, d oxygen doxy2man.src: W: spelling-error Summary(en_US) doxygen -> oxygen, d oxygen doxy2man.src: W: spelling-error %description -l en_US doxygen -> oxygen, d oxygen 2 packages and 0 specfiles checked; 0 errors, 4 warnings. Rpmlint (debuginfo) ------------------- Checking: doxy2man-debuginfo-0-1.20150625git.fc22.i686.rpm 1 packages and 0 specfiles checked; 0 errors, 0 warnings. Rpmlint (installed packages) ---------------------------- doxy2man.i686: W: spelling-error Summary(en_US) doxygen -> oxygen, d oxygen doxy2man.i686: W: spelling-error %description -l en_US doxygen -> oxygen, d oxygen 2 packages and 0 specfiles checked; 0 errors, 2 warnings. Requires -------- doxy2man (rpmlib, GLIBC filtered): libGL.so.1 libQt5Core.so.5 libQt5Gui.so.5 libQt5Network.so.5 libQt5Xml.so.5 libQt5XmlPatterns.so.5 libc.so.6 libgcc_s.so.1 libgcc_s.so.1(GCC_3.0) libm.so.6 libpthread.so.0 libstdc++.so.6 libstdc++.so.6(CXXABI_1.3) rtld(GNU_HASH) Provides -------- doxy2man: doxy2man doxy2man(x86-32) Source checksums ---------------- https://github.com/gsauthof/doxy2man/archive/4d6a7dfd3e53f3edc2508c078c309eccd44cc8f3/4d6a7dfd3e53f3edc2508c078c309eccd44cc8f3.tar.gz#/doxy2man-4d6a7dfd3e53f3edc2508c078c309eccd44cc8f3.tar.gz : CHECKSUM(SHA256) this package : 391162087d385a8795389d70ae342ad5bc158701691087cdfa68b556ab15ae5d CHECKSUM(SHA256) upstream package : 391162087d385a8795389d70ae342ad5bc158701691087cdfa68b556ab15ae5d Generated by fedora-review 0.6.0 (3c5c9d7) last change: 2015-05-20 Command line :/usr/bin/fedora-review -n doxy2man Buildroot used: fedora-22-i386 Active plugins: Generic, Shell-api Disabled plugins: Java, C/C++, Python, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP, Ruby Disabled flags: EXARCH, DISTTAG, EPEL5, BATCH, EPEL6
New Package SCM Request ======================= Package Name: doxy2man Short Description: Create man pages from doxygen XML output Owners: nmav Branches: f21 f22 epel7 InitialCC:
Git done (by process-git-requests).
doxy2man-0-1.20150625git.fc22 has been submitted as an update for Fedora 22. https://admin.fedoraproject.org/updates/doxy2man-0-1.20150625git.fc22
doxy2man-0-1.20150625git.fc22 has been pushed to the Fedora 22 stable repository.