Bug 749725

Summary:	papi: man pages of the papi utilities
Product:	[Fedora] Fedora	Reporter:	Jose Pedro Oliveira <jose.p.oliveira.oss>
Component:	papi	Assignee:	William Cohen <wcohen>
Status:	CLOSED RAWHIDE	QA Contact:	Fedora Extras Quality Assurance <extras-qa>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	rawhide	CC:	wcohen
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	papi-devel-4.2.0-3.fc17	Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2011-10-31 15:48:25 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:

Description Jose Pedro Oliveira 2011-10-28 03:55:29 UTC

Description of problem:
The man pages of the papi utilities (1) are being packaged in the papi-devel RPM. Some of the man1 pages also appear to be duplicated: with and without the papi_ sufix.


Version-Release number of selected component (if applicable):
4.2.0-1.fc17

Expected results:
man1 pages in the main papi RPM

Additional info:
Man1 pages shipped in the papi-devel RPM:
----------
/usr/share/man/man1/avail.c.1.gz
/usr/share/man/man1/clockres.c.1.gz
/usr/share/man/man1/command_flags_t.1.gz
/usr/share/man/man1/command_line.c.1.gz
/usr/share/man/man1/component.c.1.gz
/usr/share/man/man1/cost.c.1.gz
/usr/share/man/man1/decode.c.1.gz
/usr/share/man/man1/error_codes.c.1.gz
/usr/share/man/man1/event_chooser.c.1.gz
/usr/share/man/man1/mem_info.c.1.gz
/usr/share/man/man1/native_avail.c.1.gz
/usr/share/man/man1/options_t.1.gz
/usr/share/man/man1/papi_avail.1.gz
/usr/share/man/man1/papi_clockres.1.gz
/usr/share/man/man1/papi_command_line.1.gz
/usr/share/man/man1/papi_component_avail.1.gz
/usr/share/man/man1/papi_cost.1.gz
/usr/share/man/man1/papi_decode.1.gz
/usr/share/man/man1/papi_error_codes.1.gz
/usr/share/man/man1/papi_event_chooser.1.gz
/usr/share/man/man1/papi_mem_info.1.gz
/usr/share/man/man1/papi_multiplex_cost.1.gz
/usr/share/man/man1/papi_native_avail.1.gz
----------

Comment 1 William Cohen 2011-10-31 15:48:25 UTC

Modified the spec file to include man1 pages with main papi rpm. Resulting build in:

http://koji.fedoraproject.org/koji/rpminfo?rpmID=2771535

Comment 2 Jose Pedro Oliveira 2011-11-02 10:32:44 UTC

Post 4.2.0 commit with a log message regarding the *.c.1 man pages:
http://lists.eecs.utk.edu/pipermail/perfapi-devel/2011-October/004965.html

<quote>
Log Message:
Remove the @file directive from the doxygen comment blocks for the utilities. 
This cleans up the generated man pages. ( we nolonger build *.c.1 )
</quote>

Comment 3 William Cohen 2011-11-02 15:40:36 UTC

The *.c.1 files are pregenerated and already in papi cvs. Looks like need to clean things up after the fact. Fixed spec file to remove the man1/*.c.1.gz pages. This has been built into papi-devel-4.2.0-3.fc17.