aboutsummaryrefslogtreecommitdiffstats
path: root/docs/syscall_descriptions.md
diff options
context:
space:
mode:
authorDmitry Vyukov <dvyukov@google.com>2022-01-11 20:09:20 +0100
committerAleksandr Nogikh <wp32pw@gmail.com>2022-01-13 17:03:25 +0100
commit4b0229115958fea4fb48302ee17980f6a0bb859d (patch)
tree6eb9be268b3d7da3b94750a8f85e92b662f0dddd /docs/syscall_descriptions.md
parent24c8419d0db44a0dec71116360d40bd9c82e92b3 (diff)
tools/syz-check: use $ as struct variant suffix delimiter
We already use this $ convention for syscall variant names. Use the same convention for struct. Currently syz-check supports '_' for structs, but it's inconsistent with syscalls and leads to ambiguity. If we enable the same matching for all structs (not just netlink), then '_' creates lots of false matches. E.g. bpf_link_get_next_id_args is matches with internal bpf_link struct.
Diffstat (limited to 'docs/syscall_descriptions.md')
-rw-r--r--docs/syscall_descriptions.md5
1 files changed, 1 insertions, 4 deletions
diff --git a/docs/syscall_descriptions.md b/docs/syscall_descriptions.md
index fa45099d5..e9bf2195b 100644
--- a/docs/syscall_descriptions.md
+++ b/docs/syscall_descriptions.md
@@ -145,12 +145,9 @@ with [syz-check](/tools/syz-check/check.go).
For example, if there is an existing enum `v4l2_buf_type` in the kernel headers,
use this name for flags in descriptions as well. The same for structs, unions,
-fields, etc. For syscall variants, use the command name after the `$` sign.
+fields, etc. For syscall and struct variants, append the variant name after the `$` sign.
For example, `fcntl$F_GET_RW_HINT`, `ioctl$FIOCLEX`, `setsockopt$SO_TIMESTAMP`.
-If you need to describe several variants of the same kernel struct, the naming
-convention understood by `syz-check` is `<ORIGINAL_KERNEL_NAME>_some_suffix`.
-
<div id="ordering"/>
### Resources for syscall ordering