kevin/linux
1
Fork 0
Code

docs: *-regressions.rst: Add colon to regzbot commands

Browse Source 
Use colon as command terminator everywhere for consistency, even though
it's not strictly necessary. That way it will also match regzbot's
reference documentation.

Link: https://gitlab.com/knurd42/regzbot/-/blob/main/docs/reference.md
Reviewed-by: Thorsten Leemhuis <linux@leemhuis.info>
Signed-off-by: "Nícolas F. R. A. Prado" <nfraprado@collabora.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20240311-regzbot-fixes-v2-1-98c1b6ec0678@collabora.com>
This commit is contained in:
Nícolas F. R. A. Prado 2024-03-11 10:36:15 -04:00 committed by Jonathan Corbet
parent b4331b9884
commit 93cf15794d
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/admin-guide/reporting-regressions.rst
View File

@ -31,7 +31,7 @@ The important bits (aka "TL;DR")
Linux kernel regression tracking bot "regzbot" track the issue by specifying Linux kernel regression tracking bot "regzbot" track the issue by specifying
when the regression started like this:: when the regression started like this::
#regzbot introduced v5.13..v5.14-rc1 #regzbot introduced: v5.13..v5.14-rc1
All the details on Linux kernel regressions relevant for users All the details on Linux kernel regressions relevant for users

10
Documentation/process/handling-regressions.rst
View File

@ -27,11 +27,11 @@ The important bits (aka "The TL;DR")
is optional, but recommended): is optional, but recommended):
* For mailed reports, check if the reporter included a line like ``#regzbot * For mailed reports, check if the reporter included a line like ``#regzbot
introduced v5.13..v5.14-rc1``. If not, send a reply (with the regressions introduced: v5.13..v5.14-rc1``. If not, send a reply (with the regressions
list in CC) containing a paragraph like the following, which tells regzbot list in CC) containing a paragraph like the following, which tells regzbot
when the issue started to happen:: when the issue started to happen::
#regzbot ^introduced 1f2e3d4c5b6a #regzbot ^introduced: 1f2e3d4c5b6a
* When forwarding reports from a bug tracker to the regressions list (see * When forwarding reports from a bug tracker to the regressions list (see
above), include a paragraph like the following:: above), include a paragraph like the following::
@ -79,7 +79,7 @@ When doing either, consider making the Linux kernel regression tracking bot
"regzbot" immediately start tracking the issue: "regzbot" immediately start tracking the issue:
* For mailed reports, check if the reporter included a "regzbot command" like * For mailed reports, check if the reporter included a "regzbot command" like
``#regzbot introduced 1f2e3d4c5b6a``. If not, send a reply (with the ``#regzbot introduced: 1f2e3d4c5b6a``. If not, send a reply (with the
regressions list in CC) with a paragraph like the following::: regressions list in CC) with a paragraph like the following:::
#regzbot ^introduced: v5.13..v5.14-rc1 #regzbot ^introduced: v5.13..v5.14-rc1
@ -398,9 +398,9 @@ By using a 'regzbot command' in a direct or indirect reply to the mail with the
regression report. These commands need to be in their own paragraph (IOW: they regression report. These commands need to be in their own paragraph (IOW: they
need to be separated from the rest of the mail using blank lines). need to be separated from the rest of the mail using blank lines).
One such command is ``#regzbot introduced <version or commit>``, which makes One such command is ``#regzbot introduced: <version or commit>``, which makes
regzbot consider your mail as a regressions report added to the tracking, as regzbot consider your mail as a regressions report added to the tracking, as
already described above; ``#regzbot ^introduced <version or commit>`` is another already described above; ``#regzbot ^introduced: <version or commit>`` is another
such command, which makes regzbot consider the parent mail as a report for a such command, which makes regzbot consider the parent mail as a report for a
regression which it starts to track. regression which it starts to track.