From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
"David S. Miller" <davem@davemloft.net>,
Jakub Kicinski <kuba@kernel.org>,
netdev@vger.kernel.org
Subject: [PATCH 18/38] docs: networking: convert driver.txt to ReST
Date: Tue, 28 Apr 2020 00:01:33 +0200 [thread overview]
Message-ID: <830fa106e7fa2584038838973e71fe63ff73cac7.1588024424.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1588024424.git.mchehab+huawei@kernel.org>
- add SPDX header;
- add a document title;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../networking/{driver.txt => driver.rst} | 22 +++++++++++--------
Documentation/networking/index.rst | 1 +
2 files changed, 14 insertions(+), 9 deletions(-)
rename Documentation/networking/{driver.txt => driver.rst} (85%)
diff --git a/Documentation/networking/driver.txt b/Documentation/networking/driver.rst
similarity index 85%
rename from Documentation/networking/driver.txt
rename to Documentation/networking/driver.rst
index da59e2884130..c8f59dbda46f 100644
--- a/Documentation/networking/driver.txt
+++ b/Documentation/networking/driver.rst
@@ -1,4 +1,8 @@
-Document about softnet driver issues
+.. SPDX-License-Identifier: GPL-2.0
+
+=====================
+Softnet Driver Issues
+=====================
Transmit path guidelines:
@@ -8,7 +12,7 @@ Transmit path guidelines:
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::
static netdev_tx_t drv_hard_start_xmit(struct sk_buff *skb,
struct net_device *dev)
@@ -38,25 +42,25 @@ Transmit path guidelines:
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::
if (netif_queue_stopped(dp->dev) &&
- TX_BUFFS_AVAIL(dp) > (MAX_SKB_FRAGS + 1))
+ 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::
/* This is a hard error log it. */
if (TX_BUFFS_AVAIL(dp) <= 0)
- and:
+ and::
if (TX_BUFFS_AVAIL(dp) == 0)
- and:
+ and::
if (netif_queue_stopped(dp->dev) &&
- TX_BUFFS_AVAIL(dp) > 0)
+ TX_BUFFS_AVAIL(dp) > 0)
netif_wake_queue(dp->dev);
2) An ndo_start_xmit method must not modify the shared parts of a
@@ -86,7 +90,7 @@ Close/stop guidelines:
1) After the ndo_stop routine has been called, the hardware must
not receive or transmit any data. All in flight packets must
- be aborted. If necessary, poll or wait for completion of
+ be aborted. If necessary, poll or wait for completion of
any reset commands.
2) The ndo_stop routine will be called by unregister_netdevice
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index 55746038a7e9..313f66900bce 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -53,6 +53,7 @@ Contents:
decnet
defza
dns_resolver
+ driver
.. only:: subproject and html
--
2.25.4
next prev parent reply other threads:[~2020-04-27 22:04 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-27 22:01 [PATCH 00/38] net: manually convert files to ReST format - part 1 Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 01/38] docs: networking: convert caif files to ReST Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 02/38] docs: networking: convert 6pack.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 03/38] docs: networking: convert altera_tse.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 04/38] docs: networking: convert arcnet-hardware.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 05/38] docs: networking: convert arcnet.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 06/38] docs: networking: convert atm.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 07/38] docs: networking: convert ax25.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 08/38] docs: networking: convert baycom.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 09/38] docs: networking: convert bonding.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 10/38] docs: networking: convert cdc_mbim.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 11/38] docs: networking: convert cops.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 12/38] docs: networking: convert cxacru.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 13/38] docs: networking: convert dccp.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 14/38] docs: networking: convert dctcp.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 15/38] docs: networking: convert decnet.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 16/38] docs: networking: convert defza.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 17/38] docs: networking: convert dns_resolver.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` Mauro Carvalho Chehab [this message]
2020-04-27 22:01 ` [PATCH 19/38] docs: networking: convert eql.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 20/38] docs: networking: convert fib_trie.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 21/38] docs: networking: convert filter.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 22/38] docs: networking: convert fore200e.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 23/38] docs: networking: convert framerelay.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 24/38] docs: networking: convert generic-hdlc.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 25/38] docs: networking: convert generic_netlink.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 26/38] docs: networking: convert gen_stats.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 27/38] docs: networking: convert gtp.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 28/38] docs: networking: convert hinic.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 29/38] docs: networking: convert ila.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 30/38] docs: networking: convert ipddp.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 31/38] docs: networking: convert ip_dynaddr.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 32/38] docs: networking: convert iphase.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 33/38] docs: networking: convert ipsec.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 34/38] docs: networking: convert ip-sysctl.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 35/38] docs: networking: convert ipv6.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 36/38] docs: networking: convert ipvlan.txt " Mauro Carvalho Chehab
2020-04-27 22:01 ` [PATCH 37/38] docs: networking: convert ipvs-sysctl.txt " Mauro Carvalho Chehab
2020-04-28 9:08 ` Simon Horman
2020-04-27 22:01 ` [PATCH 38/38] docs: networking: convert kcm.txt " Mauro Carvalho Chehab
2020-04-28 20:11 ` [PATCH 00/38] net: manually convert files to ReST format - part 1 David Miller
2020-04-28 20:15 ` Jonathan Corbet
2020-04-28 21:40 ` David Miller
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=830fa106e7fa2584038838973e71fe63ff73cac7.1588024424.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--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=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).