netdev - Re: [PATCH V2 net-next 2/2] pch_gbe: Add MinnowBoard support

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Wed, 24 Jul 2013 20:14:24 -0700
From:	Darren Hart <dvhart@...ux.intel.com>
To:	Joe Perches <joe@...ches.com>
Cc:	David Miller <davem@...emloft.net>, netdev@...r.kernel.org,
	hpa@...or.com, peter.p.waskiewicz.jr@...el.com,
	andriy.shevchenko@...ux.intel.com
Subject: Re: [PATCH V2 net-next 2/2] pch_gbe: Add MinnowBoard support

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


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