Skip to contentSkip to conversation

Monitoring the status of your own patches on patchwork?

DISCUSSION Toke Høiland-Jørgensen 5 participants 11 messages Dec 11, 2021 – Dec 14, 2021 Documentation process

lore
Share & tools
lore
#0 lore raw

Hi everyone!

I was wondering if anyone had any nifty tricks or utilities to help monitor the status of your own patch submissions on a patchwork instance? Things like getting a notification when a patch changes status or when one of the automated checks on that particular patchwork instance fails for a patch you submitted?

I can just filter the patchwork web interface to my name, of course, but I would like something that can be automated so I can make the stuff I care about show up in my inbox :)

Many thanks in advance!

-Toke

#1 lore raw
Quoted 7 lines · On Sat, 11 Dec 2021 20:06:00 +0100 Toke Høiland-Jørgensen wrote:

Hi everyone!

I was wondering if anyone had any nifty tricks or utilities to help monitor the status of your own patch submissions on a patchwork instance? Things like getting a notification when a patch changes status or when one of the automated checks on that particular patchwork instance fails for a patch you submitted?

Status notification when checks are failing? Hopefully not, we don't want people posting patches just to get them tested...

Quoted 5 lines

I can just filter the patchwork web interface to my name, of course, but I would like something that can be automated so I can make the stuff I care about show up in my inbox :)

Many thanks in advance!

#2 lore raw
Quoted 11 lines · Jakub Kicinski
Quoted 7 lines · On Sat, 11 Dec 2021 20:06:00 +0100 Toke Høiland-Jørgensen wrote:

Hi everyone!

I was wondering if anyone had any nifty tricks or utilities to help monitor the status of your own patch submissions on a patchwork instance? Things like getting a notification when a patch changes status or when one of the automated checks on that particular patchwork instance fails for a patch you submitted?

Status notification when checks are failing? Hopefully not, we don't want people posting patches just to get them tested...

