head	1.5;
access;
symbols
	pkgsrc-2013Q2:1.5.0.30
	pkgsrc-2013Q2-base:1.5
	pkgsrc-2012Q4:1.5.0.28
	pkgsrc-2012Q4-base:1.5
	pkgsrc-2011Q4:1.5.0.26
	pkgsrc-2011Q4-base:1.5
	pkgsrc-2011Q2:1.5.0.24
	pkgsrc-2011Q2-base:1.5
	pkgsrc-2009Q4:1.5.0.22
	pkgsrc-2009Q4-base:1.5
	pkgsrc-2008Q4:1.5.0.20
	pkgsrc-2008Q4-base:1.5
	pkgsrc-2008Q3:1.5.0.18
	pkgsrc-2008Q3-base:1.5
	cube-native-xorg:1.5.0.16
	cube-native-xorg-base:1.5
	pkgsrc-2008Q2:1.5.0.14
	pkgsrc-2008Q2-base:1.5
	pkgsrc-2008Q1:1.5.0.12
	pkgsrc-2008Q1-base:1.5
	pkgsrc-2007Q4:1.5.0.10
	pkgsrc-2007Q4-base:1.5
	pkgsrc-2007Q3:1.5.0.8
	pkgsrc-2007Q3-base:1.5
	pkgsrc-2007Q2:1.5.0.6
	pkgsrc-2007Q2-base:1.5
	pkgsrc-2007Q1:1.5.0.4
	pkgsrc-2007Q1-base:1.5
	pkgsrc-2006Q4:1.5.0.2
	pkgsrc-2006Q4-base:1.5
	pkgsrc-base:1.1.1.1
	TNF:1.1.1;
locks; strict;
comment	@# @;


1.5
date	2006.11.05.09.09.20;	author rillig;	state dead;
branches;
next	1.4;

1.4
date	2006.11.05.07.24.33;	author rillig;	state Exp;
branches;
next	1.3;

1.3
date	2006.10.25.21.33.59;	author rillig;	state Exp;
branches;
next	1.2;

1.2
date	2006.10.06.21.44.30;	author rillig;	state Exp;
branches;
next	1.1;

1.1
date	2006.10.06.21.10.41;	author rillig;	state Exp;
branches
	1.1.1.1;
next	;

1.1.1.1
date	2006.10.06.21.10.41;	author rillig;	state Exp;
branches;
next	;


desc
@@


1.5
log
@Removed the pkgsrc portability book, as editing DocBook XML is no fun at
all. The contents has been moved to the NetBSD wiki at:

    http://wiki.aydogan.net/index.php/The_pkgsrc_portability_guide
@
text
@<!-- $NetBSD: functions.xml,v 1.4 2006/11/05 07:24:33 rillig Exp $ -->

<chapter id="functions">
<title>C/C++: functions</title>

<para>This chapter contains the requirements for using certain functions
in C and C++ code.</para>

<sect1 id="feature">
<title>Feature test macros</title>

<para>When writing code that conforms to a specific standard, some
programmers may want to check that really only features from that
standard are used. For that purpose there exist a number of so-called
feature test macros that can be defined on the command line to the
compiler or in C and C++ source files before including any of the
standard include files.</para>

<table>
<title>Documentation of the feature test macros</title>
<tgroup cols="2">
<thead>
<row><entry>Platform</entry><entry>Location</entry></row>
</thead>
<tbody>
<row><entry>SunOS-*-*</entry><entry><literal>standards(5)</literal></entry></row>
<row><entry>NetBSD-*-*</entry><entry><filename>/usr/include/sys/featuretest.h</filename></entry></row>
<row><entry>Linux-*-*</entry><entry><filename>/usr/include/features.h</filename></entry></row>
</tbody>
</tgroup>
</table>

</sect1>

<sect1 id="functions.byname">
<title>Functions on various platforms</title>

<sect2 id="functions.asprintf">
<title>asprintf</title>

<para>Solaris 10 does not have this function. But it has
<literal>snprintf</literal>, which can be used as a good replacement.</para>

</sect2>

<sect2 id="functions.getopt">
<title>getopt</title>

<para>Solaris provides the <function>getopt</function> function in three
of the standard headers: &lt;stdio.h&gt;, &lt;stdlib.h&gt; and
&lt;unistd.h&gt;, but the latter definition depends on other feature
test macros than the first two. Additionally, since Solaris 5.10, there
is also &lt;getopt.h&gt;, which provides
<function>getopt_long</function>, but not <function>getopt</function>.
The exact behavior also depends on the compiler. While SUNpro is quite
strict and requires the feature test macros, gcc finds the definition
without any of these macros. (TODO: Investigate further.)</para>

<informaltable>
<tgroup cols="4">
<thead><row>
  <entry>Platform</entry>
  <entry>Library</entry>
  <entry>Headers</entry>
  <entry>Feature test macros</entry>
</row></thead>

<tbody>
<row>
  <entry>NetBSD-*-*</entry>
  <entry>c</entry>
  <entry>unistd.h</entry>
  <entry>_POSIX_C_SOURCE >= 2 || _XOPEN_SOURCE >= 4 || defined(_NETBSD_SOURCE)</entry>
</row>
<row>
  <entry>SunOS-5.10-*</entry>
  <entry>c</entry>
  <entry>unistd.h</entry>
  <entry>(_XOPEN_SOURCE && _XOPEN_VERSION == 4) || __EXTENSIONS__</entry>
</row>
</tbody>
</tgroup>
</informaltable>

</sect2>

<sect2 id="functions.nanosleep">
<title>nanosleep</title>

<para>On Solaris, the <literal>rt</literal> library is needed.</para>
</sect2>

</sect1>
</chapter>
@


1.4
log
@+ asprintf
@
text
@d1 1
a1 1
<!-- $NetBSD: functions.xml,v 1.3 2006/10/25 21:33:59 rillig Exp $ -->
@


1.3
log
@+ nanosleep
@
text
@d1 1
a1 1
<!-- $NetBSD: functions.xml,v 1.2 2006/10/06 21:44:30 rillig Exp $ -->
d38 8
@


1.2
log
@Added an introduction to feature test macros and tried to describe the
conditions under which getopt(3) is declared properly on Solaris, but
that's not easy.
@
text
@d1 1
a1 1
<!-- $NetBSD: functions.xml,v 1.1.1.1 2006/10/06 21:10:41 rillig Exp $ -->
d78 7
@


1.1
log
@Initial revision
@
text
@d1 1
a1 1
<!-- $NetBSD$ -->
d9 10
d20 16
d37 16
a52 1
<tgroup cols="5">
a53 1
  <entry>Function name</entry>
a61 1
  <entry>getopt</entry>
a67 1
  <entry>getopt</entry>
d75 1
a75 1
</table>
d77 2
@


1.1.1.1
log
@Imported portability-book.

The pkgsrc portability book covers many of the platform-specific issues
that are useful when writing programs that are portable to a great
number of UNIX-like operating systems.
@
text
@@