All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	"David S. Miller" <davem@davemloft.net>,
	Alexander Aring <alex.aring@gmail.com>,
	Jakub Kicinski <kuba@kernel.org>,
	Stefan Schmidt <stefan@datenfreihafen.org>,
	linux-kernel@vger.kernel.org, linux-wpan@vger.kernel.org,
	netdev@vger.kernel.org
Subject: [PATCH v5 25/52] docs: net: ieee802154.rst: fix C expressions
Date: Tue,  6 Oct 2020 16:03:22 +0200	[thread overview]
Message-ID: <6ba1d137516e4a144a4fd398934d62b94d31446d.1601992016.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1601992016.git.mchehab+huawei@kernel.org>

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.
 
-- 
2.26.2


  parent reply	other threads:[~2020-10-06 14:06 UTC|newest]

Thread overview: 69+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-06 14:02 [PATCH v5 00/52] Fix html build with Sphinx 3.1 and above Mauro Carvalho Chehab
2020-10-06 14:02 ` [PATCH v5 01/52] docs: cdomain.py: add support for a new Sphinx 3.1+ tag Mauro Carvalho Chehab
2020-10-06 14:02 ` [PATCH v5 02/52] docs: cdomain.py: extend it to handle new Sphinx 3.x tags Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 03/52] docs: conf.py: disable automarkup for Sphinx 3.x Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 04/52] scripts: kernel-doc: make it more compatible with " Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 05/52] scripts: kernel-doc: use a less pedantic markup for funcs on " Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 06/52] scripts: kernel-doc: fix troubles with line counts Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 07/52] scripts: kernel-doc: reimplement -nofunction argument Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 08/52] scripts: kernel-doc: fix typedef identification Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 09/52] scripts: kernel-doc: don't mangle with parameter list Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 10/52] scripts: kernel-doc: allow passing desired Sphinx C domain dialect Mauro Carvalho Chehab
2020-10-06 21:18   ` kernel test robot
2020-10-06 21:18     ` kernel test robot
2020-10-12 12:33   ` [PATCH v5.1 " Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 11/52] docs: kerneldoc.py: append the name of the parsed doc file Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 12/52] docs: kerneldoc.py: add support for kerneldoc -nosymbol Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 13/52] media: docs: make CEC documents compatible with Sphinx 3.1+ Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 14/52] media: docs: make V4L documents more " Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 15/52] media: docs: make DVB " Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 16/52] media: docs: make MC " Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 17/52] media: docs: make RC " Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 18/52] media: cec-core.rst: don't use c:type for structs Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 19/52] math64.h: kernel-docs: Convert some markups into normal comments Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 20/52] memblock: get rid of a :c:type leftover Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 21/52] docs: remove some replace macros like |struct foo| Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 22/52] docs: get rid of :c:type explicit declarations for structs Mauro Carvalho Chehab
2020-10-06 14:03   ` Mauro Carvalho Chehab
2020-10-06 16:41   ` Greg Kroah-Hartman
2020-10-06 16:41     ` Greg Kroah-Hartman
2020-10-06 14:03 ` [PATCH v5 23/52] docs: trace-uses.rst: remove bogus c-domain tags Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 24/52] docs: it_IT: fix namespace collisions at locking.rst Mauro Carvalho Chehab
2020-10-06 14:03 ` Mauro Carvalho Chehab [this message]
2020-10-06 14:13   ` [PATCH v5 25/52] docs: net: ieee802154.rst: fix C expressions Stefan Schmidt
2020-10-06 14:14   ` Stefan Schmidt
2020-10-06 14:03 ` [PATCH v5 26/52] docs: genericirq.rst: don't document chip.c functions twice Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 27/52] docs: kernel-api.rst: drop kernel/irq/manage.c kernel-doc tag Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 28/52] docs: remove sound API duplication Mauro Carvalho Chehab
2020-10-06 14:03   ` Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 29/52] docs: basics.rst: move kernel-doc workqueue markups to workqueue.rst Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 30/52] docs: scsi: target.rst: remove iSCSI transport class kernel-doc markup Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 31/52] docs: device_link.rst: remove duplicated kernel-doc include Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 32/52] docs: basics.rst: get rid of rcu kernel-doc macros Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 33/52] docs: net: statistics.rst: remove a duplicated kernel-doc Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 34/52] docs: pstore-blk.rst: fix kernel-doc tags Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 35/52] docs: fs: fscrypt.rst: get rid of :c:type: tags Mauro Carvalho Chehab
2020-10-06 19:19   ` Eric Biggers
2020-10-14  7:12     ` Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 36/52] docs: devices.rst: get rid of :c:type macros Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 37/52] docs: sound: writing-an-alsa-driver.rst: get rid of :c:type Mauro Carvalho Chehab
2020-10-06 14:03   ` Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 38/52] docs: block: blk-mq.rst: " Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 39/52] docs: writing-an-alsa-driver.rst: fix some bad c:func: markups Mauro Carvalho Chehab
2020-10-06 14:03   ` Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 40/52] docs: fpga: replace :c:member: macros Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 41/52] docs: kgdb.rst: fix :c:type: usages Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 42/52] docs: libata.rst: fix a wrong usage of :c:type: tag Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 43/52] docs: infrastructure.rst: don't include firmware kernel-doc Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 44/52] docs: gpu: i915.rst: Fix several C duplication warnings Mauro Carvalho Chehab
2020-10-06 14:03   ` [Intel-gfx] " Mauro Carvalho Chehab
2020-10-06 14:03   ` Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 45/52] docs: devices.rst: fix a C reference markup Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 46/52] docs: it_IT: hacking.rst: fix a typo on a markup Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 47/52] docs: mei.rst: fix a C expression markup Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 48/52] docs: basics.rst: avoid duplicated C function declaration Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 49/52] workqueue: fix a kernel-doc warning Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 50/52] scripts: kernel-doc: try to use c:function if possible Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 51/52] docs: conf.py: fix c:function support with Sphinx 3.x Mauro Carvalho Chehab
2020-10-06 14:03 ` [PATCH v5 52/52] docs: conf.py: change the Sphinx 3.x+ text Mauro Carvalho Chehab
2020-10-06 16:56 ` [PATCH v5 00/52] Fix html build with Sphinx 3.1 and above Joe Perches

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=6ba1d137516e4a144a4fd398934d62b94d31446d.1601992016.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.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=netdev@vger.kernel.org \
    --cc=stefan@datenfreihafen.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.