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 01/18] docs: can.rst: fix a footnote reference Date: Mon, 7 May 2018 06:35:37 -0300 [thread overview] Message-ID: <2a04ab24f302a0802572c4c80c4d416b953f213d.1525684985.git.mchehab+samsung@kernel.org> (raw) In-Reply-To: <cover.1525684985.git.mchehab+samsung@kernel.org> In-Reply-To: <cover.1525684985.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. 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 01/18] docs: can.rst: fix a footnote reference Date: Mon, 7 May 2018 06:35:37 -0300 [thread overview] Message-ID: <2a04ab24f302a0802572c4c80c4d416b953f213d.1525684985.git.mchehab+samsung@kernel.org> (raw) In-Reply-To: <cover.1525684985.git.mchehab+samsung@kernel.org> In-Reply-To: <cover.1525684985.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. 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-07 9:35 UTC|newest] Thread overview: 184+ messages / expand[flat|nested] mbox.gz Atom feed top 2018-05-07 9:35 [PATCH 00/18] Fix some build warnings/errors with Sphinx Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab [this message] 2018-05-07 9:35 ` [PATCH 01/18] docs: can.rst: fix a footnote reference Mauro Carvalho Chehab 2018-05-07 18:41 ` Oliver Hartkopp 2018-05-07 18:41 ` Oliver Hartkopp 2018-05-07 9:35 ` [PATCH 02/18] docs: fix location of request_firmware & friends Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-08 3:07 ` Greg Kroah-Hartman 2018-05-08 3:07 ` Greg Kroah-Hartman 2018-05-08 15:49 ` Luis R. Rodriguez 2018-05-08 15:49 ` Luis R. Rodriguez 2018-05-09 12:26 ` Mauro Carvalho Chehab 2018-05-09 12:26 ` Mauro Carvalho Chehab 2018-05-07 9:35 ` [PATCH 03/18] docs: */index.rst: Add newer documents to their respective index.rst Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-08 3:07 ` Greg Kroah-Hartman 2018-05-08 3:07 ` Greg Kroah-Hartman 2018-05-08 15:59 ` Jonathan Corbet 2018-05-08 15:59 ` Jonathan Corbet 2018-05-07 9:35 ` [PATCH 04/18] docs: admin-guide: add bcache documentation Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-08 16:01 ` Jonathan Corbet 2018-05-08 16:01 ` Jonathan Corbet 2018-05-07 9:35 ` [PATCH 05/18] docs: core-api: add cachetlb documentation Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 12:29 ` Andrea Parri 2018-05-07 12:29 ` Andrea Parri 2018-05-08 14:40 ` Jani Nikula 2018-05-08 14:40 ` Jani Nikula 2018-05-08 16:02 ` Andrea Parri 2018-05-08 16:02 ` Andrea Parri 2018-05-08 16:28 ` Andrea Parri 2018-05-08 16:28 ` Andrea Parri 2018-05-08 18:05 ` Mauro Carvalho Chehab 2018-05-08 18:05 ` Mauro Carvalho Chehab 2018-05-08 18:28 ` Mauro Carvalho Chehab 2018-05-08 18:28 ` Mauro Carvalho Chehab 2018-05-08 19:05 ` Andrea Parri 2018-05-08 19:05 ` Andrea Parri 2018-05-08 16:04 ` Jonathan Corbet 2018-05-08 16:04 ` Jonathan Corbet 2018-05-08 16:51 ` Andrea Parri 2018-05-08 16:51 ` Andrea Parri 2018-05-07 9:35 ` [PATCH 06/18] docs: core-api: add cgroup-v2 documentation Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-08 15:51 ` Jonathan Corbet 2018-05-08 15:51 ` Jonathan Corbet 2018-05-09 12:02 ` Mauro Carvalho Chehab 2018-05-09 12:02 ` Mauro Carvalho Chehab 2018-05-07 9:35 ` [PATCH 07/18] docs: core-api: add circular-buffers documentation Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 12:31 ` Andrea Parri 2018-05-07 12:31 ` Andrea Parri 2018-05-08 16:08 ` Jonathan Corbet 2018-05-08 16:08 ` Jonathan Corbet 2018-05-07 9:35 ` [PATCH 08/18] docs: driver-api: add clk documentation Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-08 3:07 ` Greg Kroah-Hartman 2018-05-08 3:07 ` Greg Kroah-Hartman 2018-05-08 16:10 ` Jonathan Corbet 2018-05-08 16:10 ` Jonathan Corbet 2018-05-07 9:35 ` [PATCH 09/18] net: mac80211.h: fix a bad comment line Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 12:37 ` Kalle Valo 2018-05-07 12:37 ` Kalle Valo 2018-05-07 12:38 ` Johannes Berg 2018-05-07 12:38 ` Johannes Berg 2018-05-09 12:04 ` Mauro Carvalho Chehab 2018-05-09 12:04 ` Mauro Carvalho Chehab 2018-05-09 12:04 ` Johannes Berg 2018-05-09 12:04 ` Johannes Berg 2018-05-07 9:35 ` [PATCH 10/18] rcu: rcupdate.h: get rid of Sphinx warnings at rcu_pointer_handoff() Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 14:23 ` Paul E. McKenney 2018-05-07 14:23 ` Paul E. McKenney 2018-05-09 11:55 ` Mauro Carvalho Chehab 2018-05-09 11:55 ` Mauro Carvalho Chehab 2018-05-14 19:40 ` Paul E. McKenney 2018-05-14 19:40 ` Paul E. McKenney 2018-05-07 9:35 ` [PATCH 11/18] docs: crypto_engine.rst: Fix two parse warnings Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 9:35 ` [PATCH 12/18] time: timer.c: adjust a kernel-doc comment Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-13 14:00 ` [tip:timers/core] timers: Adjust " tip-bot for Mauro Carvalho Chehab 2018-05-13 14:00 ` tip-bot for Mauro Carvalho Chehab 2018-05-07 9:35 ` [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-09 8:41 ` Peter Zijlstra 2018-05-09 8:41 ` Peter Zijlstra 2018-05-09 14:45 ` Jonathan Corbet 2018-05-09 14:45 ` Jonathan Corbet 2018-05-09 15:20 ` Peter Zijlstra 2018-05-09 15:20 ` Peter Zijlstra 2018-05-09 18:35 ` Jonathan Corbet 2018-05-09 18:35 ` Jonathan Corbet 2018-05-09 18:50 ` Markus Heiser 2018-05-09 18:50 ` Markus Heiser 2018-05-09 19:31 ` Peter Zijlstra 2018-05-09 19:31 ` Peter Zijlstra 2018-05-10 12:23 ` Andrea Parri 2018-05-10 12:23 ` Andrea Parri 2018-05-10 13:15 ` Jonathan Corbet 2018-05-10 13:15 ` Jonathan Corbet 2018-05-10 16:52 ` Andrea Parri 2018-05-10 16:52 ` Andrea Parri 2018-05-10 17:45 ` Mauro Carvalho Chehab 2018-05-10 17:45 ` Mauro Carvalho Chehab 2018-05-10 8:38 ` Christoph Hellwig 2018-05-10 8:38 ` Christoph Hellwig 2018-05-10 9:38 ` Mauro Carvalho Chehab 2018-05-10 9:38 ` Mauro Carvalho Chehab 2018-05-10 12:20 ` Peter Zijlstra 2018-05-10 12:20 ` Peter Zijlstra 2018-05-10 13:04 ` Mauro Carvalho Chehab 2018-05-10 13:04 ` Mauro Carvalho Chehab 2018-05-10 13:30 ` Jonathan Corbet 2018-05-10 13:30 ` Jonathan Corbet 2018-05-10 13:31 ` Jonathan Corbet 2018-05-10 13:31 ` Jonathan Corbet 2018-05-10 14:21 ` Mauro Carvalho Chehab 2018-05-10 14:21 ` Mauro Carvalho Chehab 2018-05-10 15:38 ` Jonathan Corbet 2018-05-10 15:38 ` Jonathan Corbet 2018-05-10 16:42 ` Mauro Carvalho Chehab 2018-05-10 16:42 ` Mauro Carvalho Chehab 2018-05-10 17:14 ` Mauro Carvalho Chehab 2018-05-10 17:14 ` Mauro Carvalho Chehab 2018-05-11 7:06 ` Markus Heiser 2018-05-11 7:06 ` Markus Heiser 2018-05-07 9:35 ` [PATCH 14/18] fbdev: modedb.c: fix a kernel-doc markup Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-15 10:22 ` Bartlomiej Zolnierkiewicz 2018-05-15 10:22 ` Bartlomiej Zolnierkiewicz 2018-05-15 10:22 ` Bartlomiej Zolnierkiewicz 2018-05-15 10:22 ` Bartlomiej Zolnierkiewicz 2018-05-07 9:35 ` [PATCH 15/18] iio: iio.h: use nested struct support on " Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 17:08 ` Jonathan Cameron 2018-05-07 17:08 ` Jonathan Cameron 2018-05-09 12:00 ` Mauro Carvalho Chehab 2018-05-09 12:00 ` Mauro Carvalho Chehab 2018-05-07 9:35 ` [PATCH 16/18] mtd: rawnand.h: use nested union kernel-doc markups Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-07 9:46 ` Boris Brezillon 2018-05-07 9:46 ` Boris Brezillon 2018-05-07 11:32 ` Mauro Carvalho Chehab 2018-05-07 11:32 ` Mauro Carvalho Chehab 2018-05-09 12:02 ` Boris Brezillon 2018-05-09 12:02 ` Boris Brezillon 2018-05-09 12:10 ` Mauro Carvalho Chehab 2018-05-09 12:10 ` Mauro Carvalho Chehab 2018-05-09 12:22 ` Boris Brezillon 2018-05-09 12:22 ` Boris Brezillon 2018-05-09 13:28 ` Mauro Carvalho Chehab 2018-05-09 13:28 ` Mauro Carvalho Chehab 2018-05-09 15:56 ` Boris Brezillon 2018-05-09 15:56 ` Boris Brezillon 2018-05-07 9:35 ` [PATCH 17/18] docs: uio-howto.rst: use a code block to solve a warning Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-08 3:07 ` Greg Kroah-Hartman 2018-05-08 3:07 ` Greg Kroah-Hartman 2018-05-07 9:35 ` [PATCH 18/18] w1: w1_io.c: fix a kernel-doc warning Mauro Carvalho Chehab 2018-05-07 9:35 ` Mauro Carvalho Chehab 2018-05-08 11:03 ` Evgeniy Polyakov 2018-05-08 11:03 ` Evgeniy Polyakov 2018-05-09 12:32 ` Mauro Carvalho Chehab 2018-05-09 12:32 ` Mauro Carvalho Chehab 2018-05-09 13:11 ` Jonathan Corbet 2018-05-09 13:11 ` Jonathan Corbet 2018-05-10 10:37 ` Evgeniy Polyakov 2018-05-10 10:37 ` Evgeniy Polyakov 2018-05-08 16:13 ` [PATCH 00/18] Fix some build warnings/errors with Sphinx Jonathan Corbet 2018-05-08 16:13 ` Jonathan Corbet 2018-05-08 16:13 ` Jonathan Corbet 2018-05-08 16:13 ` Jonathan Corbet 2018-05-08 17:36 ` Luis R. Rodriguez 2018-05-08 17:36 ` Luis R. Rodriguez 2018-05-08 17:36 ` Luis R. Rodriguez 2018-05-08 17:36 ` Luis R. Rodriguez
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=2a04ab24f302a0802572c4c80c4d416b953f213d.1525684985.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.