From patchwork Fri Sep 25 10:56:56 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Russell King - ARM Linux X-Patchwork-Id: 522719 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming@ozlabs.org Delivered-To: patchwork-incoming@ozlabs.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id F1F1B140783 for ; Fri, 25 Sep 2015 20:57:14 +1000 (AEST) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=arm.linux.org.uk header.i=@arm.linux.org.uk header.b=GyOOKa3q; dkim-atps=neutral Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753987AbbIYK5J (ORCPT ); Fri, 25 Sep 2015 06:57:09 -0400 Received: from pandora.arm.linux.org.uk ([78.32.30.218]:46564 "EHLO pandora.arm.linux.org.uk" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753164AbbIYK5I (ORCPT ); Fri, 25 Sep 2015 06:57:08 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=arm.linux.org.uk; s=pandora-2014; h=Sender:In-Reply-To:Content-Type:MIME-Version:References:Message-ID:Subject:Cc:To:From:Date; bh=4LXKBpGn1b9UGKvB3CzcZwigI+YFj6IGl2GPg9kd1Ts=; b=GyOOKa3qBppvd+HOlw6ph8mH3azh79pGhT9RPs4M6HT9UiYk79ZNaUIOUUWO5AYH6r+ZoWrBEOlRS5mten0vycvxoF+qW/6oS0wi0weNnZELWe2pwQIUpl8A29edRuT34bSl4ua7Ni2L30CLcuMG8UpBUxib9rH9pvuW+EYFbN4=; Received: from n2100.arm.linux.org.uk ([fd8f:7570:feb6:1:214:fdff:fe10:4f86]:51493) by pandora.arm.linux.org.uk with esmtpsa (TLSv1:DHE-RSA-AES256-SHA:256) (Exim 4.82_1-5b7a7c0-XX) (envelope-from ) id 1ZfQgW-0008Af-1c; Fri, 25 Sep 2015 11:57:00 +0100 Received: from linux by n2100.arm.linux.org.uk with local (Exim 4.76) (envelope-from ) id 1ZfQgS-00025L-Uf; Fri, 25 Sep 2015 11:56:57 +0100 Date: Fri, 25 Sep 2015 11:56:56 +0100 From: Russell King - ARM Linux To: kbuild test robot , David Miller Cc: kbuild-all@01.org, netdev@vger.kernel.org Subject: Re: [net:master 114/121] drivers/net/phy/mdio_bus.c:248: warning: No description found for parameter 'owner' Message-ID: <20150925105656.GK21513@n2100.arm.linux.org.uk> References: <201509251554.GLQ5oOz9%fengguang.wu@intel.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <201509251554.GLQ5oOz9%fengguang.wu@intel.com> User-Agent: Mutt/1.5.23 (2014-03-12) Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org On Fri, Sep 25, 2015 at 03:58:00PM +0800, kbuild test robot wrote: > tree: https://git.kernel.org/pub/scm/linux/kernel/git/davem/net.git master > head: b626ef0128d254d33ee43c51d68f577bbec370ac > commit: 3e3aaf649416988ca8be4ad2c52dc24d8be7b46e [114/121] phy: fix mdiobus module safety > config: i386-allnoconfig (attached as .config) > reproduce: > git checkout 3e3aaf649416988ca8be4ad2c52dc24d8be7b46e > # save the attached .config to linux build tree > make ARCH=i386 > > All warnings (new ones prefixed by >>): > > >> drivers/net/phy/mdio_bus.c:248: warning: No description found for parameter 'owner' > >> drivers/net/phy/mdio_bus.c:248: warning: No description found for parameter 'owner' We could fix this new warning like this, but I'm not particularly happy because it means we're documenting internals as an API, which it isn't. IMHO, the original doc is correct - we're documenting mdiobus_register() here, which is the preferred API which should be used everywhere, rather than __mdiobus_register() which is the implementation detail. I guess docbook can't know that though. So, is this something that should be fixed like the below? 8<=== From: Russell King Subject: [PATCH] net: update docbook comment for __mdiobus_register() Update the docbook comment for __mdiobus_register() to include the new module owner argument. This resolves a warning found by the 0-day builder. Signed-off-by: Russell King --- drivers/net/phy/mdio_bus.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/drivers/net/phy/mdio_bus.c b/drivers/net/phy/mdio_bus.c index c340e412b38f..12f44c53cc8e 100644 --- a/drivers/net/phy/mdio_bus.c +++ b/drivers/net/phy/mdio_bus.c @@ -236,11 +236,14 @@ static inline void of_mdiobus_link_phydev(struct mii_bus *mdio, #endif /** - * mdiobus_register - bring up all the PHYs on a given bus and attach them to bus + * __mdiobus_register - bring up all the PHYs on a given bus and attach them to bus * @bus: target mii_bus + * @owner: module containing bus accessor functions * * Description: Called by a bus driver to bring up all the PHYs - * on a given bus, and attach them to the bus. + * on a given bus, and attach them to the bus. Drivers should use + * mdiobus_register() rather than __mdiobus_register() unless they + * need to pass a specific owner module. * * Returns 0 on success or < 0 on error. */