Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

+2 -2
+2 -2
Documentation/networking/can.rst
··· 164 164 transmission and reception of media dependent frames. Due to the 165 165 arbitration on the CAN bus the transmission of a low prio CAN-ID 166 166 may be delayed by the reception of a high prio CAN frame. To 167 - reflect the correct [*]_ traffic on the node the loopback of the sent 167 + reflect the correct [#f1]_ traffic on the node the loopback of the sent 168 168 data has to be performed right after a successful transmission. If 169 169 the CAN network interface is not capable of performing the loopback for 170 170 some reason the SocketCAN core can do this task as a fallback solution. ··· 175 175 the RT-SocketCAN group the loopback optionally may be disabled for each 176 176 separate socket. See sockopts from the CAN RAW sockets in :ref:`socketcan-raw-sockets`. 177 177 178 - .. [*] you really like to have this when you're running analyser 178 + .. [#f1] you really like to have this when you're running analyser 179 179 tools like 'candump' or 'cansniffer' on the (same) node. 180 180 181 181