Bug 639347

Summary: docbook2man generates man pages which rpmlint does not like
Product: [Fedora] Fedora Reporter: Michal Schmidt <mschmidt>
Component: docbook-utilsAssignee: Ondrej Vasik <ovasik>
Status: CLOSED ERRATA QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: low    
Version: 13CC: ovasik, panemade
Target Milestone: ---Keywords: Reopened
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: docbook-utils-0.6.14-26.fc14 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
: 639866 (view as bug list) Environment:
Last Closed: 2010-10-27 12:55:49 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 639866    
Attachments:
Description Flags
zif.sgml - the source for a manpage none

Description Michal Schmidt 2010-10-01 14:08:28 UTC 
Created attachment 451023 [details]
zif.sgml - the source for a manpage

Description of problem:
rpmlint complained about the manpage generated by docbook2man in this package review: https://bugzilla.redhat.com/show_bug.cgi?id=631763#c6

The warning was:
manual-page-warning /usr/share/man/man1/zif.1.gz 1: warning: `\"' not defined

The warning can be reproduced using a command like this:
gtbl < zif.1 | groff -mtty-char -Tutf8 -P-c -mandoc -mandoc -wmac >/dev/null
(where zif.1 was generated by docbook2man from the attached source)

groff does not like the first line in the file:
.\\" auto-generated by docbook2man-spec $Revision: 1.2 $

I believe the correct form would be:
.\" auto-generated by docbook2man-spec $Revision: 1.2 $

Version-Release number of selected component (if applicable):
docbook-utils-0.6.14-23.fc13.noarch

How reproducible:
always

Steps to Reproduce:
1. generate a manpage from the attached source using docbook2man
2. verify it using the command mentioned above (that's basically what rpmlint uses)
  
Actual results:
a warning is produced

Expected results:
no warnings
Comment 1 Fedora Update System 2010-10-04 09:12:47 UTC 
docbook-utils-0.6.14-26.fc13 has been submitted as an update for Fedora 13.
https://admin.fedoraproject.org/updates/docbook-utils-0.6.14-26.fc13
Comment 2 Fedora Update System 2010-10-04 09:13:05 UTC 
docbook-utils-0.6.14-25.fc14 has been submitted as an update for Fedora 14.
https://admin.fedoraproject.org/updates/docbook-utils-0.6.14-25.fc14
Comment 3 Fedora Update System 2010-10-04 18:04:31 UTC 
docbook-utils-0.6.14-26.fc14 has been pushed to the Fedora 14 testing repository.  If problems still persist, please make note of it in this bug report.
 If you want to test the update, you can install it with 
 su -c 'yum --enablerepo=updates-testing update docbook-utils'.  You can provide feedback for this update here: https://admin.fedoraproject.org/updates/docbook-utils-0.6.14-26.fc14
Comment 4 Fedora Update System 2010-10-12 12:47:16 UTC 
docbook-utils-0.6.14-26.fc14 has been pushed to the Fedora 14 stable repository.  If problems still persist, please make note of it in this bug report.
Comment 5 Fedora Update System 2010-10-14 06:27:46 UTC 
docbook-utils-0.6.14-26.fc13 has been pushed to the Fedora 13 stable repository.  If problems still persist, please make note of it in this bug report.
Comment 6 Parag AN(पराग) 2010-10-27 01:25:53 UTC 
is this really fixed? I still see rpmlint complaining man page warnings in F14.
Comment 7 Ondrej Vasik 2010-10-27 06:05:11 UTC 
With re-generated manpage? What's the "... auto-generated by ..." line in the manpage?
Comment 8 Parag AN(पराग) 2010-10-27 06:19:40 UTC 
Ok. I have docbook-utils-0.6.14-26.fc14.noarch installed. I then 
fedpkg clone fontconfig
fedpkg local
rpmlint x86_64/*.rpm

and I see rpmlint warnings as

fontconfig.x86_64: W: manual-page-warning /usr/share/man/man1/fc-scan.1.gz 1: warning: macro `\"' not defined
fontconfig.x86_64: W: manual-page-warning /usr/share/man/man1/fc-query.1.gz 1: warning: macro `\"' not defined
fontconfig.x86_64: W: manual-page-warning /usr/share/man/man5/fonts-conf.5.gz 1: warning: macro `\"' not defined
fontconfig.x86_64: W: manual-page-warning /usr/share/man/man1/fc-cache.1.gz 1: warning: macro `\"' not defined
fontconfig.x86_64: W: manual-page-warning /usr/share/man/man1/fc-list.1.gz 1: warning: macro `\"' not defined
fontconfig.x86_64: W: manual-page-warning /usr/share/man/man1/fc-cat.1.gz 1: warning: macro `\"' not defined
fontconfig.x86_64: W: manual-page-warning /usr/share/man/man1/fc-match.1.gz 1: warning: macro `\"' not defined
.....


Is above testing is ok ?
Comment 9 Parag AN(पराग) 2010-10-27 06:28:09 UTC 
here is the auto-generated line

.\\" auto-generated by docbook2man-spec $Revision: 1.2 $
Comment 10 Ondrej Vasik 2010-10-27 12:55:49 UTC 
I changed the banner to '.\" auto-generated by docbook2man-spec from docbook-utils package' in this f14 update so the manpages are not updated at build time. 
See the fontconfig.spec file =>
# We don't want to rebuild the docs, but we want to install the included ones.
export HASDOCBOOK=no

(there should be USEDOCBOOK in fact, but it doesn't matter)

I just checked the rpm's in koji and the text is there, so you just have to change this to rebuild the docs and to add build requires on docbook-utils. 

Closing again ...
Comment 11 Parag AN(पराग) 2010-10-27 15:29:37 UTC 
Thank you for explanation. You are right. docs are not rebuilt in fontconfig.