Well no, but sometimes a patch will have failures despite the best efforts of the submitter (otherwise what's the point of the checks?). Right now the only way for me to discover that there's an issue is to go look at the patchwork web interface, and I wanted something that better suits my workflow (i.e., that's not in a web browser).

I wasn't asking for patchwork to send out automatic notifications (yikes!), I just wanted to know if anyone else had done something similar before I go play around with the patchwork API myself... :)

-Toke

#3 lore raw
Quoted 8 lines · On Mon, 13 Dec 2021 16:48:37 +0100 Toke Høiland-Jørgensen wrote:
Quoted 2 lines

Status notification when checks are failing? Hopefully not, we don't want people posting patches just to get them tested...

Well no, but sometimes a patch will have failures despite the best efforts of the submitter (otherwise what's the point of the checks?). Right now the only way for me to discover that there's an issue is to go look at the patchwork web interface, and I wanted something that better suits my workflow (i.e., that's not in a web browser).

I think that the maintainer should notify the submitter about the reason the patch state was changed (with the exception of patches for a different tree, maybe). I know Kees has been trying to add more meaningful states to patchwork but I can never guess the meaning of those either :S So no automated state checker can replace the maintainer's reply.

Quoted 3 lines

I wasn't asking for patchwork to send out automatic notifications (yikes!), I just wanted to know if anyone else had done something similar before I go play around with the patchwork API myself... :)

Despite the promise of "best effort" I fear such automation. It's pretty common in (let's call them) modern workflows to submit PRs / post changes just to get them tested by a CI. We don't want to give people the impression that the mailing list can serve this purpose.

Obviously I can't stop you from writing your local code :) just trying to widen the perspective.

#4 lore raw
Quoted 10 lines · Jakub Kicinski
Quoted 8 lines · On Mon, 13 Dec 2021 16:48:37 +0100 Toke Høiland-Jørgensen wrote:
Quoted 2 lines

Status notification when checks are failing? Hopefully not, we don't want people posting patches just to get them tested...

Well no, but sometimes a patch will have failures despite the best efforts of the submitter (otherwise what's the point of the checks?). Right now the only way for me to discover that there's an issue is to go look at the patchwork web interface, and I wanted something that better suits my workflow (i.e., that's not in a web browser).

Quoted 6 lines

I think that the maintainer should notify the submitter about the reason the patch state was changed (with the exception of patches for a different tree, maybe). I know Kees has been trying to add more meaningful states to patchwork but I can never guess the meaning of those either :S So no automated state checker can replace the maintainer's reply.

Well, sometimes the maintainers forget to reply entirely :)

And yeah, I do realise that no bot is going to be able to tell me exactly what the current status is, I just want a tool to help me manually keep track...

Quoted 9 lines
Quoted 3 lines

I wasn't asking for patchwork to send out automatic notifications (yikes!), I just wanted to know if anyone else had done something similar before I go play around with the patchwork API myself... :)

Despite the promise of "best effort" I fear such automation. It's pretty common in (let's call them) modern workflows to submit PRs / post changes just to get them tested by a CI. We don't want to give people the impression that the mailing list can serve this purpose.

People could already do that, though, they just have to look at the patchwork site. And I really don't think it's that convenient of an interface that this is a real risk. But don't worry, I'm not planning to publish this as a generally-available service :)

-Toke

#5 lore raw
Quoted 19 lines · Toke Høiland-Jørgensen
Quoted 10 lines · Jakub Kicinski
Quoted 8 lines · On Mon, 13 Dec 2021 16:48:37 +0100 Toke Høiland-Jørgensen wrote:
Quoted 2 lines

Status notification when checks are failing? Hopefully not, we don't want people posting patches just to get them tested...

Well no, but sometimes a patch will have failures despite the best efforts of the submitter (otherwise what's the point of the checks?). Right now the only way for me to discover that there's an issue is to go look at the patchwork web interface, and I wanted something that better suits my workflow (i.e., that's not in a web browser).

Quoted 6 lines

I think that the maintainer should notify the submitter about the reason the patch state was changed (with the exception of patches for a different tree, maybe). I know Kees has been trying to add more meaningful states to patchwork but I can never guess the meaning of those either :S So no automated state checker can replace the maintainer's reply.

Quoted 5 lines

Well, sometimes the maintainers forget to reply entirely :)

And yeah, I do realise that no bot is going to be able to tell me exactly what the current status is, I just want a tool to help me manually keep track...

I've mostly been trying to capture the state of the patch review conversation with some kind of flag in patchwork. For KSPP, we've documented it here:
https://kernsec.org/wiki/index.php/Kernel_Self_Protection_Project/Patch_Tracking

Signature · 1 line
Kees Cook
#6 lore raw
In reply to Toke Høiland-Jørgensen

Hi,

Quoted 9 lines · Toke Høiland-Jørgensen

Hi everyone!

I was wondering if anyone had any nifty tricks or utilities to help monitor the status of your own patch submissions on a patchwork instance? Things like getting a notification when a patch changes status or when one of the automated checks on that particular patchwork instance fails for a patch you submitted?

Quoted 3 lines

I can just filter the patchwork web interface to my name, of course, but I would like something that can be automated so I can make the stuff I care about show up in my inbox :)

I'll just mention 'patman status' here, which collects tags from patchwork so you can send them with the next version. It also shows you code-review snippets on the cmdline which I find much faster to process, particularly for large patches. See below, although it's a bit hard to read without the colours that patman uses.

I would like something that can track all the series and tell me what is outstanding. At the moment I keep a manual list but often forget things.

$ patman status
  1 efi: Rename UCLASS_EFI and IF_TYPE_EFI
  + Reviewed-by: Heinrich Schuchardt <[email protected]>
  2 efi: Add EFI uclass for media
  + Reviewed-by: Heinrich Schuchardt <[email protected]>
  3 efi: Add a media/block driver for EFI block device
  + Reviewed-by: Heinrich Schuchardt <[email protected]>
  4 efi: Locate all block devices in the app
  5 efi: serial: Support arrow keys
[...]
3 new responses available in patchwork (use -d to write them to a new branch)
$ patman status -C
  1 efi: Rename UCLASS_EFI and IF_TYPE_EFI
  + Reviewed-by: Heinrich Schuchardt <[email protected]>
Review: Heinrich Schuchardt <[email protected]>
Quoted 7 lines

File: include/dm/uclass-id.h
Line: 48 / 48: enum uclass_id {
UCLASS_DMA, /* Direct Memory Access */
UCLASS_DSA, /* Distributed (Ethernet) Switch Architecture */ UCLASS_ECDSA, /* Elliptic curve cryptographic device */
- UCLASS_EFI, /* EFI managed devices */
+ UCLASS_EFI_LOADER, /* Devices managed by EFI_LOADER */

"managed by EFI_LOADER" does not catch it. I will change this to "devices created by UEFI applications and drivers" when merging.

2 efi: Add EFI uclass for media
+ Reviewed-by: Heinrich Schuchardt <[email protected]>
Review: Heinrich Schuchardt <[email protected]>

Quoted 1 line

At present UCLASS_EFI is used to represent an EFI filesystem among other

%s/UCLASS_EFI/UCLASS_EFI_LOADER/

> pretty vague. The only driver that uses this uclass is in fact not a real > U-Boot driver, since its operations do not include a struct udevice. >
> Rather than mess with this, create a new UCLASS_EFI_MEDIA uclass to handle > EFI media such as disks. Make this the uclass to use for EFI media so that The new uclass is for devices provided by an UEFI implementation loading U-Boot as an EFI application.

> it can be used with 'part list', for example.
>
> The existing implementation using UCLASS_EFI remains as is, for %s/UCLASS_EFI/UCLASS_EFI_LOADER/
The existing uclass is for devices created by UEFI applications loaded by U-Boot.

> File: include/dm/uclass-id.h
> Line: 49 / 49: enum uclass_id {
> +++ b/include/dm/uclass-id.h
> UCLASS_DSA, /* Distributed (Ethernet) Switch Architecture */
> UCLASS_ECDSA, /* Elliptic curve cryptographic device */
> UCLASS_EFI_LOADER, /* Devices managed by EFI_LOADER */
> + UCLASS_EFI_MEDIA, /* EFI media (e.g. a disk) */ %s/EFI media (e.g. a disk)/devices provided by UEFI firmware */ With those changes:

3 efi: Add a media/block driver for EFI block device
+ Reviewed-by: Heinrich Schuchardt <[email protected]>

Regards,
Simon

#7 lore raw
Quoted 16 lines · Simon Glass

Hi,

Quoted 9 lines · Toke Høiland-Jørgensen

Hi everyone!

I was wondering if anyone had any nifty tricks or utilities to help monitor the status of your own patch submissions on a patchwork instance? Things like getting a notification when a patch changes status or when one of the automated checks on that particular patchwork instance fails for a patch you submitted?

Quoted 3 lines

I can just filter the patchwork web interface to my name, of course, but I would like something that can be automated so I can make the stuff I care about show up in my inbox :)

Quoted 5 lines

I'll just mention 'patman status' here, which collects tags from patchwork so you can send them with the next version. It also shows you code-review snippets on the cmdline which I find much faster to process, particularly for large patches. See below, although it's a bit hard to read without the colours that patman uses.

Ah, this is cool, didn't know about patman! Will take a closer look, it seems to be solving some of the same issues I've been rolling my own solutions for - thanks for the pointer! :)

-Toke

#8 lore raw

Hi Toke,

Quoted 25 lines · Toke Høiland-Jørgensen
Quoted 16 lines · Simon Glass

Hi,

Quoted 9 lines · Toke Høiland-Jørgensen

Hi everyone!

I was wondering if anyone had any nifty tricks or utilities to help monitor the status of your own patch submissions on a patchwork instance? Things like getting a notification when a patch changes status or when one of the automated checks on that particular patchwork instance fails for a patch you submitted?

Quoted 3 lines

I can just filter the patchwork web interface to my name, of course, but I would like something that can be automated so I can make the stuff I care about show up in my inbox :)

Quoted 5 lines

I'll just mention 'patman status' here, which collects tags from patchwork so you can send them with the next version. It also shows you code-review snippets on the cmdline which I find much faster to process, particularly for large patches. See below, although it's a bit hard to read without the colours that patman uses.

Quoted 3 lines

Ah, this is cool, didn't know about patman! Will take a closer look, it seems to be solving some of the same issues I've been rolling my own solutions for - thanks for the pointer! :)

