This is the mail archive of the
systemtap@sourceware.org
mailing list for the systemtap project.
[PATCH] man: add a note about direct pointer dereferencing
- From: Ruslan Kuprieiev <rkuprieiev at cloudlinux dot com>
- To: systemtap at sourceware dot org
- Cc: Ruslan Kuprieiev <rkuprieiev at cloudlinux dot com>
- Date: Tue, 4 Apr 2017 16:06:52 +0300
- Subject: [PATCH] man: add a note about direct pointer dereferencing
- Authentication-results: sourceware.org; auth=none
It is currently not very clear how to dereference a pointer to
a basic type, so lets add two notes about it to man pages.
Signed-off-by: Ruslan Kuprieiev <rkuprieiev@cloudlinux.com>
---
man/stap.1.in | 4 +++-
man/stapprobes.3stap | 4 +++-
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/man/stap.1.in b/man/stap.1.in
index 6812391..e2a89f7 100644
--- a/man/stap.1.in
+++ b/man/stap.1.in
@@ -1724,7 +1724,9 @@ and dereference the
.I member
value. Further
.IR \->subfield
-expressions may be appended to dereference more levels.
+expressions may be appended to dereference more levels. Note that for direct
+dereferencing of a pointer {kernel,user}_{char,int,...}($p) should be used.
+(Refer to stapfuncs(5) for more details.)
.BR
NOTE:
the same dereferencing operator
diff --git a/man/stapprobes.3stap b/man/stapprobes.3stap
index ab011df..47416dd 100644
--- a/man/stapprobes.3stap
+++ b/man/stapprobes.3stap
@@ -612,7 +612,9 @@ operator is not used for plain structure
members, only
.IR \->
for both purposes. (This is because "." is reserved for string
-concatenation.)
+concatenation.) Also note that for direct dereferencing of $var
+pointer {kernel,user}_{char,int,...}($var) should be used. (Refer to
+stapfuncs(5) for more details.)
.TP
$return
is available in return probes only for functions that are declared
--
2.5.5