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=-11.3 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,NICE_REPLY_A, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=unavailable 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 7F3D0C4727E for ; Tue, 6 Oct 2020 14:21:03 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 3CA1C20789 for ; Tue, 6 Oct 2020 14:21:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726319AbgJFOVB (ORCPT ); Tue, 6 Oct 2020 10:21:01 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34304 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726032AbgJFOVA (ORCPT ); Tue, 6 Oct 2020 10:21:00 -0400 X-Greylist: delayed 440 seconds by postgrey-1.37 at lindbergh.monkeyblade.net; Tue, 06 Oct 2020 07:21:00 PDT Received: from proxima.lasnet.de (proxima.lasnet.de [IPv6:2a01:4f8:121:31eb:3::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 51D4FC061755; Tue, 6 Oct 2020 07:21:00 -0700 (PDT) Received: from localhost.localdomain (p200300e9d72c3c4353f06c511a49ff67.dip0.t-ipconnect.de [IPv6:2003:e9:d72c:3c43:53f0:6c51:1a49:ff67]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: stefan@datenfreihafen.org) by proxima.lasnet.de (Postfix) with ESMTPSA id C1285C3D16; Tue, 6 Oct 2020 16:13:37 +0200 (CEST) Subject: Re: [PATCH v5 25/52] docs: net: ieee802154.rst: fix C expressions To: Mauro Carvalho Chehab , Linux Doc Mailing List , Jonathan Corbet Cc: "David S. Miller" , Alexander Aring , Jakub Kicinski , linux-kernel@vger.kernel.org, linux-wpan@vger.kernel.org, netdev@vger.kernel.org References: <6ba1d137516e4a144a4fd398934d62b94d31446d.1601992016.git.mchehab+huawei@kernel.org> From: Stefan Schmidt Message-ID: Date: Tue, 6 Oct 2020 16:13:37 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.11.0 MIME-Version: 1.0 In-Reply-To: <6ba1d137516e4a144a4fd398934d62b94d31446d.1601992016.git.mchehab+huawei@kernel.org> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 06.10.20 16:03, Mauro Carvalho Chehab wrote: > There are some warnings produced with Sphinx 3.x: > > Documentation/networking/ieee802154.rst:29: WARNING: Error in declarator or parameters > Invalid C declaration: Expecting "(" in parameters. [error at 7] > int sd = socket(PF_IEEE802154, SOCK_DGRAM, 0); > -------^ > Documentation/networking/ieee802154.rst:134: WARNING: Invalid C declaration: Expected end of definition. [error at 81] > void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb, u8 lqi): > ---------------------------------------------------------------------------------^ > Documentation/networking/ieee802154.rst:139: WARNING: Invalid C declaration: Expected end of definition. [error at 95] > void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb, bool ifs_handling): > -----------------------------------------------------------------------------------------------^ > Documentation/networking/ieee802154.rst:158: WARNING: Invalid C declaration: Expected end of definition. [error at 35] > int start(struct ieee802154_hw *hw): > -----------------------------------^ > Documentation/networking/ieee802154.rst:162: WARNING: Invalid C declaration: Expected end of definition. [error at 35] > void stop(struct ieee802154_hw *hw): > -----------------------------------^ > Documentation/networking/ieee802154.rst:166: WARNING: Invalid C declaration: Expected end of definition. [error at 61] > int xmit_async(struct ieee802154_hw *hw, struct sk_buff *skb): > -------------------------------------------------------------^ > Documentation/networking/ieee802154.rst:171: WARNING: Invalid C declaration: Expected end of definition. [error at 43] > int ed(struct ieee802154_hw *hw, u8 *level): > -------------------------------------------^ > Documentation/networking/ieee802154.rst:176: WARNING: Invalid C declaration: Expected end of definition. [error at 62] > int set_channel(struct ieee802154_hw *hw, u8 page, u8 channel): > --------------------------------------------------------------^ > > Caused by some bad c:function: prototypes. Fix them. > > Acked-by: David S. Miller > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/networking/ieee802154.rst | 18 ++++++++++-------- > 1 file changed, 10 insertions(+), 8 deletions(-) > > diff --git a/Documentation/networking/ieee802154.rst b/Documentation/networking/ieee802154.rst > index 6f4bf8447a21..f27856d77c8b 100644 > --- a/Documentation/networking/ieee802154.rst > +++ b/Documentation/networking/ieee802154.rst > @@ -26,7 +26,9 @@ The stack is composed of three main parts: > Socket API > ========== > > -.. c:function:: int sd = socket(PF_IEEE802154, SOCK_DGRAM, 0); > +:: > + > + int sd = socket(PF_IEEE802154, SOCK_DGRAM, 0); > > The address family, socket addresses etc. are defined in the > include/net/af_ieee802154.h header or in the special header > @@ -131,12 +133,12 @@ Register PHY in the system. > > Freeing registered PHY. > > -.. c:function:: void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb, u8 lqi): > +.. c:function:: void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb, u8 lqi) > > Telling 802.15.4 module there is a new received frame in the skb with > the RF Link Quality Indicator (LQI) from the hardware device. > > -.. c:function:: void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb, bool ifs_handling): > +.. c:function:: void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb, bool ifs_handling) > > Telling 802.15.4 module the frame in the skb is or going to be > transmitted through the hardware device > @@ -155,25 +157,25 @@ operations structure at least:: > ... > }; > > -.. c:function:: int start(struct ieee802154_hw *hw): > +.. c:function:: int start(struct ieee802154_hw *hw) > > Handler that 802.15.4 module calls for the hardware device initialization. > > -.. c:function:: void stop(struct ieee802154_hw *hw): > +.. c:function:: void stop(struct ieee802154_hw *hw) > > Handler that 802.15.4 module calls for the hardware device cleanup. > > -.. c:function:: int xmit_async(struct ieee802154_hw *hw, struct sk_buff *skb): > +.. c:function:: int xmit_async(struct ieee802154_hw *hw, struct sk_buff *skb) > > Handler that 802.15.4 module calls for each frame in the skb going to be > transmitted through the hardware device. > > -.. c:function:: int ed(struct ieee802154_hw *hw, u8 *level): > +.. c:function:: int ed(struct ieee802154_hw *hw, u8 *level) > > Handler that 802.15.4 module calls for Energy Detection from the hardware > device. > > -.. c:function:: int set_channel(struct ieee802154_hw *hw, u8 page, u8 channel): > +.. c:function:: int set_channel(struct ieee802154_hw *hw, u8 page, u8 channel) > > Set radio for listening on specific channel of the hardware device. > >