[PATCH 0/2] xics, xive: Add some missing comments

[PATCH 0/2] xics, xive: Add some missing comments

[Greg Kurz]

As noted by Markus, the reason why a device type isn't user creatable
should be documented.

These patches can be squashed into the ones that made the devices
non user-creatable, or applied as follow-ups, at the discretion of
the maintainer.

--
Greg

---

Greg Kurz (2):
      xive: Add /* Reason */ comment to "->user_creatable = false" statements
      xics: Add /* Reason */ comment to "->user_creatable = false" statements


 hw/intc/xics.c |    8 ++++++++
 hw/intc/xive.c |   12 ++++++++++++
 2 files changed, 20 insertions(+)

[PATCH 1/2] xive: Add /* Reason */ comment to "->user_creatable = false" statements

[Greg Kurz]

Signed-off-by: Greg Kurz <groug@kaod.org>
---
 hw/intc/xive.c |   12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/hw/intc/xive.c b/hw/intc/xive.c
index 6c54a35fd4bb..453d389848f8 100644
--- a/hw/intc/xive.c
+++ b/hw/intc/xive.c
@@ -670,6 +670,10 @@ static void xive_tctx_class_init(ObjectClass *klass, void *data)
     dc->realize = xive_tctx_realize;
     dc->unrealize = xive_tctx_unrealize;
     dc->vmsd = &vmstate_xive_tctx;
+    /*
+     * Reason: part of XIVE interrupt controller, needs to be wired up
+     * by xive_tctx_create().
+     */
     dc->user_creatable = false;
 }
 
@@ -1119,6 +1123,10 @@ static void xive_source_class_init(ObjectClass *klass, void *data)
     dc->props   = xive_source_properties;
     dc->realize = xive_source_realize;
     dc->vmsd    = &vmstate_xive_source;
+    /*
+     * Reason: part of XIVE interrupt controller, needs to be wired up,
+     * e.g. by spapr_xive_instance_init().
+     */
     dc->user_creatable = false;
 }
 
@@ -1855,6 +1863,10 @@ static void xive_end_source_class_init(ObjectClass *klass, void *data)
     dc->desc    = "XIVE END Source";
     dc->props   = xive_end_source_properties;
     dc->realize = xive_end_source_realize;
+    /*
+     * Reason: part of XIVE interrupt controller, needs to be wired up,
+     * e.g. by spapr_xive_instance_init().
+     */
     dc->user_creatable = false;
 }
 

[PATCH 2/2] xics: Add /* Reason */ comment to "->user_creatable = false" statements

[Greg Kurz]

Signed-off-by: Greg Kurz <groug@kaod.org>
---
 hw/intc/xics.c |    8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/hw/intc/xics.c b/hw/intc/xics.c
index 8d41df3103f9..b5ac408f7b74 100644
--- a/hw/intc/xics.c
+++ b/hw/intc/xics.c
@@ -369,6 +369,10 @@ static void icp_class_init(ObjectClass *klass, void *data)
 
     dc->realize = icp_realize;
     dc->unrealize = icp_unrealize;
+    /*
+     * Reason: part of XICS interrupt controller, needs to be wired up
+     * by icp_create().
+     */
     dc->user_creatable = false;
 }
 
@@ -690,6 +694,10 @@ static void ics_class_init(ObjectClass *klass, void *data)
     dc->props = ics_properties;
     dc->reset = ics_reset;
     dc->vmsd = &vmstate_ics;
+    /*
+     * Reason: part of XICS interrupt controller, needs to be wired up,
+     * e.g. by spapr_irq_init().
+     */
     dc->user_creatable = false;
 }
 

Re: [PATCH 0/2] xics, xive: Add some missing comments

[David Gibson]

[-- Attachment #1: Type: text/plain, Size: 541 bytes --]

On Mon, Oct 07, 2019 at 03:42:58PM +0200, Greg Kurz wrote:
> As noted by Markus, the reason why a device type isn't user creatable
> should be documented.
> 
> These patches can be squashed into the ones that made the devices
> non user-creatable, or applied as follow-ups, at the discretion of
> the maintainer.

Applied and squashed.

-- 
David Gibson			| I'll have my music baroque, and my code
david AT gibson.dropbear.id.au	| minimalist, thank you.  NOT _the_ _other_
				| _way_ _around_!
http://www.ozlabs.org/~dgibson

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]