DriverDev-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: Aditya Jain <aditya.jainadityajain.jain@gmail.com>
To: Joe Perches <joe@perches.com>
Cc: devel@driverdev.osuosl.org, Greg KH <gregkh@linuxfoundation.org>,
	Larry Finger <Larry.Finger@lwfinger.net>,
	linux-kernel@vger.kernel.org, hdegoede@redhat.com
Subject: Re: [PATCH v3 3/4] staging: rtl8723bs: include: Further clean up function declarations
Date: Wed, 29 Jul 2020 01:33:01 +0530
Message-ID: <CAJAoDUhcXmmVs1f30bcMrvLoAjoaM+UnFHqueQUqLWAy88bNdA@mail.gmail.com> (raw)
In-Reply-To: <CAJAoDUjRZTxcOJGs2wqPPYyVCYJJTs1NWtmD0+yMXLttgCCQyA@mail.gmail.com>

On Sun, Jul 26, 2020 at 11:45 PM Aditya Jain
<aditya.jainadityajain.jain@gmail.com> wrote:
>
> On Sun, Jul 26, 2020 at 10:45 PM Joe Perches <joe@perches.com> wrote:
> >
> > On Sun, 2020-07-26 at 17:02 +0200, Greg KH wrote:
> > > On Sun, Jul 26, 2020 at 07:50:12PM +0530, Aditya Jain wrote:
> > > > Cleaning up messy multiline function declarations in hal_phy_cfg.h
> > []
> > > > diff --git a/drivers/staging/rtl8723bs/include/hal_phy_cfg.h b/drivers/staging/rtl8723bs/include/hal_phy_cfg.h
> > []
> Ok, I'll merge this patch with the previous one. Had separated the two
> to make the diffs smaller thinking they'll
> be easier to review. But yeah, I get the point.
> > > > -void
> > > > -PHY_SetSwChnlBWMode8723B(
> > > > -struct adapter *Adapter,
> > > > -u8                         channel,
> > > > -enum CHANNEL_WIDTH         Bandwidth,
> > > > -u8                         Offset40,
> > > > -u8                         Offset80
> > > > +void PHY_SetBWMode8723B(struct adapter *Adapter,
> > > > +                   enum CHANNEL_WIDTH Bandwidth,   /*  20M or 40M */
> > > > +                   unsigned char Offset    /*  Upper, Lower, or Don't care */
> > >
> > > Those comments should go at the top of the function declaration, in
> > > kernel doc format.
> >
> > Not every external function needs kernel-doc.
> >
> > This is a realtek staging driver that likely it will never be
> > moved out of staging.
> >
> >
> Should I just remove the comments then? Sorry, but I'm a newbie, and
> not really sure what the function is or supposed to do.
> I can try looking it up if kernel-doc is required here.
Hi all,

Any directions on how I should continue?
>
> Regards,
> Aditya Jain

Thanks and Regards,
Aditya Jain
_______________________________________________
devel mailing list
devel@linuxdriverproject.org
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel

  reply index

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-26  8:02 [PATCH] staging: rtl8723bs: include: Fix coding style errors Aditya Jain
2020-07-26  8:26 ` Greg KH
2020-07-26  8:40   ` Aditya Jain
2020-07-26 10:53     ` [PATCH v2] staging: rtl8723bs: include: Fix coding style issues Aditya Jain
2020-07-26 10:59       ` Greg KH
2020-07-26 14:18     ` Fix code style issues in staging Aditya Jain
2020-07-26 14:20       ` [PATCH v3 1/4] staging: rtl8723bs: include: Fix coding style errors Aditya Jain
2020-07-26 14:20         ` [PATCH v3 2/4] staging: rtl8723bs: include: Clean up function declations Aditya Jain
2020-07-26 14:20         ` [PATCH v3 3/4] staging: rtl8723bs: include: Further clean up function declarations Aditya Jain
2020-07-26 15:02           ` Greg KH
2020-07-26 17:15             ` Joe Perches
2020-07-26 18:15               ` Aditya Jain
2020-07-28 20:03                 ` Aditya Jain [this message]
2020-07-26 14:20         ` [PATCH v3 4/4] staging: rtl8723bs: include: Align macro definitions Aditya Jain
2020-07-26 18:03     ` [PATCH] staging: rtl8723bs: include: Fix coding style errors Larry Finger
2020-07-26 18:29       ` Aditya Jain
2020-07-29 19:21     ` [PATCH v4 0/3] Fix coding style issues in staging Aditya Jain
2020-07-29 19:21       ` [PATCH v4 1/3] staging: rtl8723bs: Fix coding style errors Aditya Jain
2020-07-29 19:21       ` [PATCH v4 2/3] staging: rtl8723bs: Clean up function declations Aditya Jain
2020-07-29 19:21       ` [PATCH v4 3/3] staging: rtl8723bs: Align macro definitions Aditya Jain

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=CAJAoDUhcXmmVs1f30bcMrvLoAjoaM+UnFHqueQUqLWAy88bNdA@mail.gmail.com \
    --to=aditya.jainadityajain.jain@gmail.com \
    --cc=Larry.Finger@lwfinger.net \
    --cc=devel@driverdev.osuosl.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=hdegoede@redhat.com \
    --cc=joe@perches.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

DriverDev-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/driverdev-devel/0 driverdev-devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 driverdev-devel driverdev-devel/ https://lore.kernel.org/driverdev-devel \
		driverdev-devel@linuxdriverproject.org devel@driverdev.osuosl.org
	public-inbox-index driverdev-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.linuxdriverproject.driverdev-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git