aboutsummaryrefslogtreecommitdiffstats
path: root/docs/syscall_descriptions_syntax.md
diff options
context:
space:
mode:
authorDmitry Vyukov <dvyukov@google.com>2020-07-09 11:42:24 +0200
committerGitHub <noreply@github.com>2020-07-09 11:42:24 +0200
commit5b6bfb32b0e8cdac3af1c7d655e2d2b281a90544 (patch)
treeda3d345e67cd402486a86e9f9e08e6e0727fe09a /docs/syscall_descriptions_syntax.md
parentff85e8be1adbb22abfa2abac57cfaf51c0d23cfe (diff)
docs: add explanation of flags type
* docs: add explanation of flags type * Apply suggestions from code review Co-authored-by: Marco Elver <marco.elver@gmail.com>
Diffstat (limited to 'docs/syscall_descriptions_syntax.md')
-rw-r--r--docs/syscall_descriptions_syntax.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/syscall_descriptions_syntax.md b/docs/syscall_descriptions_syntax.md
index 38b31caa1..7f4033079 100644
--- a/docs/syscall_descriptions_syntax.md
+++ b/docs/syscall_descriptions_syntax.md
@@ -28,7 +28,7 @@ rest of the type-options are type-specific:
"intN"/"intptr": an integer without a particular meaning, type-options:
optional range of values (e.g. "5:10", or "100:200"),
optionally followed by an alignment parameter
-"flags": a set of flags, type-options:
+"flags": a set of values, type-options:
reference to flags description (see below), underlying int type (e.g. "int32")
"array": a variable/fixed-length array, type-options:
type of elements, optional size (fixed "5", or ranged "5:10", boundaries inclusive)
@@ -351,3 +351,5 @@ that can be used as any other syscall in a description file. These pseudo
system calls expand to literal C code and can perform user-defined
custom actions. You can find some examples in
[executor/common_linux.h](../executor/common_linux.h).
+
+Also see [tips](syscall_descriptions.md#tips) on writing good descriptions.