From: Jakub Kicinski <kuba@kernel.org>
To: davem@davemloft.net
Cc: netdev@vger.kernel.org, edumazet@google.com, pabeni@redhat.com,
herbert@gondor.apana.org.au, alexander.duyck@gmail.com,
hkallweit1@gmail.com, andrew@lunn.ch, willemb@google.com,
Jakub Kicinski <kuba@kernel.org>
Subject: [PATCH net-next v4 3/7] docs: net: use C syntax highlight in driver.rst
Date: Thu, 6 Apr 2023 18:25:32 -0700 [thread overview]
Message-ID: <20230407012536.273382-4-kuba@kernel.org> (raw)
In-Reply-To: <20230407012536.273382-1-kuba@kernel.org>
Use syntax highlight, comment out the "..." since they are
not valid C.
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
Documentation/networking/driver.rst | 30 +++++++++++++++++++----------
1 file changed, 20 insertions(+), 10 deletions(-)
diff --git a/Documentation/networking/driver.rst b/Documentation/networking/driver.rst
index bfbd66871bb3..19c363291d04 100644
--- a/Documentation/networking/driver.rst
+++ b/Documentation/networking/driver.rst
@@ -43,7 +43,9 @@ there is no way your device can tell ahead of time when its
transmit function will become busy.
Instead it must maintain the queue properly. For example,
-for a driver implementing scatter-gather this means::
+for a driver implementing scatter-gather this means:
+
+.. code-block:: c
static netdev_tx_t drv_hard_start_xmit(struct sk_buff *skb,
struct net_device *dev)
@@ -51,7 +53,7 @@ Instead it must maintain the queue properly. For example,
struct drv *dp = netdev_priv(dev);
lock_tx(dp);
- ...
+ //...
/* This is a hard error log it. */
if (TX_BUFFS_AVAIL(dp) <= (skb_shinfo(skb)->nr_frags + 1)) {
netif_stop_queue(dev);
@@ -61,34 +63,42 @@ Instead it must maintain the queue properly. For example,
return NETDEV_TX_BUSY;
}
- ... queue packet to card ...
- ... update tx consumer index ...
+ //... queue packet to card ...
+ //... update tx consumer index ...
if (TX_BUFFS_AVAIL(dp) <= (MAX_SKB_FRAGS + 1))
netif_stop_queue(dev);
- ...
+ //...
unlock_tx(dp);
- ...
+ //...
return NETDEV_TX_OK;
}
-And then at the end of your TX reclamation event handling::
+And then at the end of your TX reclamation event handling:
+
+.. code-block:: c
if (netif_queue_stopped(dp->dev) &&
TX_BUFFS_AVAIL(dp) > (MAX_SKB_FRAGS + 1))
netif_wake_queue(dp->dev);
-For a non-scatter-gather supporting card, the three tests simply become::
+For a non-scatter-gather supporting card, the three tests simply become:
+
+.. code-block:: c
/* This is a hard error log it. */
if (TX_BUFFS_AVAIL(dp) <= 0)
-and::
+and:
+
+.. code-block:: c
if (TX_BUFFS_AVAIL(dp) == 0)
-and::
+and:
+
+.. code-block:: c
if (netif_queue_stopped(dp->dev) &&
TX_BUFFS_AVAIL(dp) > 0)
--
2.39.2
next prev parent reply other threads:[~2023-04-07 1:25 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-07 1:25 [PATCH net-next v4 0/7] net: lockless stop/wake combo macros Jakub Kicinski
2023-04-07 1:25 ` [PATCH net-next v4 1/7] docs: net: reformat driver.rst from a list to sections Jakub Kicinski
2023-04-07 1:25 ` [PATCH net-next v4 2/7] docs: net: move the probe and open/close sections of driver.rst up Jakub Kicinski
2023-04-07 1:25 ` Jakub Kicinski [this message]
2023-04-07 1:25 ` [PATCH net-next v4 4/7] net: provide macros for commonly copied lockless queue stop/wake code Jakub Kicinski
2023-04-07 1:25 ` [PATCH net-next v4 5/7] ixgbe: use new queue try_stop/try_wake macros Jakub Kicinski
2023-04-07 1:25 ` [PATCH net-next v4 6/7] bnxt: " Jakub Kicinski
2023-04-07 9:25 ` Eric Dumazet
2023-04-07 14:36 ` Jakub Kicinski
2023-04-07 1:25 ` [PATCH net-next v4 7/7] net: piggy back on the memory barrier in bql when waking queues Jakub Kicinski
2023-04-11 1:30 ` [PATCH net-next v4 0/7] net: lockless stop/wake combo macros patchwork-bot+netdevbpf
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=20230407012536.273382-4-kuba@kernel.org \
--to=kuba@kernel.org \
--cc=alexander.duyck@gmail.com \
--cc=andrew@lunn.ch \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=herbert@gondor.apana.org.au \
--cc=hkallweit1@gmail.com \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=willemb@google.com \
/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).