changeset 12403:085e83b725e1

Document pty.h functions.
author Simon Josefsson <simon@josefsson.org>
date Tue, 08 Dec 2009 17:44:19 +0100
parents af3596b94c7a
children 44954971957b
files ChangeLog doc/glibc-functions/forkpty.texi doc/glibc-functions/openpty.texi doc/gnulib.texi
diffstat 4 files changed, 64 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- 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
new file mode 100644
--- /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
new file mode 100644
--- /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
--- a/doc/gnulib.texi
+++ b/doc/gnulib.texi
@@ -3265,6 +3265,7 @@
 * 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 @@
 @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>}