Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Tue, 23 Apr 2019 18:24:50 -0700
From:   Jakub Kicinski <jakub.kicinski@netronome.com>
To:     Tao Ren <taoren@fb.com>
Cc:     "David S . Miller" <davem@davemloft.net>,
        Maxim Mikityanskiy <maximmi@mellanox.com>,
        Bartosz Golaszewski <bgolaszewski@baylibre.com>,
        "netdev@vger.kernel.org" <netdev@vger.kernel.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "Samuel Mendoza-Jonas" <sam@mendozajonas.com>,
        Joel Stanley <joel@jms.id.au>,
        "Andrew Jeffery" <andrew@aj.id.au>,
        "openbmc@lists.ozlabs.org" <openbmc@lists.ozlabs.org>
Subject: Re: [PATCH net 1/2] net: add eth_addr_inc in etherdevice.h
Message-ID: <20190423182450.27b403d3@cakuba.netronome.com>
In-Reply-To: <2b3935f9-fbf9-6baa-570c-dcd6382518c4@fb.com>
References: <20190423224138.1295-1-taoren@fb.com>
        <20190423161502.5d3e9c36@cakuba.netronome.com>
        <2b3935f9-fbf9-6baa-570c-dcd6382518c4@fb.com>
Organization: Netronome Systems, Ltd.
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Wed, 24 Apr 2019 00:59:52 +0000, Tao Ren wrote:
> > Please see:  Documentation/doc-guide/kernel-doc.rst
> > 
> > Here we need:
> >  - "()" after function name;
> >  - no extra line between function name and argument description.  
> 
> Thank you for pointing it out (I didn't know the doc-guide). Given I copied the function comment from eth_addr_dec(), I will also fix the format for eth_addr_eth() then.
> 
> BTW, "()" is missing from all the other functions' comment in etherdevice.h, so maybe we should fix that in a separate patch?

Possibly, I'm just trying to make sure the new stuff we add follows the
official guidelines :)  For the old stuff we need to way it with
potential merge conflicts and muddied git history so the case is not as
clear cut.