netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Robert Schwebel <r.schwebel@pengutronix.de>
Cc: "David S. Miller" <davem@davemloft.net>,
	netdev@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH 4/5] docs: networking: nfc: fix code block syntax
Date: Thu, 21 Nov 2019 10:09:19 -0700	[thread overview]
Message-ID: <20191121100919.1b483fab@lwn.net> (raw)
In-Reply-To: <20191121155503.52019-4-r.schwebel@pengutronix.de>

On Thu, 21 Nov 2019 16:55:02 +0100
Robert Schwebel <r.schwebel@pengutronix.de> wrote:

> Silence this warning:
> 
> Documentation/networking/nfc.rst:113: WARNING: Definition list ends without
> a blank line; unexpected unindent.
> 
> Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
> ---
>  Documentation/networking/nfc.txt | 14 ++++++++------
>  1 file changed, 8 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/networking/nfc.txt b/Documentation/networking/nfc.txt
> index af69b3a90eaa..63e483f6afb4 100644
> --- a/Documentation/networking/nfc.txt
> +++ b/Documentation/networking/nfc.txt
> @@ -105,12 +105,14 @@ LOW-LEVEL DATA EXCHANGE:
>  The userspace must use PF_NFC sockets to perform any data communication with
>  targets. All NFC sockets use AF_NFC:
>  
> -struct sockaddr_nfc {
> -       sa_family_t sa_family;
> -       __u32 dev_idx;
> -       __u32 target_idx;
> -       __u32 nfc_protocol;
> -};
> +.. code-block:: none
> +
> +        struct sockaddr_nfc {
> +               sa_family_t sa_family;
> +               __u32 dev_idx;
> +               __u32 target_idx;
> +               __u32 nfc_protocol;
> +        };

Rather than cluttering the text with ".. code-block::", you can just use
the literal-block shortcut:

	targets. All NFC sockets use AF_NFC::

	    struct sockaddr_nfc {

Thanks,

jon

>  
>  To establish a connection with one target, the user must create an
>  NFC_SOCKPROTO_RAW socket and call the 'connect' syscall with the sockaddr_nfc

  reply	other threads:[~2019-11-21 17:09 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-21 15:54 [PATCH 1/5] docs: networking: nfc: change headlines to sphinx syntax Robert Schwebel
2019-11-21 15:55 ` [PATCH 2/5] docs: networking: nfc: change block diagram " Robert Schwebel
2019-11-21 15:55 ` [PATCH 3/5] docs: networking: nfc: fix bullet list syntax Robert Schwebel
2019-11-21 15:55 ` [PATCH 4/5] docs: networking: nfc: fix code block syntax Robert Schwebel
2019-11-21 17:09   ` Jonathan Corbet [this message]
2019-11-22  7:01     ` Robert Schwebel
2019-11-21 15:55 ` [PATCH 5/5] docs: networking: nfc: change to rst format Robert Schwebel
2019-11-21 17:10   ` Jonathan Corbet
2019-11-22  7:04     ` Robert Schwebel
2019-11-21 23:06   ` David Miller
2019-11-22  7:06     ` Robert Schwebel

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=20191121100919.1b483fab@lwn.net \
    --to=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=r.schwebel@pengutronix.de \
    /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).