From 0d0ac3cb132ec5aa1fd7ba7bc0c5b50c139049ba Mon Sep 17 00:00:00 2001
From: Paul Elder <paul.elder@ideasonboard.com>
Date: Mon, 15 Mar 2021 18:22:14 +0900
Subject: ipa: ipa_interface: Add comment to defend the forward-declaration
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Any struct that is defined in core.mojom with the skipHeader tag needs
to be present in ipa_interface.h, either forward-declared or #included.
Add a comment so that, in the future, people don't try to send patches
removing the seemingly unused forward-declaration.

Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 include/libcamera/ipa/ipa_interface.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/include/libcamera/ipa/ipa_interface.h b/include/libcamera/ipa/ipa_interface.h
index 47f81d1d..5d99e2cf 100644
--- a/include/libcamera/ipa/ipa_interface.h
+++ b/include/libcamera/ipa/ipa_interface.h
@@ -20,6 +20,11 @@
 
 namespace libcamera {
 
+/*
+ * Structs that are defined in core.mojom and have the skipHeader tag must be
+ * forward-declared or #included here.
+ */
+
 struct CameraSensorInfo;
 
 class IPAInterface
-- 
cgit v1.2.1