[v6,1/6] manual: Update to mention ENODEV for ttyname and ttyname_r

Message ID 20171110200827.32265-2-lukeshu@lukeshu.com
State New
Headers show
Series
  • Fixup linux ttyname and ttyname_r [BZ #22145]
Related show

Commit Message

Luke Shumaker Nov. 10, 2017, 8:08 p.m.
From: Luke Shumaker <lukeshu@parabola.nu>

Commit 15e9a4f378c8607c2ae1aa465436af4321db0e23 introduced ENODEV as a
possible error condition for ttyname and ttyname_r.  Update the manual
to mention this GNU extension.

v2:
 - Fix typo: psuedo->pseudo
 - Improve wording
 - Fix ChangeLog item name
v3:
 - Revise commit message
---
 ChangeLog            | 5 +++++
 manual/terminal.texi | 5 +++++
 2 files changed, 10 insertions(+)

Comments

Christian Brauner Nov. 11, 2017, 10:56 p.m. | #1
On Fri, Nov 10, 2017 at 03:08:22PM -0500, Luke Shumaker wrote:
> From: Luke Shumaker <lukeshu@parabola.nu>
> 
> Commit 15e9a4f378c8607c2ae1aa465436af4321db0e23 introduced ENODEV as a
> possible error condition for ttyname and ttyname_r.  Update the manual
> to mention this GNU extension.
> 
> v2:
>  - Fix typo: psuedo->pseudo
>  - Improve wording
>  - Fix ChangeLog item name
> v3:
>  - Revise commit message
> ---
>  ChangeLog            | 5 +++++
>  manual/terminal.texi | 5 +++++
>  2 files changed, 10 insertions(+)

Reviewed-by: Christian Brauner <christian.brauner@ubuntu.com>

> 
> diff --git a/ChangeLog b/ChangeLog
> index bc8c473f09..dc4094bdc3 100644
> --- a/ChangeLog
> +++ b/ChangeLog
> @@ -1,3 +1,8 @@
> +2017-11-07  Luke Shumaker  <lukeshu@parabola.nu>
> +
> +	* manual/terminal.texi (Is It a Terminal):
> +	Mention ENODEV for ttyname and ttyname_r.
> +
>  2017-11-07  Joseph Myers  <joseph@codesourcery.com>
>  
>  	* include/float.h
> diff --git a/manual/terminal.texi b/manual/terminal.texi
> index 4fef5045b8..4aace48b14 100644
> --- a/manual/terminal.texi
> +++ b/manual/terminal.texi
> @@ -109,6 +109,11 @@ The @var{filedes} is not associated with a terminal.
>  @item ERANGE
>  The buffer length @var{len} is too small to store the string to be
>  returned.
> +
> +@item ENODEV
> +The @var{filedes} is associated with a terminal device that is a slave
> +pseudo-terminal, but the file name associated with that device could
> +not be determined.  This is a GNU extension.
>  @end table
>  @end deftypefun
>  
> -- 
> 2.15.0
>

Patch

diff --git a/ChangeLog b/ChangeLog
index bc8c473f09..dc4094bdc3 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@ 
+2017-11-07  Luke Shumaker  <lukeshu@parabola.nu>
+
+	* manual/terminal.texi (Is It a Terminal):
+	Mention ENODEV for ttyname and ttyname_r.
+
 2017-11-07  Joseph Myers  <joseph@codesourcery.com>
 
 	* include/float.h
diff --git a/manual/terminal.texi b/manual/terminal.texi
index 4fef5045b8..4aace48b14 100644
--- a/manual/terminal.texi
+++ b/manual/terminal.texi
@@ -109,6 +109,11 @@  The @var{filedes} is not associated with a terminal.
 @item ERANGE
 The buffer length @var{len} is too small to store the string to be
 returned.
+
+@item ENODEV
+The @var{filedes} is associated with a terminal device that is a slave
+pseudo-terminal, but the file name associated with that device could
+not be determined.  This is a GNU extension.
 @end table
 @end deftypefun