Re: [Patch v3 1/2] arm: kernel: Add SMC structure parameter

From: Russell King - ARM Linux
Date: Thu Jan 19 2017 - 11:34:18 EST


On Thu, Jan 19, 2017 at 10:16:58AM -0600, Andy Gross wrote:
> On Thu, Jan 19, 2017 at 03:48:18PM +0000, Russell King - ARM Linux wrote:
> > Please add that detail to the kerneldoc comments for the structure
> > concerning state.a6. It's important that such information is not
> > lost in the depths of history.
>
> For documentation, should I split out the union separately? I don't see any
> good examples for documenting union members in unions defined inside structures.

Good question - I don't know.

@state.a6: blah

would seem to be a logical and unambiguous way to document it, but I
don't know whether kerneldoc will accept that.

--
RMK's Patch system: http://www.armlinux.org.uk/developer/patches/
FTTC broadband for 0.8mile line: currently at 9.6Mbps down 400kbps up
according to speedtest.net.