* [PATCH v2 1/2] docs: *-regressions.rst: Add colon to regzbot commands
2024-03-11 14:36 [PATCH v2 0/2] docs: *-regressions.rst: Tweaks to the commands Nícolas F. R. A. Prado
@ 2024-03-11 14:36 ` Nícolas F. R. A. Prado
2024-03-11 14:36 ` [PATCH v2 2/2] docs: handling-regressions.rst: Update regzbot command fixed-by to fix Nícolas F. R. A. Prado
2024-03-18 9:40 ` [PATCH v2 0/2] docs: *-regressions.rst: Tweaks to the commands Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Nícolas F. R. A. Prado @ 2024-03-11 14:36 UTC (permalink / raw)
To: Thorsten Leemhuis, Jonathan Corbet
Cc: kernel, regressions, linux-doc, linux-kernel, workflows,
Chris Bainbridge, Nícolas F. R. A. Prado
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>
---
Documentation/admin-guide/reporting-regressions.rst | 2 +-
Documentation/process/handling-regressions.rst | 10 +++++-----
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/admin-guide/reporting-regressions.rst b/Documentation/admin-guide/reporting-regressions.rst
index d8adccdae23f..76b246ecf21b 100644
--- a/Documentation/admin-guide/reporting-regressions.rst
+++ b/Documentation/admin-guide/reporting-regressions.rst
@@ -31,7 +31,7 @@ The important bits (aka "TL;DR")
Linux kernel regression tracking bot "regzbot" track the issue by specifying
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
diff --git a/Documentation/process/handling-regressions.rst b/Documentation/process/handling-regressions.rst
index 5d3c3de3f4ec..42b13f77b019 100644
--- a/Documentation/process/handling-regressions.rst
+++ b/Documentation/process/handling-regressions.rst
@@ -27,11 +27,11 @@ The important bits (aka "The TL;DR")
is optional, but recommended):
* 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
when the issue started to happen::
- #regzbot ^introduced 1f2e3d4c5b6a
+ #regzbot ^introduced: 1f2e3d4c5b6a
* When forwarding reports from a bug tracker to the regressions list (see
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:
* 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:::
#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
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
-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
regression which it starts to track.
--
2.44.0
^ permalink raw reply [flat|nested] 4+ messages in thread* [PATCH v2 2/2] docs: handling-regressions.rst: Update regzbot command fixed-by to fix
2024-03-11 14:36 [PATCH v2 0/2] docs: *-regressions.rst: Tweaks to the commands Nícolas F. R. A. Prado
2024-03-11 14:36 ` [PATCH v2 1/2] docs: *-regressions.rst: Add colon to regzbot commands Nícolas F. R. A. Prado
@ 2024-03-11 14:36 ` Nícolas F. R. A. Prado
2024-03-18 9:40 ` [PATCH v2 0/2] docs: *-regressions.rst: Tweaks to the commands Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Nícolas F. R. A. Prado @ 2024-03-11 14:36 UTC (permalink / raw)
To: Thorsten Leemhuis, Jonathan Corbet
Cc: kernel, regressions, linux-doc, linux-kernel, workflows,
Chris Bainbridge, Nícolas F. R. A. Prado
On the reference documentation for regzbot, the fixed-by command has
been renamed to fix. Update the kernel documentation accordingly.
Link: https://gitlab.com/knurd42/regzbot/-/blob/main/docs/reference.md
Link: https://gitlab.com/knurd42/regzbot/-/commit/6d8d30f6bda84e1b711121bb98a07a464d3f089a
Reviewed-by: Thorsten Leemhuis <linux@leemhuis.info>
Signed-off-by: Nícolas F. R. A. Prado <nfraprado@collabora.com>
---
Documentation/process/handling-regressions.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/process/handling-regressions.rst b/Documentation/process/handling-regressions.rst
index 42b13f77b019..ce6753a674f3 100644
--- a/Documentation/process/handling-regressions.rst
+++ b/Documentation/process/handling-regressions.rst
@@ -432,7 +432,7 @@ or itself is a reply to that mail:
* Mark a regression as fixed by a commit that is heading upstream or already
landed::
- #regzbot fixed-by: 1f2e3d4c5d
+ #regzbot fix: 1f2e3d4c5d
* Mark a regression as a duplicate of another one already tracked by regzbot::
--
2.44.0
^ permalink raw reply [flat|nested] 4+ messages in thread