From: Lucas Ramage <lucas.ram...@infinite-omicron.com>
Bug: https://gitlab.com/qemu-project/qemu/-/issues/527
Signed-off-by: Lucas Ramage <lucas.ram...@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
