Bug 200933 – ~sci-libs/primegen-0.97 - bad man page for primegen(3)

• Status: RESOLVED UPSTREAM
• Product: Gentoo Linux

[Description d. paddy 2007-12-01 17:05:08 UTC]

man primegen reports an incorrect type for "pg" 

Reproducible: Always

Steps to Reproduce:
1. add "~sci-libs/primegen-0.97            ~*" to /etc/portage/package.keywords
2. emerge primegen 
3. man primegen

Actual Results:  
primegen(3)                                                       primegen(3)



NAME
       primegen - enumerate small primes

SYNTAX
       #include <primegen.h>

       void primegen_init(&pg);
       uint64 primegen_next(&pg);
       uint64 primegen_peek(&pg);
       uint64 primegen_count(&pg,bound);
       void primegen_skipto(&pg,bound);

       struct primegen pg;
.
.
.


Expected Results:  
primegen(3)                                                       primegen(3)



NAME
       primegen - enumerate small primes

SYNTAX
       #include <primegen.h>

       void primegen_init(&pg);
       uint64 primegen_next(&pg);
       uint64 primegen_peek(&pg);
       uint64 primegen_count(&pg,bound);
       void primegen_skipto(&pg,bound);

       primegen pg;
.
.
.


Since the header file primegen.h defines primegen in a typedef, the
type specified in the man file should be 

primegen pg;

Moreover, using the type given in the man page results in code that will not compile.

[Comment 1 Jakub Moc (RETIRED) 2007-12-01 22:31:48 UTC]

Try your luck upstream...