| Message ID | 20211217212146.2573-1-oxr463@gmx.us (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | docs/can: convert to restructuredText | expand |
On 17/12/2021 22.21, oxr463@gmx.us wrote: > From: Lucas Ramage <lucas.ramage@infinite-omicron.com> Hi! Thanks for your patch! This looks like a good idea, but I think there are some minor issues which should be fixed... First: Please check your mailer setup. The mail has been sent via @gmx.us, but the Signed-off-by uses @infinite-omicron.com ... not a big issue, I guess, but it might be better to use the same address for both. Second, it does not work here, at least not with Sphinx 1.7 which I have installed on my system: docs/can.rst:39:Enumerated list ends without a blank line; unexpected unindent. Does this render correctly on your system? Also there are paragraphs in this file which should be clearly marked as pre-formatted text (use "::" for those), e.g.: diff --git a/docs/can.rst b/docs/can.rst --- a/docs/can.rst +++ b/docs/can.rst @@ -122,7 +125,7 @@ is setup according to the previous SJA1000 section. -device ctucan_pci,canbus0=canbus0-bus,canbus1=canbus0-bus \ -nographic -Setup of CTU CAN FD controller in a guest Linux system +Setup of CTU CAN FD controller in a guest Linux system:: insmod ctucanfd.ko || modprobe ctucanfd insmod ctucanfd_pci.ko || modprobe ctucanfd_pci > Bug: https://gitlab.com/qemu-project/qemu/-/issues/527 Please use "Buglink:" instead, it's more common in the QEMU project. > Signed-off-by: Lucas Ramage <lucas.ramage@infinite-omicron.com> > --- > docs/{can.txt => can.rst} | 14 ++++++-------- While you're at it, I think this file should be moved into one of the subfolders as well, likely docs/system/ I guess. > 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 [...] > @@ -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 > + This look like an unnecessary addition of an empty line. > 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 > > Thomas
Hi Thomas, I intentionally sent the email via my gmx address. But I want my commit under the infinite-omicron email address. I had a few warnings on my end, but it builds fine with Sphinx v3.4.3 on Debian Bullseye. I can clean up the warnings in the new patch. Yeah, it renders fine. Let me submit a new patch for the rest of these changes too. Regards, ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐ On Wednesday, January 5th, 2022 at 4:11 AM, Thomas Huth <thuth@redhat.com> wrote: > On 17/12/2021 22.21, oxr463@gmx.us wrote: > > > From: Lucas Ramage lucas.ramage@infinite-omicron.com > > Hi! > > Thanks for your patch! This looks like a good idea, but I think there are > > some minor issues which should be fixed... > > First: Please check your mailer setup. The mail has been sent via @gmx.us, > > but the Signed-off-by uses @infinite-omicron.com ... not a big issue, I > > guess, but it might be better to use the same address for both. > > Second, it does not work here, at least not with Sphinx 1.7 which I have > > installed on my system: > > docs/can.rst:39:Enumerated list ends without a blank line; > > unexpected unindent. > > Does this render correctly on your system? > > Also there are paragraphs in this file which should be clearly marked as > > pre-formatted text (use "::" for those), e.g.: > > diff --git a/docs/can.rst b/docs/can.rst > > --- a/docs/can.rst > > +++ b/docs/can.rst > > @@ -122,7 +125,7 @@ is setup according to the previous SJA1000 section. > > -device ctucan_pci,canbus0=canbus0-bus,canbus1=canbus0-bus \ > > -nographic > > -Setup of CTU CAN FD controller in a guest Linux system > > +Setup of CTU CAN FD controller in a guest Linux system:: > > insmod ctucanfd.ko || modprobe ctucanfd > > insmod ctucanfd_pci.ko || modprobe ctucanfd_pci > > > Bug: https://gitlab.com/qemu-project/qemu/-/issues/527 > > Please use "Buglink:" instead, it's more common in the QEMU project. > > > Signed-off-by: Lucas Ramage lucas.ramage@infinite-omicron.com > > ------------------------------------------------------------- > > > > docs/{can.txt => can.rst} | 14 ++++++-------- > > While you're at it, I think this file should be moved into one of the > > subfolders as well, likely docs/system/ I guess. > > > 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 > > [...] > > > @@ -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 > > > > + > > This look like an unnecessary addition of an empty line. > > > 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 > > Thomas
On 05/01/2022 20.52, Lucas Ramage wrote: > Hi Thomas, > > I intentionally sent the email via my gmx address. But I want my commit under the infinite-omicron email address. > > I had a few warnings on my end, but it builds fine with Sphinx v3.4.3 on Debian Bullseye. I can clean up the warnings in the new patch. Yes, please do so. If you add "--enable-werror" to your "configure" options, the warnings should be turned into errors as well - and that's what we do in our CI, so the warnings have to be fixed first before this patch can be included. Thanks, Thomas
Hi Thomas, Not sure if you saw my latest patch, but I fixed all of the warnings already. I also updated the references at the bottom to use inline web links. Regards, ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐ On Friday, January 7th, 2022 at 2:19 AM, Thomas Huth <thuth@redhat.com> wrote: > On 05/01/2022 20.52, Lucas Ramage wrote: > > > Hi Thomas, > > > > I intentionally sent the email via my gmx address. But I want my commit under the infinite-omicron email address. > > > > I had a few warnings on my end, but it builds fine with Sphinx v3.4.3 on Debian Bullseye. I can clean up the warnings in the new patch. > > Yes, please do so. If you add "--enable-werror" to your "configure" options, > > the warnings should be turned into errors as well - and that's what we do in > > our CI, so the warnings have to be fixed first before this patch can be > > included. > > Thanks, > > Thomas
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