[Bug manual/17010] New: posix_openpt not documented

[Bug manual/17010] New: posix_openpt not documented

[GavinSmith0123 at gmail dot com]

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

            Bug ID: 17010
           Summary: posix_openpt not documented
           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 no documentation of the posix_openpt function in the "Allocating
Pseudo-Terminals" section of the manual. (It is documented in the Linux
manpages.) It's not in the released manual for glibc 2.19 and not in the
manual/terminal.texi file in the current git repository.

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

[Bug manual/17010] posix_openpt not documented

[fweimer at redhat dot com]

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

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/17010] posix_openpt not documented

[GavinSmith0123 at gmail dot com]

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

--- Comment #1 from Gavin Smith <GavinSmith0123 at gmail dot com> ---
This function has still not been documented. It means that the libc manual is
not the document that people should be looking at if they want to use
pseudo-terminals. The Linux manpages project seems to be more comprehensive in
this area.

The manual only documents getpt which is glibc-specific, as stated in the Linux
manpages:

       getpt() is glibc-specific; use posix_openpt(3) instead.

The maintainers of the GNU compatibility library gnulib said that there was no
need for them to support getpt when this bug was first reported:

https://lists.gnu.org/archive/html/bug-gnulib/2014-06/msg00030.html

It would make sense to have a consistent treatment of getpt across glibc and
gnulib as a function that should not be used in new programs, which means
documenting posix_openpt properly. I am willing to write and send a patch for
this if there is any chance of it being used.

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

[Bug manual/17010] posix_openpt not documented

[adhemerval.zanella at linaro dot org]

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

Adhemerval Zanella <adhemerval.zanella at linaro dot org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |adhemerval.zanella at linaro dot o
                   |                            |rg

--- Comment #2 from Adhemerval Zanella <adhemerval.zanella at linaro dot org> ---
(In reply to Gavin Smith from comment #1)
> I am willing to write and send a patch
> for this if there is any chance of it being used.

Thanks, this would be a good approach. Please check the contribution checklist
[1].

[1] https://sourceware.org/glibc/wiki/Contribution%20checklist

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

[Bug manual/17010] posix_openpt not documented

[sam at gentoo dot org]

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

Sam James <sam at gentoo dot org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |sam at gentoo dot org

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

[Bug manual/17010] posix_openpt not documented

[GavinSmith0123 at gmail dot com]

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

--- Comment #3 from Gavin Smith <GavinSmith0123 at gmail dot com> ---
Sent here: https://sourceware.org/bugzilla/show_bug.cgi?id=17010

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

[Bug manual/17010] posix_openpt not documented

[GavinSmith0123 at gmail dot com]

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

--- Comment #4 from Gavin Smith <GavinSmith0123 at gmail dot com> ---
Sent here: https://sourceware.org/pipermail/libc-alpha/2023-April/147191.html

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