From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> To: Linux Doc Mailing List <linux-doc@vger.kernel.org> Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>, Mauro Carvalho Chehab <mchehab@infradead.org>, linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>, Oliver Hartkopp <socketcan@hartkopp.net>, Marc Kleine-Budde <mkl@pengutronix.de>, "David S. Miller" <davem@davemloft.net>, linux-can@vger.kernel.org, netdev@vger.kernel.org Subject: [PATCH v2 01/11] docs: can.rst: fix a footnote reference Date: Wed, 9 May 2018 10:18:44 -0300 [thread overview] Message-ID: <d2f616d096addfe5bc8d561831b832cb1fcbb397.1525870886.git.mchehab+samsung@kernel.org> (raw) In-Reply-To: <cover.1525870886.git.mchehab+samsung@kernel.org> In-Reply-To: <cover.1525870886.git.mchehab+samsung@kernel.org> 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> --- Documentation/networking/can.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/networking/can.rst b/Documentation/networking/can.rst index d23c51abf8c6..2fd0b51a8c52 100644 --- a/Documentation/networking/can.rst +++ b/Documentation/networking/can.rst @@ -164,7 +164,7 @@ The Linux network devices (by default) just can handle the transmission and reception of media dependent frames. Due to the 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 -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 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. @@ -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 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. -- 2.17.0
WARNING: multiple messages have this Message-ID (diff)
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> To: Linux Doc Mailing List <linux-doc@vger.kernel.org> Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>, Mauro Carvalho Chehab <mchehab@infradead.org>, linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>, Oliver Hartkopp <socketcan@hartkopp.net>, Marc Kleine-Budde <mkl@pengutronix.de>, "David S. Miller" <davem@davemloft.net>, linux-can@vger.kernel.org, netdev@vger.kernel.org Subject: [PATCH v2 01/11] docs: can.rst: fix a footnote reference Date: Wed, 9 May 2018 10:18:44 -0300 [thread overview] Message-ID: <d2f616d096addfe5bc8d561831b832cb1fcbb397.1525870886.git.mchehab+samsung@kernel.org> (raw) In-Reply-To: <cover.1525870886.git.mchehab+samsung@kernel.org> In-Reply-To: <cover.1525870886.git.mchehab+samsung@kernel.org> 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> --- Documentation/networking/can.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/networking/can.rst b/Documentation/networking/can.rst index d23c51abf8c6..2fd0b51a8c52 100644 --- a/Documentation/networking/can.rst +++ b/Documentation/networking/can.rst @@ -164,7 +164,7 @@ The Linux network devices (by default) just can handle the transmission and reception of media dependent frames. Due to the 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 -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 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. @@ -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 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. -- 2.17.0 -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
next prev parent reply other threads:[~2018-05-09 13:18 UTC|newest] Thread overview: 114+ messages / expand[flat|nested] mbox.gz Atom feed top 2018-05-09 13:18 [PATCH v2 00/11] Fix some doc build warnings/errors and broken links Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab [this message] 2018-05-09 13:18 ` [PATCH v2 01/11] docs: can.rst: fix a footnote reference Mauro Carvalho Chehab 2018-05-09 13:18 ` [PATCH v2 02/11] docs: admin-guide: add cgroup-v2 documentation Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-10 18:40 ` Tejun Heo 2018-05-10 18:40 ` Tejun Heo 2018-05-10 20:02 ` Jonathan Corbet 2018-05-10 20:02 ` Jonathan Corbet 2018-05-09 13:18 ` [PATCH v2 03/11] docs: crypto_engine.rst: Fix two parse warnings Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` [PATCH v2 04/11] docs: dell_rbu.txt: fix location of request_firmware Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 15:06 ` Mauro Carvalho Chehab 2018-05-09 15:06 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` [PATCH v2 05/11] docs: uio-howto.rst: use a code block to solve a warning Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` [PATCH v2 06/11] scripts/documentation-file-ref-check: rewrite it in perl with auto-fix mode Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` [PATCH v2 07/11] docs: ranoops.rst: fix location of ramoops.txt Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` [PATCH v2 08/11] docs: refcount-vs-atomic.rst: prefix url with https Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:43 ` Andrea Parri 2018-05-09 13:43 ` Andrea Parri 2018-05-09 14:40 ` Mauro Carvalho Chehab 2018-05-09 14:40 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` [PATCH v2 09/11] docs: Fix some broken references Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 17:15 ` Andrea Parri 2018-05-09 17:15 ` Andrea Parri 2018-05-09 17:15 ` Andrea Parri 2018-05-09 18:20 ` Mauro Carvalho Chehab 2018-05-09 18:20 ` Mauro Carvalho Chehab 2018-05-09 18:20 ` Mauro Carvalho Chehab 2018-05-09 19:11 ` Alan Stern 2018-05-09 19:11 ` Alan Stern 2018-05-09 19:11 ` Alan Stern 2018-05-09 19:41 ` Mauro Carvalho Chehab 2018-05-09 19:41 ` Mauro Carvalho Chehab 2018-05-09 19:41 ` Mauro Carvalho Chehab 2018-05-09 19:41 ` Mauro Carvalho Chehab 2018-05-09 21:27 ` Andrea Parri 2018-05-09 21:27 ` Andrea Parri 2018-05-09 21:27 ` Andrea Parri 2018-06-14 14:23 ` Mauro Carvalho Chehab 2018-06-14 14:23 ` Mauro Carvalho Chehab 2018-06-14 15:01 ` Andrea Parri 2018-06-14 15:01 ` Andrea Parri 2018-05-09 19:20 ` Andrea Parri 2018-05-09 19:20 ` Andrea Parri 2018-05-09 19:20 ` Andrea Parri 2018-05-09 18:20 ` Mauro Carvalho Chehab 2018-05-13 7:13 ` Takashi Iwai 2018-05-13 7:13 ` Takashi Iwai 2018-05-13 7:13 ` Takashi Iwai 2018-05-13 7:13 ` Takashi Iwai 2018-05-14 13:31 ` Masami Hiramatsu 2018-05-14 13:31 ` Masami Hiramatsu 2018-05-14 13:31 ` Masami Hiramatsu 2018-05-14 13:31 ` Masami Hiramatsu 2018-05-15 20:26 ` Stephen Boyd 2018-05-15 20:26 ` Stephen Boyd 2018-05-15 20:26 ` Stephen Boyd 2018-05-15 20:26 ` Stephen Boyd 2018-05-15 20:26 ` Stephen Boyd 2018-05-16 9:09 ` Charles Keepax 2018-05-16 9:09 ` Charles Keepax 2018-05-16 9:09 ` Charles Keepax 2018-05-16 15:12 ` Mathieu Poirier 2018-05-16 15:12 ` Mathieu Poirier 2018-05-16 15:12 ` Mathieu Poirier 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` [PATCH v2 10/11] arch/*: Kconfig: fix documentation for NMI watchdog Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` [PATCH v2 11/11] docs: fix broken references with multiple hints Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 13:18 ` [v2,11/11] " Mauro Carvalho Chehab 2018-05-09 13:18 ` [PATCH v2 11/11] " Mauro Carvalho Chehab 2018-05-09 13:18 ` Mauro Carvalho Chehab 2018-05-09 19:22 ` James Morris 2018-05-09 19:22 ` James Morris 2018-05-09 19:22 ` James Morris 2018-05-09 19:22 ` [v2,11/11] " James Morris 2018-05-09 19:22 ` [PATCH v2 11/11] " James Morris 2018-05-09 19:22 ` James Morris 2018-05-15 10:28 ` Bartlomiej Zolnierkiewicz 2018-05-15 10:28 ` Bartlomiej Zolnierkiewicz 2018-05-15 10:28 ` Bartlomiej Zolnierkiewicz 2018-05-15 10:28 ` [v2,11/11] " Bartlomiej Zolnierkiewicz 2018-05-15 10:28 ` [PATCH v2 11/11] " Bartlomiej Zolnierkiewicz 2018-05-15 10:28 ` Bartlomiej Zolnierkiewicz 2018-05-15 14:52 ` Steven Rostedt 2018-05-15 14:52 ` Steven Rostedt 2018-05-15 14:52 ` Steven Rostedt 2018-05-15 14:52 ` [v2,11/11] " Steven Rostedt 2018-05-15 14:52 ` [PATCH v2 11/11] " Steven Rostedt 2018-05-15 14:52 ` Steven Rostedt 2018-05-22 17:31 ` Rob Herring 2018-05-22 17:31 ` Rob Herring 2018-05-22 17:31 ` Rob Herring 2018-05-22 17:31 ` [v2,11/11] " Rob Herring 2018-05-22 17:31 ` [PATCH v2 11/11] " Rob Herring 2018-05-22 17:31 ` Rob Herring 2018-05-10 20:22 ` [PATCH v2 00/11] Fix some doc build warnings/errors and broken links Jonathan Corbet 2018-05-10 20:22 ` Jonathan Corbet 2018-05-10 21:28 ` Mauro Carvalho Chehab 2018-05-10 21:28 ` Mauro Carvalho Chehab
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=d2f616d096addfe5bc8d561831b832cb1fcbb397.1525870886.git.mchehab+samsung@kernel.org \ --to=mchehab+samsung@kernel.org \ --cc=corbet@lwn.net \ --cc=davem@davemloft.net \ --cc=linux-can@vger.kernel.org \ --cc=linux-doc@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=mchehab@infradead.org \ --cc=mkl@pengutronix.de \ --cc=netdev@vger.kernel.org \ --cc=socketcan@hartkopp.net \ /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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.