[Bug manual/17011] New: Example in "Allocating Pseudo-Terminals" section uses isastream

[Bug manual/17011] New: Example in "Allocating Pseudo-Terminals" section uses isastream

[GavinSmith0123 at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=17011

            Bug ID: 17011
           Summary: Example in "Allocating Pseudo-Terminals" section uses
                    isastream
           Product: glibc
           Version: unspecified
            Status: NEW
          Severity: normal
          Priority: P2
         Component: manual
          Assignee: unassigned at sourceware dot org
          Reporter: GavinSmith0123 at gmail dot com
                CC: mtk.manpages at gmail dot com, roland at gnu dot org

There is an example function showing use of the functions for opening a
pseudo-terminal pair in the "Allocating Pseudo-Terminals" section of the
manual. There is a conditional block using the "isastream" function which calls
extra ioctls on the slave file descriptor.

However, when I tried to use this example, I got error messages that there was
no function isastream, and there is no mention of isastream anywhere else in
the manual.

I assume it is related to the comment above the code about a file being
"STREAMS-based" on System V-derived systems (based on the common use of the
word "stream"), but there's no explanation of what this means or any references
to an explanation. If this is the case, I would suggest placing a comment in
the example function above the condition which said something like "Only do
this on a System V system".

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/17011] Example in "Allocating Pseudo-Terminals" section uses isastream

[schwab@linux-m68k.org]

https://sourceware.org/bugzilla/show_bug.cgi?id=17011

--- Comment #1 from Andreas Schwab <schwab@linux-m68k.org> ---
isastream is declared in <stropts.h>.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/17011] Example in "Allocating Pseudo-Terminals" section uses isastream

[mtk.manpages at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=17011

--- Comment #2 from Michael Kerrisk <mtk.manpages at gmail dot com> ---
(In reply to Andreas Schwab from comment #1)
> isastream is declared in <stropts.h>.

But that misses the point. The isastream() implementation is a placeholder that
does nothing much useful. The example code really shouldn't be using
isastream(); that piece of the code is System-Vish, and rather irrelevant these
days.

There are other pieces of that section of the glibc manual that are also rather
crufty. For example, no-one should use the GNU getpt() these days. Use
posix_openpt() instead.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/17011] Example in "Allocating Pseudo-Terminals" section uses isastream

[schwab@linux-m68k.org]

https://sourceware.org/bugzilla/show_bug.cgi?id=17011

--- Comment #3 from Andreas Schwab <schwab@linux-m68k.org> ---
isastream exists, so it should be used where applicable.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/17011] Example in "Allocating Pseudo-Terminals" section uses isastream

[mtk.manpages at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=17011

--- Comment #4 from Michael Kerrisk <mtk.manpages at gmail dot com> ---
(In reply to Andreas Schwab from comment #3)
> isastream exists, so it should be used where applicable.

But on which GNU systems is it applicable? Does HURD implement streams? (I
imagine not.)

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/17011] Example in "Allocating Pseudo-Terminals" section uses isastream

[fweimer at redhat dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=17011

Florian Weimer <fweimer at redhat dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
              Flags|                            |security-

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/17011] Example in "Allocating Pseudo-Terminals" section uses isastream

[GavinSmith0123 at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=17011

--- Comment #6 from Gavin Smith <GavinSmith0123 at gmail dot com> ---
On 2 June 2014 at 15:21, mtk.manpages at gmail dot com
<sourceware-bugzilla@sourceware.org> wrote:
> But on which GNU systems is it applicable? Does HURD implement streams? (I
> imagine not.)

I found that the code was needed on Solaris 10, otherwise isatty would
say that the pseudoterminal slave device wasn't a terminal. All that's
needed, I think, is to say that <stropts.h> needs to be included.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/17011] Example in "Allocating Pseudo-Terminals" section uses isastream

[GavinSmith0123 at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=17011

--- Comment #7 from Gavin Smith <GavinSmith0123 at gmail dot com> ---
The version of the manual in glibc 2.37 doesn't mention isastream in this
section any more so this bug could be closed.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/17011] Example in "Allocating Pseudo-Terminals" section uses isastream

[GavinSmith0123 at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=17011

Gavin Smith <GavinSmith0123 at gmail dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|---                         |FIXED

--- Comment #8 from Gavin Smith <GavinSmith0123 at gmail dot com> ---
(mark as fixed)

-- 
You are receiving this mail because:
You are on the CC list for the bug.