aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CANBUS_Troubleshooting.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2024-04-20 13:23:42 -0400
committerKevin O'Connor <kevin@koconnor.net>2024-04-20 13:23:42 -0400
commit28faf814143a22534f2afa5b292ffd97b8acf886 (patch)
tree75c642bff05889c23e6f6fc847ba350b01567982 /docs/CANBUS_Troubleshooting.md
parent819599362cad73316759e003b048545d09258a54 (diff)
downloadkutter-28faf814143a22534f2afa5b292ffd97b8acf886.tar.gz
kutter-28faf814143a22534f2afa5b292ffd97b8acf886.tar.xz
kutter-28faf814143a22534f2afa5b292ffd97b8acf886.zip
docs: Update CANBUS_Troubleshooting.md to avoid formatting error
Avoid starting a line with "128." as that confused markdown. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/CANBUS_Troubleshooting.md')
-rw-r--r--docs/CANBUS_Troubleshooting.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/CANBUS_Troubleshooting.md b/docs/CANBUS_Troubleshooting.md
index 1464c85e..de0deaf7 100644
--- a/docs/CANBUS_Troubleshooting.md
+++ b/docs/CANBUS_Troubleshooting.md
@@ -81,15 +81,15 @@ link show can0`. It should report a bunch of text including the
snippet `qlen 128`. If one sees something like `qlen 10` then it
indicates the CAN device has not been properly configured.
-It is not recommended to use a `txqueuelen` significantly larger than
-128. A CAN bus running at a frequency of 1000000 will typically take
-around 120us to transmit a CAN packet. Thus a queue of 128 packets is
-likely to take around 15-20ms to drain. A substantially larger queue
-could cause excessive spikes in message round-trip-time which could
-lead to unrecoverable errors. Said another way, Klipper's application
-retransmit system is more robust if it does not have to wait for Linux
-to drain an excessively large queue of possibly stale data. This is
-analogous to the problem of
+It is not recommended to use a `txqueuelen` significantly larger
+than 128. A CAN bus running at a frequency of 1000000 will typically
+take around 120us to transmit a CAN packet. Thus a queue of 128
+packets is likely to take around 15-20ms to drain. A substantially
+larger queue could cause excessive spikes in message round-trip-time
+which could lead to unrecoverable errors. Said another way, Klipper's
+application retransmit system is more robust if it does not have to
+wait for Linux to drain an excessively large queue of possibly stale
+data. This is analogous to the problem of
[bufferbloat](https://en.wikipedia.org/wiki/Bufferbloat) on internet
routers.