[v6,2/6] linux ttyname: Update a reference to kernel docs for kernel 4.10

Message ID 20171110200827.32265-3-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>

Linux 4.10 moved many of the documentation files around.

4.10 came out between the time the patch adding the comment (commit
15e9a4f378c8607c2ae1aa465436af4321db0e23) was submitted and the time
it was applied (in February, January, and March 2017; respectively).

v2:
 - No change
v3:
 - Revise commit message
 - Two spaces after a period in comments
---
 ChangeLog                         | 2 ++
 sysdeps/unix/sysv/linux/ttyname.h | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)

Comments

Christian Brauner Nov. 11, 2017, 11:02 p.m. | #1
On Fri, Nov 10, 2017 at 03:08:23PM -0500, Luke Shumaker wrote:
> From: Luke Shumaker <lukeshu@parabola.nu>
> 
> Linux 4.10 moved many of the documentation files around.
> 
> 4.10 came out between the time the patch adding the comment (commit
> 15e9a4f378c8607c2ae1aa465436af4321db0e23) was submitted and the time
> it was applied (in February, January, and March 2017; respectively).
> 
> v2:
>  - No change
> v3:
>  - Revise commit message
>  - Two spaces after a period in comments
> ---
>  ChangeLog                         | 2 ++
>  sysdeps/unix/sysv/linux/ttyname.h | 3 ++-
>  2 files changed, 4 insertions(+), 1 deletion(-)

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

> 
> diff --git a/ChangeLog b/ChangeLog
> index dc4094bdc3..095baf9eb6 100644
> --- a/ChangeLog
> +++ b/ChangeLog
> @@ -1,5 +1,7 @@
>  2017-11-07  Luke Shumaker  <lukeshu@parabola.nu>
>  
> +	* sysdeps/unix/sysv/linux/ttyname.h (is_pty): Update doc reference.
> +
>  	* manual/terminal.texi (Is It a Terminal):
>  	Mention ENODEV for ttyname and ttyname_r.
>  
> diff --git a/sysdeps/unix/sysv/linux/ttyname.h b/sysdeps/unix/sysv/linux/ttyname.h
> index 2e415e4e9c..cbcdbab607 100644
> --- a/sysdeps/unix/sysv/linux/ttyname.h
> +++ b/sysdeps/unix/sysv/linux/ttyname.h
> @@ -21,7 +21,8 @@
>  #include <sys/stat.h>
>  
>  /* Return true if this is a UNIX98 pty device, as defined in
> -   linux/Documentation/devices.txt.  */
> +   linux/Documentation/devices.txt (on linux < 4.10) or
> +   linux/Documentation/admin-guide/devices.txt (on linux >= 4.10).  */
>  static inline int
>  is_pty (struct stat64 *sb)
>  {
> -- 
> 2.15.0
>

Patch

diff --git a/ChangeLog b/ChangeLog
index dc4094bdc3..095baf9eb6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@ 
 2017-11-07  Luke Shumaker  <lukeshu@parabola.nu>
 
+	* sysdeps/unix/sysv/linux/ttyname.h (is_pty): Update doc reference.
+
 	* manual/terminal.texi (Is It a Terminal):
 	Mention ENODEV for ttyname and ttyname_r.
 
diff --git a/sysdeps/unix/sysv/linux/ttyname.h b/sysdeps/unix/sysv/linux/ttyname.h
index 2e415e4e9c..cbcdbab607 100644
--- a/sysdeps/unix/sysv/linux/ttyname.h
+++ b/sysdeps/unix/sysv/linux/ttyname.h
@@ -21,7 +21,8 @@ 
 #include <sys/stat.h>
 
 /* Return true if this is a UNIX98 pty device, as defined in
-   linux/Documentation/devices.txt.  */
+   linux/Documentation/devices.txt (on linux < 4.10) or
+   linux/Documentation/admin-guide/devices.txt (on linux >= 4.10).  */
 static inline int
 is_pty (struct stat64 *sb)
 {