netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Darren Hart <dvhart@linux.intel.com>
To: Joe Perches <joe@perches.com>
Cc: David Miller <davem@davemloft.net>,
	netdev@vger.kernel.org, hpa@zytor.com,
	peter.p.waskiewicz.jr@intel.com,
	andriy.shevchenko@linux.intel.com
Subject: Re: [PATCH V2 net-next 2/2] pch_gbe: Add MinnowBoard support
Date: Wed, 24 Jul 2013 20:14:24 -0700	[thread overview]
Message-ID: <1374722064.3436.252.camel@dvhart-mobl1.amr.corp.intel.com> (raw)
In-Reply-To: <1374721731.1924.34.camel@joe-AO722>

On Wed, 2013-07-24 at 20:08 -0700, Joe Perches wrote:
> On Wed, 2013-07-24 at 19:58 -0700, Darren Hart wrote:
> > On Wed, 2013-07-24 at 17:41 -0700, Joe Perches wrote:
> > > On Wed, 2013-07-24 at 17:20 -0700, Darren Hart wrote:
> > > > Ah, thanks. Leftover from a more complex driver_data with pointers to
> > > > these functions. I'll fix and resubmit this patch alone as V3.
> > > > Otherwise, no objections?
> > > 
> > > Only small nit is not using kernel-doc for this bit below:
> []
> > I was following the existing style of the file (with the exception of
> > the leading two ** as checkpatch complains. I thought erring on the side
> > of consistency was the best course of action here. What would you
> > suggest is the preferred approach here?
> 
> Hi Darren.
> 
> I hadn't actually looked at the rest of the unpatched
> file.  If what you did is the same style, it's fine.
> 
> It just looked like you were trying to use kernel-doc
> formatting style but not using it quite correctly.
> 
> > > On Mon, 2013-07-22 at 14:41 -0700, Darren Hart wrote:
> > > > diff --git a/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_phy.c b/drivers/net/ethernet/oki-semi/pch_gbe/pch_gbe_phy.c
> > > > []
> > > > +/* pch_gbe_phy_tx_clk_delay - Setup TX clock delay via the PHY
> > > > + * @hw:	            Pointer to the HW structure
> > > > + * Returns
> > > > + *	0:		Successful.
> > > > + *	-EINVAL:	Invalid argument.
> > > > + */
> 
> This bit in what I believe kernel-doc style is would
> look like:
> 
> /**
>  * pch_gbe_phy_tx_clk_delay - Setup TX clock delay via the PHY
>  * @hw:		Pointer to the HW structure
>  *
>  * Return:	O: Successful
>  *		-EINVAL: Invalid argument
>  */

Right, but /**\n is discouraged? outlawed? on netdev. I'm not sure what
the kernel-doc policy would be for netdev... I think a follow-up patch
is in order for this driver that continues to fix a variety of
formatting, coding style, and api usage violations in addition to those
Andy already provided.

I'll resubmit with the fix David asked for to get this functionality in
and consider a clean-up as a follow-on.

Thanks again!

-- 
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel

  reply	other threads:[~2013-07-25  3:14 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-07-22 21:41 [PATCH V2 net-next 0/2] " Darren Hart
2013-07-22 21:41 ` [PATCH net-next 1/2] pch_gbe: Use PCH_GBE_PHY_REGS_LEN instead of 32 Darren Hart
2013-07-22 21:41 ` [PATCH V2 net-next 2/2] pch_gbe: Add MinnowBoard support Darren Hart
2013-07-25  0:00   ` David Miller
2013-07-25  0:20     ` Darren Hart
2013-07-25  0:29       ` David Miller
2013-07-25  0:41       ` Joe Perches
2013-07-25  2:58         ` Darren Hart
2013-07-25  3:08           ` Joe Perches
2013-07-25  3:14             ` Darren Hart [this message]
2013-07-25  3:31               ` [PATCH] checkpatch: Fix networking kernel-doc block comment defect Joe Perches
2013-07-25  3:16           ` [PATCH V2 net-next 2/2] pch_gbe: Add MinnowBoard support Joe Perches

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=1374722064.3436.252.camel@dvhart-mobl1.amr.corp.intel.com \
    --to=dvhart@linux.intel.com \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=davem@davemloft.net \
    --cc=hpa@zytor.com \
    --cc=joe@perches.com \
    --cc=netdev@vger.kernel.org \
    --cc=peter.p.waskiewicz.jr@intel.com \
    --subject='Re: [PATCH V2 net-next 2/2] pch_gbe: Add MinnowBoard support' \
    /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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).