From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-1.1 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1B28AC433DF for ; Sun, 21 Jun 2020 23:02:44 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 7C5CD252E0 for ; Sun, 21 Jun 2020 23:02:43 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=protonmail.com header.i=@protonmail.com header.b="E1dwsrIc" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730824AbgFUXCm (ORCPT ); Sun, 21 Jun 2020 19:02:42 -0400 Received: from mail-40136.protonmail.ch ([185.70.40.136]:25464 "EHLO mail-40136.protonmail.ch" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726525AbgFUXCl (ORCPT ); Sun, 21 Jun 2020 19:02:41 -0400 Date: Sun, 21 Jun 2020 23:02:30 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail; t=1592780559; bh=d+6ukS/VLEXkmCnogukxLf8O85wjJsTS0BzKyBSGYrU=; h=Date:To:From:Cc:Reply-To:Subject:In-Reply-To:References:From; b=E1dwsrIcjPU2vMPZ6EaHbKhjOiKTRduoK3mC5gRCE15VDa2pvqQ8gkVYAG3QTE6iC rJxRKmPic4qMbjgAGVbS3dI/VO7GSYd0K4IrarotUYCBVD207UAflcjujUlhpAoAZO 4eqxfaHEXufMAycBL0/hizzRqvmAzynwJ59FwS/M= To: Andrew Lunn , Russell King - ARM Linux admin From: Colton Lewis Cc: davem@davemloft.net, netdev@vger.kernel.org Reply-To: Colton Lewis Subject: Re: FWD: [PATCH 3/3] net: phylink: correct trivial kernel-doc inconsistencies Message-ID: <3315816.iIbC2pHGDl@laptop.coltonlewis.name> In-Reply-To: <20200621155345.GV1551@shell.armlinux.org.uk> References: <20200621154248.GB338481@lunn.ch> <20200621155345.GV1551@shell.armlinux.org.uk> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org On Sunday, June 21, 2020 10:53:45 AM CDT Russell King - ARM Linux admin wro= te: > > --- > > */ > > struct phylink_config { > > =09struct device *dev; > > @@ -331,7 +333,7 @@ void pcs_get_state(struct phylink_config *config, > > * > > * For most 10GBASE-R, there is no advertisement. > > */ > > -int (*pcs_config)(struct phylink_config *config, unsigned int mode, > > +int *pcs_config(struct phylink_config *config, unsigned int mode, > > =09=09 phy_interface_t interface, const unsigned long *advertising); >=20 > *Definitely* a NAK on this and two changes below. You're changing the > function signature to be incorrect. If the documentation can't parse > a legitimate C function pointer declaration and allow it to be > documented, then that's a problem with the documentation's parsing of > C code, rather than a problem with the C code itself. I realize this changes the signature, but this declaration is not compiled.= It is under an #if 0 with a comment stating it exists for kernel-doc purpo= ses only. The *real* function pointer declaration exists in struct phylink_= pcs_ops. Given the declaration is there exclusively for documentation, it makes sens= e to change it so the documentation system can parse it.