Revert "subcompositor: emit new_subsurface immediately"

new_subsurface emitted immediately isn't actually that useful. Revert the change
and document that this event is special.

This reverts commit 504b9491f05d3227d45ea6bcc9c347e1a6bf9586.

1 files changed, 6 insertions, 1 deletions

diff --git a/include/wlr/types/wlr_compositor.h b/include/wlr/types/wlr_compositor.h
index 322e9ed2..26530951 100644
--- a/include/wlr/types/wlr_compositor.h
+++ b/include/wlr/types/wlr_compositor.h
@@ -190,7 +190,12 @@ struct wlr_surface {
 		 */
 		struct wl_signal unmap;
 
-		struct wl_signal new_subsurface;
+		/**
+		 * Note: unlike other new_* signals, new_subsurface is emitted when
+		 * the subsurface is added to the parent surface's current state,
+		 * not when the object is created.
+		 */
+		struct wl_signal new_subsurface; // struct wlr_subsurface
 		struct wl_signal destroy;
 	} events;