Defect report from : Alexander van Heukelum , n/a
(Please direct followup comments direct to yyyyyyyyyyyyyy@xxxxxxxxxxxxx)
@ page 0 line 0 section 0 editorial {0}
Problem:
Edition of Specification (Year): 2003
Defect code : 1. Error
Clarification:
--------------
http://www.opengroup.org/onlinepubs/007904975/basedefs/sys/mman.h.html
(1a) The description section of sys/mman.h starts with a list of
options that make support of this header file necessary. In this
list, the [TYM] option is listed twice. One of the list items
should be removed.
http://www.opengroup.org/onlinepubs/007904975/basedefs/sys/mman.h.html
(1b) The list of function prototypes of sys/mman.h includes the
functions `mlock' and `munlock', which depend on the option
[MR]. However, in the description section [MR] is not named in
the list of options that make support of this header file
necessary. The list item "o [MR] |X> Range Memory Locking <X|"
should be appended.
http://www.opengroup.org/onlinepubs/007904975/basedefs/sys/mman.h.html
(1c) The synopsis of the header file does not make it
immediately clear that it is possible that the header file is
absent. Other headers with this property are shaded and marked
with option-markers. I propose that the synopsis is changed to
[MC4] |X> #include <sys/mman.h> <X| and shaded, where [MC4] is a
new short-hand notation for [MF|SHM|ML|MPR|TYM|SIO|ADV] (or
[MF|SHM|ML|MPR|TYM|SIO|ADV|MR], if (1b) is accepted).
More clarification:
-------------------
http://www.opengroup.org/onlinepubs/007904975/basedefs/signal.h.html
(2a) The header of the list of function prototypes is usually:
"The following shall be declared as functions and may also be
defined as macros. Function prototypes shall be provided." The
last sentence is omitted in the description of limits.h. I
believe this is unintentional and the sentence should be added.
http://www.opengroup.org/onlinepubs/007904975/basedefs/sys/utsname.h.html
(2b) The header of the list of function prototypes is usually
(if only one fuction is described): "The following shall be
declared as a function and may also be defined as a macro. A
function prototype shall be provided." The last sentence is
omitted in the description of sys/utsname.h. I believe this is
unintentional and the sentence should be added.
Typo's:
-------
http://www.opengroup.org/onlinepubs/007904975/basedefs/stdio.h.html
(3a) The function prototype of the function `vsnprintf' misses a
closing bracket. A closing bracket should be added just before
the semicolon.
http://www.opengroup.org/onlinepubs/007904975/basedefs/sched.h.html
(3b) The text contains two consecutive option-end markers (<X|),
just after the list of function prototypes. Only one closes an
option-start marker, the other is superfluous. One option-end
marker should be removed.
Pretty printing:
----------------
http://www.opengroup.org/onlinepubs/007904975/basedefs/glob.h.html :
(4a) In the list of funtion prototypes, a space is printed in
between the function name `globfree' and the following opening
bracket. The space should be removed.
http://www.opengroup.org/onlinepubs/007904975/basedefs/locale.h.html :
(4b) In the list of function prototypes, a space is printed in
between the function name `localeconv' and the following opening
bracket. The space should be removed.
Help file
---------
http://www.opengroup.org/onlinepubs/007904975/help/codes.html :
(5a) In the section "Codes" of the help file (at least in the
on-line version), an inconsistancy exists between the paragraphs
describing the short-hand notations [MC1] and [MC2], and the
short-hand notation [MC3]. The paragraphs [MC1] and [MC2] end
with "Refer to _Margin_Code_Notation_", followed by "See help on
_Margin_Code_Notation_.", while [MC3] has only the line "Refer
to _Margin_Code_Notation_". Either add the line "See help on
_Margin_Code_Notation_." to the paragraph of [MC3], or remove it
from the paragraphs of [MC1] and [MC2].
http://www.opengroup.org/onlinepubs/007904975/help/codes.html :
(5b) If (1c) is accepted, this necessitates the addition of a
description of the [MC4] short-hand notation in the section
"Codes", and in the section "A Feature Dependent on More than
Two Options".
Action:
(1a)-(5a) see problem descriptions.
(5b) Assuming (1A), (1b) and (1c) are also accepted, the following
paragraph should be added to the section "Codes" in the help
file, after the paragraph describing [MC3]:
---start---
[MC4] |X> Memory Mapped Files, Shared Memory Objects, Process
Memory Locking, Memory Protection, Typed Memory Objects,
Synchronized Input and Output, Advisory Information, or Range
Memory Locking <X|
The functionality described is optional. The functionality
described is also an extension to the ISO C standard.
This is a shorthand notation for combinations of multiple option
codes.
Where applicable, functions are marked with the MC4 margin
legend in the SYNOPSIS section. Where additional semantics apply
to a function, the material is identified by use of the MC4
margin legend.
Refer to _Margin_Code_Notation_.
/See help on/ _Margin_Code_Notation_.
---end---
and the following paragraph should be added to the section "A
Feature Dependent on More than Two Options", in the help file,
after the paragraph describing [MC3]:
---start---
[MC4] |X> The MC4 margin code is shorthand for
MF|SHM|ML|MPR|TYM|SIO|ADV|MR. Features which are shaded with
this margin code require support of either the Memory Mapped
Files, Shared Memory Objects, Process
Memory Locking, Memory Protection, Typed Memory Objects,
Synchronized Input and Output, Advisory Information, or Range
Memory Locking options. <X|
---end---
|