All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet-T1hC0tSOHrs@public.gmane.org>
To: Srinivas Kandagatla
	<srinivas.kandagatla-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
Cc: Mark Brown <broonie-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>,
	Greg Kroah-Hartman
	<gregkh-hQyY1W1yCW8ekmWlsbkhG0B+6BGkLq7r@public.gmane.org>,
	alsa-devel-K7yf7f+aM1XWsZ/bQMPhNw@public.gmane.org,
	sdharia-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org,
	Rob Herring <robh+dt-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>,
	Mark Rutland <mark.rutland-5wv7dgnIgG8@public.gmane.org>,
	pombredanne-od1rfyK75/E@public.gmane.org,
	j.neuschaefer-hi6Y0CQ0nG0@public.gmane.org,
	linux-arm-msm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	linux-doc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Subject: Re: [PATCH v9 01/13] Documentation: Add SLIMbus summary
Date: Mon, 11 Dec 2017 16:34:29 -0700	[thread overview]
Message-ID: <20171211163429.67b4704f@lwn.net> (raw)
In-Reply-To: <138216ca-4351-f895-fae2-0289cf2a3872-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>

On Thu, 7 Dec 2017 23:22:51 +0000
Srinivas Kandagatla <srinivas.kandagatla-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org> wrote:

> > It seems you have kerneldoc comments for your data structures and at least
> > some of your exported symbols.  If you really want to document this stuff
> > well, I'd suggest finishing out those comments, then pulling them into the
> > documentation in the appropriate places.  
> Am sure all the exported symbols have kernel doc, I will pull them into 
> relevant sub sections.
> 
> Do you think something like this http://paste.ubuntu.com/26135862/ makes 
> sense?

At a first glance it looks good to me.

Thanks,

jon
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

WARNING: multiple messages have this Message-ID (diff)
From: Jonathan Corbet <corbet@lwn.net>
To: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
Cc: Mark Brown <broonie@kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	alsa-devel@alsa-project.org, sdharia@codeaurora.org,
	Rob Herring <robh+dt@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>,
	pombredanne@nexb.com, j.neuschaefer@gmx.net,
	linux-arm-msm@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH v9 01/13] Documentation: Add SLIMbus summary
Date: Mon, 11 Dec 2017 16:34:29 -0700	[thread overview]
Message-ID: <20171211163429.67b4704f@lwn.net> (raw)
In-Reply-To: <138216ca-4351-f895-fae2-0289cf2a3872@linaro.org>

On Thu, 7 Dec 2017 23:22:51 +0000
Srinivas Kandagatla <srinivas.kandagatla@linaro.org> wrote:

> > It seems you have kerneldoc comments for your data structures and at least
> > some of your exported symbols.  If you really want to document this stuff
> > well, I'd suggest finishing out those comments, then pulling them into the
> > documentation in the appropriate places.  
> Am sure all the exported symbols have kernel doc, I will pull them into 
> relevant sub sections.
> 
> Do you think something like this http://paste.ubuntu.com/26135862/ makes 
> sense?

At a first glance it looks good to me.

Thanks,

jon

  parent reply	other threads:[~2017-12-11 23:34 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-12-07 10:27 [PATCH v9 00/13] Introduce framework for SLIMbus device driver srinivas.kandagatla
2017-12-07 10:27 ` srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 01/13] Documentation: Add SLIMbus summary srinivas.kandagatla
2017-12-07 17:32   ` Jonathan Corbet
2017-12-07 23:22     ` Srinivas Kandagatla
2017-12-08  8:44       ` Vinod Koul
2017-12-08  8:44         ` [alsa-devel] " Vinod Koul
2017-12-08  9:09         ` Srinivas Kandagatla
2017-12-08  9:09           ` [alsa-devel] " Srinivas Kandagatla
     [not found]       ` <138216ca-4351-f895-fae2-0289cf2a3872-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
2017-12-11 23:34         ` Jonathan Corbet [this message]
2017-12-11 23:34           ` Jonathan Corbet
2017-12-07 10:27 ` [PATCH v9 02/13] dt-bindings: Add SLIMbus bindings srinivas.kandagatla
2017-12-07 10:27   ` srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 03/13] slimbus: Add SLIMbus bus type srinivas.kandagatla
2017-12-07 10:27   ` srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 04/13] slimbus: core: Add slim controllers support srinivas.kandagatla
2017-12-07 10:27   ` srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 05/13] slimbus: core: add support to device tree helper srinivas.kandagatla
2017-12-07 10:27   ` srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 06/13] slimbus: Add messaging APIs to slimbus framework srinivas.kandagatla
2017-12-07 10:27   ` srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 07/13] slimbus: Add support for 'clock-pause' feature srinivas.kandagatla
2017-12-07 10:27   ` srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 08/13] regmap: add SLIMbus support srinivas.kandagatla
2017-12-07 10:27   ` srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 09/13] slimbus: core: add common defines required for controllers srinivas.kandagatla
     [not found] ` <20171207102720.21071-1-srinivas.kandagatla-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>
2017-12-07 10:27   ` [PATCH v9 10/13] dt-bindings: Add qcom slimbus controller bindings srinivas.kandagatla-QSEj5FYQhm4dnm+yROfE0A
2017-12-07 10:27     ` srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 11/13] slimbus: qcom: Add Qualcomm Slimbus controller driver srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 12/13] slimbus: qcom: Add runtime-pm support using clock-pause srinivas.kandagatla
2017-12-07 10:27 ` [PATCH v9 13/13] MAINTAINERS: Add SLIMbus maintainer srinivas.kandagatla

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=20171211163429.67b4704f@lwn.net \
    --to=corbet-t1hc0tsohrs@public.gmane.org \
    --cc=alsa-devel-K7yf7f+aM1XWsZ/bQMPhNw@public.gmane.org \
    --cc=broonie-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org \
    --cc=devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=gregkh-hQyY1W1yCW8ekmWlsbkhG0B+6BGkLq7r@public.gmane.org \
    --cc=j.neuschaefer-hi6Y0CQ0nG0@public.gmane.org \
    --cc=linux-arm-msm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=linux-doc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=mark.rutland-5wv7dgnIgG8@public.gmane.org \
    --cc=pombredanne-od1rfyK75/E@public.gmane.org \
    --cc=robh+dt-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org \
    --cc=sdharia-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org \
    --cc=srinivas.kandagatla-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org \
    /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.