From: Simon Josefsson <simon@josefsson.org>
Date: Tue, 8 Dec 2009 16:44:19 +0000 (+0100)
Subject: Document pty.h functions.
X-Git-Tag: v0.1~5084
X-Git-Url: http://erislabs.org.uk/gitweb/?a=commitdiff_plain;h=20378b72d283e0ad87da78a24976a64faeb3b9ae;p=gnulib.git

Document pty.h functions.
---

diff --git a/ChangeLog b/ChangeLog
index 24d7e2018..1ae4d6363 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2009-12-08  Simon Josefsson  <simon@josefsson.org>
+
+	* doc/gnulib.texi (Glibc pty.h): Add.
+	* doc/glibc-functions/forkpty.texi: Add.
+	* doc/glibc-functions/openpty.texi: Add.
+	Suggested by Bruno Haible.
+
 2009-12-08  Eric Blake  <ebb9@byu.net>
 
 	fchdir: fix logic bugs
diff --git a/doc/glibc-functions/forkpty.texi b/doc/glibc-functions/forkpty.texi
new file mode 100644
index 000000000..2ea9b2287
--- /dev/null
+++ b/doc/glibc-functions/forkpty.texi
@@ -0,0 +1,23 @@
+@node forkpty
+@subsection @code{forkpty}
+@findex forkpty
+
+Gnulib module: ---
+
+Portability problems fixed by Gnulib:
+@itemize
+@end itemize
+
+Portability problems not fixed by Gnulib:
+@itemize
+@item
+One some systems (at least including Cygwin, Interix, OSF/1 4 and 5,
+and Mac OS X) linking with @code{-lutil} is not required.
+@item
+On glibc, OpenBSD, NetBSD and FreeBSD linking with @code{-lutil} is
+required.
+@item
+The function is declared in pty.h on Cygwin, Interix, OSF/1 4 and 5,
+and glibc.  It is declared in util.h on Mac OS X, OpenBSD and NetBSD.
+It is declared in libutil.h on FreeBSD.
+@end itemize
diff --git a/doc/glibc-functions/openpty.texi b/doc/glibc-functions/openpty.texi
new file mode 100644
index 000000000..79b6b33bc
--- /dev/null
+++ b/doc/glibc-functions/openpty.texi
@@ -0,0 +1,23 @@
+@node openpty
+@subsection @code{openpty}
+@findex openpty
+
+Gnulib module: ---
+
+Portability problems fixed by Gnulib:
+@itemize
+@end itemize
+
+Portability problems not fixed by Gnulib:
+@itemize
+@item
+One some systems (at least including Cygwin, Interix, OSF/1 4 and 5,
+and Mac OS X) linking with @code{-lutil} is not required.
+@item
+On glibc, OpenBSD, NetBSD and FreeBSD linking with @code{-lutil} is
+required.
+@item
+The function is declared in pty.h on Cygwin, Interix, OSF/1 4 and 5,
+and glibc.  It is declared in util.h on Mac OS X, OpenBSD and NetBSD.
+It is declared in libutil.h on FreeBSD.
+@end itemize
diff --git a/doc/gnulib.texi b/doc/gnulib.texi
index 3efbcb02a..a2f41fb8a 100644
--- a/doc/gnulib.texi
+++ b/doc/gnulib.texi
@@ -3265,6 +3265,7 @@ This list of functions is sorted according to the header that declares them.
 * Glibc obstack.h::
 * Glibc printf.h::
 * Glibc pthread.h::
+* Glibc pty.h::
 * Glibc pwd.h::
 * Glibc regex.h::
 * Glibc regexp.h::
@@ -4171,8 +4172,16 @@ This list of functions is sorted according to the header that declares them.
 @include glibc-functions/pthread_rwlockattr_setkind_np.texi
 @include glibc-functions/pthread_yield.texi
 
-@c @node Glibc pty.h
-@c @section Glibc @code{<pty.h>}
+@node Glibc pty.h
+@section Glibc @code{<pty.h>}
+
+@menu
+* forkpty::
+* openpty::
+@end menu
+
+@include glibc-functions/forkpty.texi
+@include glibc-functions/openpty.texi
 
 @node Glibc pwd.h
 @section Glibc Extensions to @code{<pwd.h>}