Skip to contentSkip to conversation

getopt.3: Fix feature test macro requirements for getopt()

PATCH In review Jonathan Nieder 2 participants 2 messages Nov 27, 2009 – Feb 3, 2010 1 message not in the archive Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 getopt.3: Fix feature test macro requirements for getopt()

The synopsis previously stated that getopt requires _POSIX_C_SOURCE >= 2 || _XOPEN_SOURCE || _POSIX_SOURCE, but that would be impossible, since _POSIX_SOURCE is a synonym for _POSIX_C_SOURCE >= 1.

getopt was introduced to POSIX in POSIX.2. The glibc headers correctly test for that version.

---
Hi,

I noticed this when trying to compile a program that uses getopt with _POSIX_SOURCE. Checking the headers, I see that unistd.h does not include getopt.h unless __USE_POSIX2 is defined, and getopt.h does not choose the standards-conforming implementation unless __USE_POSIX2 && !__USE_POSIX_IMPLICITLY && !__USE_GNU is defined.

The POSIX-1 2008 documentation [1] suggests that SVr2 had a getopt, and the FreeBSD manpage [2] says BSD 4.3 had one, too. So maybe getopt should be exposed if either _BSD_SOURCE or _SVID_SOURCE is defined. But it isn’t currently.

Anyway, I hope the patch is of some use.

Thanks,
Jonathan

[1] http://www.opengroup.org/onlinepubs/9699919799/functions/getopt.html
[2] http://svn.freebsd.org/viewvc/base/head/lib/libc/stdlib/getopt.3?view=markup

 man3/getopt.3 |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
man3/getopt.3 +1 -1
index 503f689..97ff60a 100644
@@ -68,7 +68,7 @@ Feature Test Macro Requirements for glibc (see
 .in
 .sp
 .BR getopt ():
-_POSIX_C_SOURCE\ >=\ 2 || _XOPEN_SOURCE || _POSIX_SOURCE
+_POSIX_C_SOURCE\ >=\ 2 || _XOPEN_SOURCE
 .br
 .BR getopt_long (),
 .BR getopt_long_only ():
Signature · 6 lines
1.6.5.3

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): [email protected]

#2 lore raw

Hello Jonathan,

Quoted 7 lines · Jonathan Nieder

The synopsis previously stated that getopt requires _POSIX_C_SOURCE >= 2 || _XOPEN_SOURCE || _POSIX_SOURCE, but that would be impossible, since _POSIX_SOURCE is a synonym for _POSIX_C_SOURCE >= 1.

getopt was introduced to POSIX in POSIX.2.  The glibc headers correctly test for that version.

Agreed. I applied your patch. The change will be in man-pages-3.24.

I also discovered and fixed similar errors in popen(2) and confstr(3)!

Thanks!

Cheers,

Michael

Quoted 43 lines

---
Hi,

I noticed this when trying to compile a program that uses getopt with _POSIX_SOURCE.  Checking the headers, I see that unistd.h does not include getopt.h unless __USE_POSIX2 is defined, and getopt.h does not choose the standards-conforming implementation unless __USE_POSIX2 && !__USE_POSIX_IMPLICITLY && !__USE_GNU is defined.

The POSIX-1 2008 documentation [1] suggests that SVr2 had a getopt, and the FreeBSD manpage [2] says BSD 4.3 had one, too.  So maybe getopt should be exposed if either _BSD_SOURCE or _SVID_SOURCE is defined.  But it isn’t currently.

Anyway, I hope the patch is of some use.

Thanks,
Jonathan

[1] http://www.opengroup.org/onlinepubs/9699919799/functions/getopt.html
[2] http://svn.freebsd.org/viewvc/base/head/lib/libc/stdlib/getopt.3?view=markup

 man3/getopt.3 |    2 +-

 1 files changed, 1 insertions(+), 1 deletions(-)
man3/getopt.3 +0 -0
index 503f689..97ff60a 100644
@@ -68,7 +68,7 @@ Feature Test Macro Requirements for glibc (see

 .in
 .sp
 .BR getopt ():

man3/getopt.3 +1 -1
-_POSIX_C_SOURCE\ >=\ 2 || _XOPEN_SOURCE || _POSIX_SOURCE
+_POSIX_C_SOURCE\ >=\ 2 || _XOPEN_SOURCE

 .br
 .BR getopt_long (),
 .BR getopt_long_only ():
--
1.6.5.3

Signature · 7 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface" http://blog.man7.org/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html