The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Andrew Morton <akpm@linux-foundation.org>
To: Philipp Zabel <philipp.zabel@gmail.com>
Cc: LKML <linux-kernel@vger.kernel.org>,
	Liam Girdwood <lg@opensource.wolfsonmicro.com>,
	Mark Brown <broonie@opensource.wolfsonmicro.com>
Subject: Re: [PATCH 1/2] regulator: TI bq24022 Li-Ion Charger driver
Date: Fri, 11 Jul 2008 12:16:38 -0700	[thread overview]
Message-ID: <20080711121638.3710c1ad.akpm@linux-foundation.org> (raw)
In-Reply-To: <1215716683.17490.29.camel@localhost.localdomain>

On Thu, 10 Jul 2008 21:04:43 +0200 Philipp Zabel <philipp.zabel@gmail.com> wrote:

> +/**
> + *bq24022_mach_info - platform data for bq24022
> + *@gpio_nce: GPIO line connected to the nCE pin,
> + *           used to enable / disable charging.
> + *@gpio_iset2: GPIO line connected to the ISET2 pin,
> + *             used to limit charging current to 100 mA / 500 mA.
> + */

We normally have a space after the "*" in kerneldoc comments (some
weird people use a tab and waste space).

I don't know whether the kerneldoc processors will correctly handle
the above.  I guess I'll fix it so we don't find out.

Also, I _think_ that kerneldoc will barf over the multi-line parameter
descriptions.  I'll join those lines.

--- a/include/linux/regulator/bq24022.h~regulator-ti-bq24022-li-ion-charger-driver-fix
+++ a/include/linux/regulator/bq24022.h
@@ -11,11 +11,9 @@
  */
 
 /**
- *bq24022_mach_info - platform data for bq24022
- *@gpio_nce: GPIO line connected to the nCE pin,
- *           used to enable / disable charging.
- *@gpio_iset2: GPIO line connected to the ISET2 pin,
- *             used to limit charging current to 100 mA / 500 mA.
+ * bq24022_mach_info - platform data for bq24022
+ * @gpio_nce: GPIO line connected to the nCE pin, used to enable / disable charging
+ * @gpio_iset2: GPIO line connected to the ISET2 pin, used to limit charging current to 100 mA / 500 mA
  */
 struct bq24022_mach_info {
 	int gpio_nce;
_


  parent reply	other threads:[~2008-07-11 19:17 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-07-10 19:04 [PATCH 1/2] regulator: TI bq24022 Li-Ion Charger driver Philipp Zabel
2008-07-11 10:28 ` Liam Girdwood
2008-07-11 15:27   ` Philipp Zabel
2008-07-11 19:16 ` Andrew Morton [this message]
2008-07-12 13:34   ` Liam Girdwood

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=20080711121638.3710c1ad.akpm@linux-foundation.org \
    --to=akpm@linux-foundation.org \
    --cc=broonie@opensource.wolfsonmicro.com \
    --cc=lg@opensource.wolfsonmicro.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=philipp.zabel@gmail.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox