linux-kernel - FYI: [PATCH net-next 2/2] docs: networking: Fix failover build warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <9bc6b8f18ee22d9e7aa053a1167a3830a4e8f401.camel@darmarit.de>
Date:   Fri, 13 Jul 2018 11:04:47 +0200
From:   Markus Heiser <markus.heiser@...marit.de>
To:     "Tobin C. Harding" <me@...in.cc>,
        "David S. Miller" <davem@...emloft.net>
Cc:     Sridhar Samudrala <sridhar.samudrala@...el.com>,
        linux-doc@...r.kernel.org, netdev@...r.kernel.org,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>
Subject: FYI: [PATCH net-next 2/2] docs: networking: Fix failover build
 warnings

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