From 076bc540640b395011b76fc3119b51e6bd3fd0b9 Mon Sep 17 00:00:00 2001
From: "Enrico Weigelt, metux IT consult" <info@metux.net>
Date: Tue, 6 May 2025 14:11:04 +0200
Subject: [PATCH] dix: region: add comments on xfreeData()

Commenting a few aspects need to be considered when using this macro.

Signed-off-by: Enrico Weigelt, metux IT consult <info@metux.net>
---
 dix/region.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/dix/region.c b/dix/region.c
index 00c804ea2..2efc4de26 100644
--- a/dix/region.c
+++ b/dix/region.c
@@ -167,6 +167,9 @@ Equipment Corporation.
         ((r1)->y1 <= (r2)->y1) && \
         ((r1)->y2 >= (r2)->y2) )
 
+// note: we really need to check for size, because when it's zero, then data
+// might point to RegionBrokenData (.data segment), which we must not free()
+// (this also can create analyzer false alarms)
 #define xfreeData(reg) if ((reg)->data && (reg)->data->size) free((reg)->data)
 
 #define RECTALLOC_BAIL(pReg,n,bail) \