From: Thierry Reding <thierry.reding@avionic-design.de>
To: Alex Courbot <acourbot@nvidia.com>
Cc: "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] pwm: add devm_pwm_get() and devm_pwm_put()
Date: Wed, 1 Aug 2012 11:56:28 +0200 [thread overview]
Message-ID: <20120801095628.GA30253@avionic-0098.adnet.avionic-design.de> (raw)
In-Reply-To: <5018E62C.7010908@nvidia.com>
[-- Attachment #1: Type: text/plain, Size: 970 bytes --]
On Wed, Aug 01, 2012 at 05:17:48PM +0900, Alex Courbot wrote:
> On Wed 01 Aug 2012 05:04:53 PM JST, Thierry Reding wrote:
> >* PGP Signed by an unknown key
> >
> >On Wed, Aug 01, 2012 at 04:37:09PM +0900, Alexandre Courbot wrote:
> >>+/**
> >>+ * devm_pwm_get() - Resource managed pwm_get()
> >
> >This is missing parameter descriptions here.
>
> This is because the documentation for this function just refers to
> pwm_get(), and the parameters are the same. I think it's better to
> avoid duplicating documentation as much as possible as this makes
> two maintenance points instead of one.
devm_pwm_get() and devm_pwm_put() aren't very likely to change. The
problem is that they are public APIs and people could be running
kerneldoc over the files to have documentation generated and the
parameters would be missing in this case. We really don't have a lot of
these public functions, but those that are should be properly
documented.
Thierry
[-- Attachment #2: Type: application/pgp-signature, Size: 836 bytes --]
prev parent reply other threads:[~2012-08-01 9:56 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-08-01 7:37 [PATCH] pwm: add devm_pwm_get() and devm_pwm_put() Alexandre Courbot
2012-08-01 8:04 ` Thierry Reding
2012-08-01 8:17 ` Alex Courbot
2012-08-01 9:56 ` Thierry Reding [this message]
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=20120801095628.GA30253@avionic-0098.adnet.avionic-design.de \
--to=thierry.reding@avionic-design.de \
--cc=acourbot@nvidia.com \
--cc=linux-kernel@vger.kernel.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox