From fd0a845cb4c459374051b0109a3ed3c5d3efbd3d Mon Sep 17 00:00:00 2001
From: Simon Ser <contact@emersion.fr>
Date: Fri, 5 Jun 2020 16:43:45 +0200
Subject: contributing: resource destroy handlers need to cleanup pointers

---
 CONTRIBUTING.md | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'CONTRIBUTING.md')

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e8eb8917..cb75e6d5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -284,6 +284,11 @@ struct wlr_surface *wlr_surface_from_resource(struct wl_resource *resource) {
 }
 ```
 
+If a pointer to a `wl_resource` is stored, a resource destroy handler needs to
+be registered to clean it up. libwayland will automatically destroy resources
+in an arbitrary order when a client is disconnected, the compositor must handle
+this correctly.
+
 ### Destroying resources
 
 Object structs should only be destroyed when their resource is destroyed, ie.
-- 
cgit v1.2.3