All of lore.kernel.org
 help / color / mirror / Atom feed
From: Russell King - ARM Linux <linux@armlinux.org.uk>
To: Andy Gross <andy.gross@linaro.org>
Cc: lorenzo.pieralisi@arm.com, linux-arm-msm@vger.kernel.org,
	will.deacon@arm.com, linux-kernel@vger.kernel.org,
	Bjorn Andersson <bjorn.andersson@linaro.org>,
	Srinivas Kandagatla <srinivas.kandagatla@linaro.org>,
	Kevin Hilman <khilman@baylibre.com>,
	linux-arm-kernel@lists.infradead.org
Subject: Re: [Patch v3 1/2] arm: kernel: Add SMC structure parameter
Date: Thu, 19 Jan 2017 16:24:38 +0000	[thread overview]
Message-ID: <20170119162438.GF27312@n2100.armlinux.org.uk> (raw)
In-Reply-To: <20170119161658.GC9631@hector.attlocal.net>

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.

WARNING: multiple messages have this Message-ID (diff)
From: linux@armlinux.org.uk (Russell King - ARM Linux)
To: linux-arm-kernel@lists.infradead.org
Subject: [Patch v3 1/2] arm: kernel: Add SMC structure parameter
Date: Thu, 19 Jan 2017 16:24:38 +0000	[thread overview]
Message-ID: <20170119162438.GF27312@n2100.armlinux.org.uk> (raw)
In-Reply-To: <20170119161658.GC9631@hector.attlocal.net>

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.

  reply	other threads:[~2017-01-19 16:24 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-11 22:31 [Patch v3 0/2] Support ARM SMCC SoC vendor quirks Andy Gross
2017-01-11 22:31 ` Andy Gross
2017-01-11 22:31 ` Andy Gross
2017-01-11 22:31 ` [Patch v3 1/2] arm: kernel: Add SMC structure parameter Andy Gross
2017-01-11 22:31   ` Andy Gross
2017-01-19 14:40   ` Russell King - ARM Linux
2017-01-19 14:40     ` Russell King - ARM Linux
2017-01-19 14:40     ` Russell King - ARM Linux
2017-01-19 15:45     ` Andy Gross
2017-01-19 15:45       ` Andy Gross
2017-01-19 15:48       ` Russell King - ARM Linux
2017-01-19 15:48         ` Russell King - ARM Linux
2017-01-19 16:16         ` Andy Gross
2017-01-19 16:16           ` Andy Gross
2017-01-19 16:24           ` Russell King - ARM Linux [this message]
2017-01-19 16:24             ` Russell King - ARM Linux
2017-01-11 22:31 ` [Patch v3 2/2] firmware: qcom: scm: Fix interrupted SCM calls Andy Gross
2017-01-11 22:31   ` Andy Gross

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170119162438.GF27312@n2100.armlinux.org.uk \
    --to=linux@armlinux.org.uk \
    --cc=andy.gross@linaro.org \
    --cc=bjorn.andersson@linaro.org \
    --cc=khilman@baylibre.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-arm-msm@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lorenzo.pieralisi@arm.com \
    --cc=srinivas.kandagatla@linaro.org \
    --cc=will.deacon@arm.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.