lsb

some function descriptions reference non-existent header

Bug #1327355 reported by Jeff Johnson
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
lsb
Fix Released
Medium
Unassigned
Mandriva
Fix Released
Medium

Bug Description

Several functions have documentation which includes this stanza:

Synopsis

#include <libc.h>

Since there is no such header in the Data Defintions, this is an error.

The functions:

__chk_fail
__fprintf_chk
__stack_chk_fail
__stpncpy_chk
__vfprintf_chk
lcong48_r

Of these, the first five are not assigned to LSB headers, while lcong48_r
appears in <stdlib.h>.

__fprintf_chk, __stpncpy_chk and __vfprintf_chk are already marked as being
only in the binary standard, so the correct solution for these is to just
remove the <funcsynopsisinfo> markup from them. For lcong48_r, it should be
corrected.

For the final two, they should also be marked as only in the binary standard as
they appear this way in the database:

INSERT INTO `Interface` VALUES
(97365,'__chk_fail','Function',0,'Yes',NULL,NULL,NULL,'BinOnly','libc',NULL,NULL,NULL,'',NULL,0,NULL,'Yes','No');
[mats@madison specdb]$ grep __stack_chk_fail Interface.init
INSERT INTO `Interface` VALUES
(97392,'__stack_chk_fail','Function',0,'Yes',NULL,NULL,NULL,'BinOnly','libc',NULL,NULL,NULL,'',NULL,0,NULL,'Yes','No');

The key is the BinOnly value to the 9th field. So in this case we should both
remove the <funcsynopsisinfo> markup and indicate by wording that these are
only in the binary standard.

Note this was discovered accidentally when looking at something else, searched
for the same pattern, there could possibly be other nonexistent headers
included, and other pages which are BinOnly not so indicated. The odds of the
first one aren't huge; the current script (mklsbmanpage) looks in the database
for the associated header. There is one old script which seems to be the
likely culprit:

mkmanpp: $outText =~ s/&lt;&gt;\n/&lt;libc.h&gt;\n/sgi;
[reply] [-] Comment 1

Tags: sdk
Changed in mandriva:
importance: Unknown → Medium
status: Unknown → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.