openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: can.rst: fix a footnote reference 

As stated at:
	http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#footnotes

A footnote should contain either a number, a reference or
an auto number, e. g.:
        [1], [#f1] or [#].

While using [*] accidentaly works for html, it fails for other
document outputs. In particular, it causes an error with LaTeX
output, causing all books after networking to not be built.

So, replace it by a valid syntax.

Acked-by: Oliver Hartkopp <socketcan@hartkopp.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2018-05-06 12:00:11 -03:00
parent 4c5e8fc62d
commit b701745097
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/networking/can.rst
View File

@ -164,7 +164,7 @@ The Linux network devices (by default) just can handle the
transmission and reception of media dependent frames. Due to the transmission and reception of media dependent frames. Due to the
arbitration on the CAN bus the transmission of a low prio CAN-ID arbitration on the CAN bus the transmission of a low prio CAN-ID
may be delayed by the reception of a high prio CAN frame. To may be delayed by the reception of a high prio CAN frame. To
reflect the correct [*]_ traffic on the node the loopback of the sent reflect the correct [#f1]_ traffic on the node the loopback of the sent
data has to be performed right after a successful transmission. If data has to be performed right after a successful transmission. If
the CAN network interface is not capable of performing the loopback for the CAN network interface is not capable of performing the loopback for
some reason the SocketCAN core can do this task as a fallback solution. some reason the SocketCAN core can do this task as a fallback solution.
@ -175,7 +175,7 @@ networking behaviour for CAN applications. Due to some requests from
the RT-SocketCAN group the loopback optionally may be disabled for each the RT-SocketCAN group the loopback optionally may be disabled for each
separate socket. See sockopts from the CAN RAW sockets in :ref:`socketcan-raw-sockets`. separate socket. See sockopts from the CAN RAW sockets in :ref:`socketcan-raw-sockets`.
.. [*] you really like to have this when you're running analyser .. [#f1] you really like to have this when you're running analyser
tools like 'candump' or 'cansniffer' on the (same) node. tools like 'candump' or 'cansniffer' on the (same) node.