bug-gnulib
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: pty.h replacement


From: Simon Josefsson
Subject: Re: pty.h replacement
Date: Tue, 08 Dec 2009 17:49:29 +0100
User-agent: Gnus/5.110011 (No Gnus v0.11) Emacs/23.1 (gnu/linux)

Thanks for review Bruno.  It seems the issue is more complicated, which
I kind of guessed.

Bruno Haible <address@hidden> writes:

> Actually, since openpty and forkpty are glibc function, therefore two files
>   doc/glibc-functions/openpty.texi
>   doc/glibc-functions/forkpty.texi
> should be created. They escaped me when I created the hundreds of *.texi 
> files.

That is something we can easily start on, though.  I have pushed the
starting pointer below.

I'll continue work on proposing a better 'pty' module.  Is there any
reason to add separate openpty or forkpty modules?  I don't see any
reason, unless the openpty/forkpty becomes really large/complex so that
if one needs one function one shouldn't need to also pull in the other.

My goal now is to only address the problem with header file and library
-- implementing openpty/forkpty on platforms that doesn't have them is
too time consuming for me.  Of course, if someone else wants to work on
the additional step, it would be great.  I think things will be simpler
if we start with just handling the header/library issue though.

/Simon

>From 20378b72d283e0ad87da78a24976a64faeb3b9ae Mon Sep 17 00:00:00 2001
From: Simon Josefsson <address@hidden>
Date: Tue, 8 Dec 2009 17:44:19 +0100
Subject: [PATCH] Document pty.h functions.

---
 ChangeLog                        |    7 +++++++
 doc/glibc-functions/forkpty.texi |   23 +++++++++++++++++++++++
 doc/glibc-functions/openpty.texi |   23 +++++++++++++++++++++++
 doc/gnulib.texi                  |   13 +++++++++++--
 4 files changed, 64 insertions(+), 2 deletions(-)
 create mode 100644 doc/glibc-functions/forkpty.texi
 create mode 100644 doc/glibc-functions/openpty.texi

diff --git a/ChangeLog b/ChangeLog
index 24d7e20..1ae4d63 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2009-12-08  Simon Josefsson  <address@hidden>
+
+       * 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  <address@hidden>
 
        fchdir: fix logic bugs
diff --git a/doc/glibc-functions/forkpty.texi b/doc/glibc-functions/forkpty.texi
new file mode 100644
index 0000000..2ea9b22
--- /dev/null
+++ b/doc/glibc-functions/forkpty.texi
@@ -0,0 +1,23 @@
address@hidden forkpty
address@hidden @code{forkpty}
address@hidden forkpty
+
+Gnulib module: ---
+
+Portability problems fixed by Gnulib:
address@hidden
address@hidden itemize
+
+Portability problems not fixed by Gnulib:
address@hidden
address@hidden
+One some systems (at least including Cygwin, Interix, OSF/1 4 and 5,
+and Mac OS X) linking with @code{-lutil} is not required.
address@hidden
+On glibc, OpenBSD, NetBSD and FreeBSD linking with @code{-lutil} is
+required.
address@hidden
+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.
address@hidden itemize
diff --git a/doc/glibc-functions/openpty.texi b/doc/glibc-functions/openpty.texi
new file mode 100644
index 0000000..79b6b33
--- /dev/null
+++ b/doc/glibc-functions/openpty.texi
@@ -0,0 +1,23 @@
address@hidden openpty
address@hidden @code{openpty}
address@hidden openpty
+
+Gnulib module: ---
+
+Portability problems fixed by Gnulib:
address@hidden
address@hidden itemize
+
+Portability problems not fixed by Gnulib:
address@hidden
address@hidden
+One some systems (at least including Cygwin, Interix, OSF/1 4 and 5,
+and Mac OS X) linking with @code{-lutil} is not required.
address@hidden
+On glibc, OpenBSD, NetBSD and FreeBSD linking with @code{-lutil} is
+required.
address@hidden
+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.
address@hidden itemize
diff --git a/doc/gnulib.texi b/doc/gnulib.texi
index 3efbcb0..a2f41fb 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
 
address@hidden @node Glibc pty.h
address@hidden @section Glibc @code{<pty.h>}
address@hidden Glibc pty.h
address@hidden Glibc @code{<pty.h>}
+
address@hidden
+* forkpty::
+* openpty::
address@hidden menu
+
address@hidden glibc-functions/forkpty.texi
address@hidden glibc-functions/openpty.texi
 
 @node Glibc pwd.h
 @section Glibc Extensions to @code{<pwd.h>}
-- 
1.6.5.3





reply via email to

[Prev in Thread] Current Thread [Next in Thread]