From: Stefan Schmidt <stefan@datenfreihafen.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: "David S. Miller" <davem@davemloft.net>,
Alexander Aring <alex.aring@gmail.com>,
Jakub Kicinski <kuba@kernel.org>,
linux-kernel@vger.kernel.org, linux-wpan@vger.kernel.org,
netdev@vger.kernel.org
Subject: Re: [PATCH v5 25/52] docs: net: ieee802154.rst: fix C expressions
Date: Tue, 6 Oct 2020 16:13:37 +0200 [thread overview]
Message-ID: <ec4c5132-8b45-d2e7-b414-003000def8f8@datenfreihafen.org> (raw)
In-Reply-To: <6ba1d137516e4a144a4fd398934d62b94d31446d.1601992016.git.mchehab+huawei@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 <davem@davemloft.net>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> 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.
>
>
next prev parent reply other threads:[~2020-10-06 14:13 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1601992016.git.mchehab+huawei@kernel.org>
2020-10-06 14:03 ` [PATCH v5 25/52] docs: net: ieee802154.rst: fix C expressions Mauro Carvalho Chehab
2020-10-06 14:13 ` Stefan Schmidt [this message]
2020-10-06 14:14 ` Stefan Schmidt
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=ec4c5132-8b45-d2e7-b414-003000def8f8@datenfreihafen.org \
--to=stefan@datenfreihafen.org \
--cc=alex.aring@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-wpan@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=netdev@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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).