netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jakub Kicinski <kuba@kernel.org>
To: davem@davemloft.net
Cc: netdev@vger.kernel.org, pabeni@redhat.com, corbet@lwn.net,
	bpf@vger.kernel.org, linux-doc@vger.kernel.org, andrew@lunn.ch,
	f.fainelli@gmail.com, Jakub Kicinski <kuba@kernel.org>
Subject: [PATCH net v2 11/14] docs: netdev: add missing back ticks
Date: Mon, 28 Mar 2022 22:08:27 -0700	[thread overview]
Message-ID: <20220329050830.2755213-12-kuba@kernel.org> (raw)
In-Reply-To: <20220329050830.2755213-1-kuba@kernel.org>

I think double back ticks are more correct. Add where they are missing.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index 1388f78cfbc5..294ad9b0162d 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -218,7 +218,7 @@ or the user space project is not reviewed on netdev include a link
 to a public repo where user space patches can be seen.
 
 In case user space tooling lives in a separate repository but is
-reviewed on netdev  (e.g. patches to `iproute2` tools) kernel and
+reviewed on netdev  (e.g. patches to ``iproute2`` tools) kernel and
 user space patches should form separate series (threads) when posted
 to the mailing list, e.g.::
 
@@ -251,18 +251,18 @@ traffic if we can help it.
 netdevsim is great, can I extend it for my out-of-tree tests?
 -------------------------------------------------------------
 
-No, `netdevsim` is a test vehicle solely for upstream tests.
-(Please add your tests under tools/testing/selftests/.)
+No, ``netdevsim`` is a test vehicle solely for upstream tests.
+(Please add your tests under ``tools/testing/selftests/``.)
 
-We also give no guarantees that `netdevsim` won't change in the future
+We also give no guarantees that ``netdevsim`` won't change in the future
 in a way which would break what would normally be considered uAPI.
 
 Is netdevsim considered a "user" of an API?
 -------------------------------------------
 
 Linux kernel has a long standing rule that no API should be added unless
-it has a real, in-tree user. Mock-ups and tests based on `netdevsim` are
-strongly encouraged when adding new APIs, but `netdevsim` in itself
+it has a real, in-tree user. Mock-ups and tests based on ``netdevsim`` are
+strongly encouraged when adding new APIs, but ``netdevsim`` in itself
 is **not** considered a use case/user.
 
 Any other tips to help ensure my net/net-next patch gets OK'd?
-- 
2.34.1


  parent reply	other threads:[~2022-03-29  5:09 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-29  5:08 [PATCH net v2 00/14] docs: update and move the netdev-FAQ Jakub Kicinski
2022-03-29  5:08 ` [PATCH net v2 01/14] docs: netdev: replace references to old archives Jakub Kicinski
2022-03-30  3:30   ` Florian Fainelli
2022-03-29  5:08 ` [PATCH net v2 02/14] docs: netdev: minor reword Jakub Kicinski
2022-03-30  3:30   ` Florian Fainelli
2022-03-29  5:08 ` [PATCH net v2 03/14] docs: netdev: move the patch marking section up Jakub Kicinski
2022-03-29 12:52   ` Andrew Lunn
2022-03-30  3:30   ` Florian Fainelli
2022-03-29  5:08 ` [PATCH net v2 04/14] docs: netdev: turn the net-next closed into a Warning Jakub Kicinski
2022-03-30  3:30   ` Florian Fainelli
2022-03-29  5:08 ` [PATCH net v2 05/14] docs: netdev: note that RFC postings are allowed any time Jakub Kicinski
2022-03-29 12:53   ` Andrew Lunn
2022-03-30  3:31   ` Florian Fainelli
2022-03-29  5:08 ` [PATCH net v2 06/14] docs: netdev: shorten the name and mention msgid for patch status Jakub Kicinski
2022-03-30  3:31   ` Florian Fainelli
2022-03-29  5:08 ` [PATCH net v2 07/14] docs: netdev: rephrase the 'Under review' question Jakub Kicinski
2022-03-30  3:33   ` Florian Fainelli
2022-03-30  4:17     ` Jakub Kicinski
2022-03-29  5:08 ` [PATCH net v2 08/14] docs: netdev: rephrase the 'should I update patchwork' question Jakub Kicinski
2022-03-29  5:08 ` [PATCH net v2 09/14] docs: netdev: add a question about re-posting frequency Jakub Kicinski
2022-03-30  3:33   ` Florian Fainelli
2022-03-29  5:08 ` [PATCH net v2 10/14] docs: netdev: make the testing requirement more stringent Jakub Kicinski
2022-03-30  3:34   ` Florian Fainelli
2022-03-29  5:08 ` Jakub Kicinski [this message]
2022-03-30  3:34   ` [PATCH net v2 11/14] docs: netdev: add missing back ticks Florian Fainelli
2022-03-29  5:08 ` [PATCH net v2 12/14] docs: netdev: call out the merge window in tag checking Jakub Kicinski
2022-03-30  3:34   ` Florian Fainelli
2022-03-29  5:08 ` [PATCH net v2 13/14] docs: netdev: broaden the new vs old code formatting guidelines Jakub Kicinski
2022-03-30  3:34   ` Florian Fainelli
2022-03-29  5:08 ` [PATCH net v2 14/14] docs: netdev: move the netdev-FAQ to the process pages Jakub Kicinski
2022-03-30  3:35   ` Florian Fainelli

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=20220329050830.2755213-12-kuba@kernel.org \
    --to=kuba@kernel.org \
    --cc=andrew@lunn.ch \
    --cc=bpf@vger.kernel.org \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=f.fainelli@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.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).