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

From	Russell King - ARM Linux <linux@armlinux.org.uk>
Newsgroups	linux.kernel
Subject	Re: [Patch v3 1/2] arm: kernel: Add SMC structure parameter
Date	2017-01-19 17:40 +0100
Message-ID	<t1nUJ-3Tq-1@gated-at.bofh.it> (permalink)
References	(1 earlier) <sYzIK-4eb-35@gated-at.bofh.it> <t1mci-2Mr-25@gated-at.bofh.it> <t1n8n-3mv-43@gated-at.bofh.it> <t1n8n-3mv-41@gated-at.bofh.it> <t1nUK-3Tq-3@gated-at.bofh.it>
Organization	linux.* mail to news gateway

Show all headers | View raw

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.

Thread

Re: [Patch v3 1/2] arm: kernel: Add SMC structure parameter Russell King - ARM Linux <linux@armlinux.org.uk> - 2017-01-19 15:50 +0100
  Re: [Patch v3 1/2] arm: kernel: Add SMC structure parameter Russell King - ARM Linux <linux@armlinux.org.uk> - 2017-01-19 16:50 +0100
    Re: [Patch v3 1/2] arm: kernel: Add SMC structure parameter Russell King - ARM Linux <linux@armlinux.org.uk> - 2017-01-19 17:40 +0100
    Re: [Patch v3 1/2] arm: kernel: Add SMC structure parameter Andy Gross <andy.gross@linaro.org> - 2017-01-19 17:50 +0100
  Re: [Patch v3 1/2] arm: kernel: Add SMC structure parameter Andy Gross <andy.gross@linaro.org> - 2017-01-19 17:20 +0100

csiph-web