From 7ba13a158b1ad89a23920bb64208ba34fed27b08 Mon Sep 17 00:00:00 2001
From: Aleksandr Nogikh <nogikh@google.com>
Date: Fri, 25 Aug 2023 15:27:26 +0200
Subject: docs: rewrite the labels section

Make it clear that some labels are flags and some are lists of values.
---
 docs/syzbot.md | 53 ++++++++++++++++++-----------------------------------
 1 file changed, 18 insertions(+), 35 deletions(-)

(limited to 'docs')

diff --git a/docs/syzbot.md b/docs/syzbot.md
index bda7d641d..80da90e04 100644
--- a/docs/syzbot.md
+++ b/docs/syzbot.md
@@ -156,40 +156,20 @@ dashboard.
 It is possible to assign labels to syzkaller-reported bugs. These labels
 are displayed near bug titles on the bug lists and on individual bug pages.
 
-To assign a label, send a `#syz set` command as a reply to the bug report.
-
-```
-#syz set label: value
-```
-
-As of now, the following labels are supported.
-
-**A)** Bug priority
-
-```
-#syz set prio: low
-#syz set prio: normal
-#syz set prio: high
-
-```
-
-**B)** Exclude the bug from monthly reports.
-
-```
-#syz set no-reminders
-```
-
-**C)** Set a subsystem (see also the section above).
-
-```
-#syz set subsystems: net
-```
-
-To **remove** a label, send a `#syz unset` command:
-
-```
-#syz unset prio
-```
+There are two types of labels:
+* Flags
+  * Send `#syz set <label>` to set the flag.
+  * Send `#syz unset <label>` to drop the flag.
+* Label with values
+  * Send `#syz set <label>: <value>[, <value2> ...]`  to overwrite the value list.
+  * `#syz unset <label>` would drop the label with all its values.
+
+There's a fixed list of supported labels (*). Most important ones:
+| Key | Description | Values | Example |
+| - | - | - | - |
+| `subsystems` | A comma-separated list of subsystems of the bug | See [the list](https://syzkaller.appspot.com/upstream/subsystems) on the syzbot dashboard | `#syz set subsystems: mm, reiserfs` |
+| `prio` | The priority of the bug | One of `low`, `normal`, `high` | `#syz set prio: low`<br>`#syz unset prio` |
+| `no-reminders` | Don't include the bug into monthly reminders | No values, just a flag |  `#syz set no-reminders`<br>`#syz unset no-reminders` |
 
 It is also possible to set and unset labels for individual bugs from a monthly
 subsystem report. Let's consider an example.
@@ -204,13 +184,16 @@ Ref Crashes Repro Title
                   https://syzkaller.appspot.com/bug?id=b4278401038872458a20f08210e46f3ab519b786
 ```
 
-One can send the following email:
+One can send the following email to disable reminders for the first bug and to
+change the subsystem of the second bug:
 
 ```
 #syz set <1> no-reminders
 #syz set <2> subsystems: kernfs
 ```
 
+(*) If you need other labels to facilitate your work, feel free to contact us.
+
 <div id="amend"/>
 <div id="linux-next"/>
 
-- 
cgit mrf-deployment