You're welcome. I do hope things continue to grow in this area.

Regards,
Simon

#9 lore raw
In reply to Simon Glass
Quoted 22 lines · Simon Glass

Hi,

Quoted 9 lines · Toke Høiland-Jørgensen

Hi everyone!

I was wondering if anyone had any nifty tricks or utilities to help monitor the status of your own patch submissions on a patchwork instance? Things like getting a notification when a patch changes status or when one of the automated checks on that particular patchwork instance fails for a patch you submitted?

Quoted 3 lines

I can just filter the patchwork web interface to my name, of course, but I would like something that can be automated so I can make the stuff I care about show up in my inbox :)

I'll just mention 'patman status' here, which collects tags from patchwork so you can send them with the next version. It also shows you code-review snippets on the cmdline which I find much faster to process, particularly for large patches. See below, although it's a bit hard to read without the colours that patman uses.

Quoted 3 lines

I would like something that can track all the series and tell me what is outstanding. At the moment I keep a manual list but often forget things.

Hi,
Where is this 'patman' found, please?

I see https://source.denx.de/u-boot/custodians/u-boot-dm/-/tree/patman-working
and https://github.com/siemens/u-boot/tree/master/tools/patman
(the latter one seems to be untouched recently).

Is there another URL or is the denx.de URL the one to use?

thanks.

Signature · 1 line
~Randy
#10 lore raw

Hi Randy,

Quoted 30 lines · Randy Dunlap
Quoted 22 lines · Simon Glass

Hi,

Quoted 9 lines · Toke Høiland-Jørgensen

Hi everyone!

I was wondering if anyone had any nifty tricks or utilities to help monitor the status of your own patch submissions on a patchwork instance? Things like getting a notification when a patch changes status or when one of the automated checks on that particular patchwork instance fails for a patch you submitted?

Quoted 3 lines

I can just filter the patchwork web interface to my name, of course, but I would like something that can be automated so I can make the stuff I care about show up in my inbox :)

I'll just mention 'patman status' here, which collects tags from patchwork so you can send them with the next version. It also shows you code-review snippets on the cmdline which I find much faster to process, particularly for large patches. See below, although it's a bit hard to read without the colours that patman uses.

Quoted 3 lines

I would like something that can track all the series and tell me what is outstanding. At the moment I keep a manual list but often forget things.

Quoted 8 lines

Hi,
Where is this 'patman' found, please?

I see https://source.denx.de/u-boot/custodians/u-boot-dm/-/tree/patman-working
and https://github.com/siemens/u-boot/tree/master/tools/patman
(the latter one seems to be untouched recently).

Is there another URL or is the denx.de URL the one to use?

You can use Denx but I suggest github:

https://github.com/u-boot/u-boot

I should figure out how to get patman into pip.

Regards,
Simon