From 234d31f13832a701e2d2fa266ced76ba8d95f289 Mon Sep 17 00:00:00 2001
From: Simon Ser <contact@emersion.fr>
Date: Wed, 21 Aug 2024 23:54:24 +0200
Subject: [PATCH] backend/drm: improve doc comment for
 match_connectors_with_crtcs_()

- Add general description
- Mention the computer theory problem that this is solving
- More wording cleanup
---
 backend/drm/util.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/backend/drm/util.c b/backend/drm/util.c
index 6ba090c1..f3089896 100644
--- a/backend/drm/util.c
+++ b/backend/drm/util.c
@@ -123,9 +123,12 @@ struct match_state {
 	bool exit_early;
 };
 
-/*
- * skips: The number of SKIP elements encountered so far.
- * score: The number of resources we've matched so far.
+/**
+ * Step to process a CRTC.
+ *
+ * This is a naive implementation of maximum bipartite matching.
+ *
+ * score: The number of connectors we've matched so far.
  * replaced: The number of changes from the original solution.
  * crtc_index: The index of the current CRTC.
  *