From: Markus Heiser <markus.heiser@darmarit.de>
To: "Tobin C. Harding" <me@tobin.cc>,
"David S. Miller" <davem@davemloft.net>
Cc: Sridhar Samudrala <sridhar.samudrala@intel.com>,
linux-doc@vger.kernel.org, netdev@vger.kernel.org,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: FYI: [PATCH net-next 2/2] docs: networking: Fix failover build warnings
Date: Fri, 13 Jul 2018 11:04:47 +0200 [thread overview]
Message-ID: <9bc6b8f18ee22d9e7aa053a1167a3830a4e8f401.camel@darmarit.de> (raw)
In-Reply-To: <20180711214250.19039-3-me@tobin.cc>
Hy Tobin,
> Add '::' before code snippets and indent all snippets uniformly starting
> with 2 spaces.
Just FYI about reST Markup (no need to fix anything in your patch).
You can also add '::' (the markup for literal blocks) at the last line of the
previous paragraph, e.g:
<snip>---
Booting a VM with the above configuration will result in the following 3
netdevs created in the VM.::
4: ens10: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP
group default qlen 1000
link/ether 52:54:00:00:12:53 brd ff:ff:ff:ff:ff:ff
<snap>---
IMO its more readable in plain text. Anyway it is not wrong to add '::' in a
separated new line ... and thanks for your patch.
If you have any doubt about reST markup, I recommend the primer from the Sphinx
project:
http://www.sphinx-doc.org/en/stable/rest.html
and the quickref from the (underlying) docutils project:
http://docutils.sourceforge.net/docs/user/rst/quickref.html
-- Markus --
next prev parent reply other threads:[~2018-07-13 9:11 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-11 21:42 [PATCH net-next 0/2] docs: Fix failover build warnings Tobin C. Harding
2018-07-11 21:42 ` [PATCH net-next 1/2] docs: networking: Add failover docs to index Tobin C. Harding
2018-07-11 21:42 ` [PATCH net-next 2/2] docs: networking: Fix failover build warnings Tobin C. Harding
2018-07-13 9:04 ` Markus Heiser [this message]
2018-07-16 18:28 ` [PATCH net-next 0/2] docs: " 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=9bc6b8f18ee22d9e7aa053a1167a3830a4e8f401.camel@darmarit.de \
--to=markus.heiser@darmarit.de \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=me@tobin.cc \
--cc=netdev@vger.kernel.org \
--cc=sridhar.samudrala@intel.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).