From: oxr463@gmx.us
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org,
Lucas Ramage <lucas.ramage@infinite-omicron.com>
Subject: [PATCH] docs/can: convert to restructuredText
Date: Fri, 17 Dec 2021 21:21:46 +0000 [thread overview]
Message-ID: <20211217212146.2573-1-oxr463@gmx.us> (raw)
From: Lucas Ramage <lucas.ramage@infinite-omicron.com>
Bug: https://gitlab.com/qemu-project/qemu/-/issues/527
Signed-off-by: Lucas Ramage <lucas.ramage@infinite-omicron.com>
---
docs/{can.txt => can.rst} | 14 ++++++--------
docs/index.rst | 1 +
2 files changed, 7 insertions(+), 8 deletions(-)
rename docs/{can.txt => can.rst} (97%)
diff --git a/docs/can.txt b/docs/can.rst
similarity index 97%
rename from docs/can.txt
rename to docs/can.rst
index 0d310237df..995134d079 100644
--- a/docs/can.txt
+++ b/docs/can.rst
@@ -1,6 +1,5 @@
-QEMU CAN bus emulation support
-==============================
-
+CAN Bus Emulation Support
+=========================
The CAN bus emulation provides mechanism to connect multiple
emulated CAN controller chips together by one or multiple CAN busses
(the controller device "canbus" parameter). The individual busses
@@ -32,8 +31,7 @@ emulated environment for testing and RTEMS GSoC slot has been donated
to work on CAN hardware emulation on QEMU.
Examples how to use CAN emulation for SJA1000 based boards
-==========================================================
-
+----------------------------------------------------------
When QEMU with CAN PCI support is compiled then one of the next
CAN boards can be selected
@@ -100,8 +98,7 @@ traffic with "candump" command which is included in "can-utils".
candump can0
CTU CAN FD support examples
-===========================
-
+---------------------------
This open-source core provides CAN FD support. CAN FD drames are
delivered even to the host systems when SocketCAN interface is found
CAN FD capable.
@@ -170,7 +167,7 @@ The test can be run viceversa, generate messages in the guest system and capture
in the host one and much more combinations.
Links to other resources
-========================
+------------------------
(1) CAN related projects at Czech Technical University, Faculty of Electrical Engineering
http://canbus.pages.fel.cvut.cz/
@@ -196,3 +193,4 @@ Links to other resources
http://canbus.pages.fel.cvut.cz/ctucanfd_ip_core/driver_doc/ctucanfd-driver.html
(11) Integration with PCIe interfacing for Intel/Altera Cyclone IV based board
https://gitlab.fel.cvut.cz/canbus/pcie-ctu_can_fd
+
diff --git a/docs/index.rst b/docs/index.rst
index 0b9ee9901d..beb868ca7f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -18,3 +18,4 @@ Welcome to QEMU's documentation!
interop/index
specs/index
devel/index
+ can
--
2.32.0
next reply other threads:[~2021-12-17 21:23 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-17 21:21 oxr463 [this message]
2022-01-05 9:11 ` [PATCH] docs/can: convert to restructuredText Thomas Huth
2022-01-05 19:52 ` Lucas Ramage
2022-01-07 7:19 ` Thomas Huth
2022-01-07 14:29 ` Lucas Ramage
2022-01-05 20:56 oxr463
2022-01-13 11:37 ` Peter Maydell
2022-01-13 15:26 ` Lucas Ramage
2022-01-13 15:38 ` Peter Maydell
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=20211217212146.2573-1-oxr463@gmx.us \
--to=oxr463@gmx.us \
--cc=lucas.ramage@infinite-omicron.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/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: link
Be 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.