| Message ID | 20191121155503.52019-4-r.schwebel@pengutronix.de |
|---|---|
| State | Changes Requested |
| Delegated to: | David Miller |
| Headers | show |
| Series | [1/5] docs: networking: nfc: change headlines to sphinx syntax | expand |
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
On Thu, Nov 21, 2019 at 10:09:19AM -0700, Jonathan Corbet wrote: > > +.. 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, will do in v2. rsc
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; + }; 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
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(-)