[src/trunk]: src/lib/libc/sys ptrace(2): Document addr and data argument usag...

[kamil <kamil%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/68412a24eaec
branches:  trunk
changeset: 350171:68412a24eaec
user:      kamil <kamil%NetBSD.org@localhost>
date:      Sat Jan 07 01:29:18 2017 +0000

description:
ptrace(2): Document addr and data argument usage for PT_GET_PROCESS_STATE


The PT_GET_PROCESS_STATE call in ptrace(2) has the following usage of addr
and data:

    A pointer to this structure is passed in addr.  The data
    argument should be set to sizeof(struct ptrace_event).

Sponsored by <The NetBSD Foundation>

diffstat:

 lib/libc/sys/ptrace.2 |  13 ++++++++++---
 1 files changed, 10 insertions(+), 3 deletions(-)

diffs (36 lines):

diff -r 5bb3c9b0e903 -r 68412a24eaec lib/libc/sys/ptrace.2
--- a/lib/libc/sys/ptrace.2     Sat Jan 07 01:22:12 2017 +0000
+++ b/lib/libc/sys/ptrace.2     Sat Jan 07 01:29:18 2017 +0000
@@ -1,7 +1,7 @@
-.\"    $NetBSD: ptrace.2,v 1.46 2016/12/29 22:17:51 kamil Exp $
+.\"    $NetBSD: ptrace.2,v 1.47 2017/01/07 01:29:18 kamil Exp $
 .\"
 .\" This file is in the public domain.
-.Dd November 1, 2016
+.Dd January 7, 2016
 .Dt PTRACE 2
 .Os
 .Sh NAME
@@ -309,7 +309,7 @@
 The
 .Fa data
 argument should be set to
-.Li sizeof(struct ptrace_event) .
+.Li sizeof(struct ptrace_state) .
 .It Dv PT_GET_PROCESS_STATE
 This request reads the state information associated with the event
 that stopped the traced process.
@@ -322,6 +322,13 @@
        pid_t   pe_other_pid;
 } ptrace_state_t;
 .Ed
+.Pp
+A pointer to this structure is passed in
+.Fa addr .
+The
+.Fa data
+argument should be set to
+.Li sizeof(struct ptrace_event) .
 .El
 .Pp
 Additionally, the following requests exist but are