Update CAN documentation to have Markdown syntax

Also split long paragraphs to smaller ones.

diff --git a/rpp-test-sw/commands/cmd_can.c b/rpp-test-sw/commands/cmd_can.c
index 957eac514089f6cc34e5142d6f8c36ccd7d332b6..a5833c205cf7279a17f8c237e97bd8b94198499e 100644 (file)
--- a/rpp-test-sw/commands/cmd_can.c
+++ b/rpp-test-sw/commands/cmd_can.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2012-2013 Czech Technical University in Prague
+ * Copyright (C) 2012-2014 Czech Technical University in Prague
  *
  * Created on: 28.2.2013
  *
@@ -1008,49 +1008,63 @@ cmd_des_t const cmd_des_can_test={
     "This command tests all CAN functions in the RPP library. It does those\n"
     "particular tests:\n"
     "\n"
-    "1) Test of the rpp_can_init(), rpp_can_write() and rpp_can_read() functions.\n"
-    "   At the beginning, the CAN bus is initialized with manually specified and\n"
-    "   verified CAN bit timing parameters. Then a message is sent on the CAN1 and is\n"
-    "   received on the CAN2. Finally the received message is compared with the sent one.\n"
-    "   If the transmissions fails, reception exceeds a timeout or the sent and\n"
-    "   received messages do not match, the command prints the appropriate error\n"
-    "   code."
-    "2) Test of the CAN bit timing parameters calculation.\n"
-    "   This test subsequently initializes the CAN bus to a baudrates 125k, 250k\n"
-    "   and 500k. For each one of them a message is sent on CAN1 and received on CAN2.\n"
-    "   Finally the received message is compared with the sent one like in a test (1).\n"
-    "   If the initialization, transmission, reception or comparison fails or\n"
-    "   if the reception timeout is reached, an appropriate error code is printed.\n"
-    "3) Test of the behavior of transmission request overwriting.\n"
-    "   The CAN bus is initialized like in the test (1). A message A transmission\n"
-    "   request is posted on CAN1 by calling rpp_can_write() and right after that\n"
-    "   another message B transmission request is posted on CAN1 by another call of\n"
-    "   the rpp_can_write(). A message B is received on CAN2, because the second request\n"
-    "   came so quickly, that it overwrote the first one. The sent and received messages\n"
-    "   are compared to verify that the transmission was correct.\n"
-    "   If the initialization, transmission, reception or comparison fails or\n"
-    "   if the reception timeout is reached, an appropriate error code is printed.\n"
-    "4) Test of the TX request pending flag detection.\n"
-    "   The CAN bus is initialized like in the test (1). A message is transmitted\n"
-    "   on the CAN1 and the test waits for the TX pending flag to be set, which\n"
-    "   signalizes that there is a message transmission request pending. After the\n"
-    "   flag has been set, the test waits for its clearance, which means that the\n"
-    "   message has been sent. The test measures, how many flag test cycles passed,\n"
-    "   until the flag has been cleared. This value is then presented as a time.\n"
-    "   At the end, the message is received on the CAN2 and is compared with the\n"
-    "   sent message for verification.\n"
-    "   If the initialization, transmission, reception or comparison fails or if\n"
-    "   timeout is reached while waiting for the flag set/clear or receive timeout\n"
-    "   is reached, an appropriate error code is printed.\n"
-    "5) Test of the message received (RX) indicator.\n"
-    "   The CAN bus is initialized like in the test (1). A message is transmitted\n"
-    "   on the CAN1. The test then waits for the RX indicator to be set, which\n"
-    "   indicates that a message has been received. The message is picked up by\n"
-    "   the rpp_can_read(). This should clear the indicator, which is tested. Finally\n"
-    "   the received messages is compared with the sent one.\n"
-    "   If the initialization, transmission, reception, message comparison or indicator\n"
-    "   test fails or if timeout is reached while waiting for the flag set, the\n"
-    "   appropriate error code is printed.\n"
+    "1.  Test of the rpp_can_init(), rpp_can_write() and rpp_can_read() functions.\n"
+    "\n"
+    "    At the beginning, the CAN bus is initialized with manually specified and\n"
+    "    verified CAN bit timing parameters. Then a message is sent on the CAN1 and is\n"
+    "    received on the CAN2. Finally the received message is compared with the sent one.\n"
+    "    If the transmissions fails, reception exceeds a timeout or the sent and\n"
+    "    received messages do not match, the command prints the appropriate error\n"
+    "    code.\n"
+    "\n"
+    "2.  Test of the CAN bit timing parameters calculation.\n"
+    "\n"
+    "    This test subsequently initializes the CAN bus to a baudrates 125k, 250k\n"
+    "    and 500k. For each one of them a message is sent on CAN1 and received on CAN2.\n"
+    "    Finally the received message is compared with the sent one like in a test (1).\n"
+    "    If the initialization, transmission, reception or comparison fails or\n"
+    "    if the reception timeout is reached, an appropriate error code is\n"
+    "    printed.\n"
+    "\n"
+    "3.  Test of the behavior of transmission request overwriting.\n"
+    "\n"
+    "    The CAN bus is initialized like in the test (1). A message A transmission\n"
+    "    request is posted on CAN1 by calling rpp_can_write() and right after that\n"
+    "    another message B transmission request is posted on CAN1 by another call of\n"
+    "    the rpp_can_write(). A message B is received on CAN2, because the second request\n"
+    "    came so quickly, that it overwrote the first one. The sent and received messages\n"
+    "    are compared to verify that the transmission was correct.\n"
+    "\n"
+    "    If the initialization, transmission, reception or comparison fails or\n"
+    "    if the reception timeout is reached, an appropriate error code is\n"
+    "    printed.\n"
+    "\n"
+    "4.  Test of the TX request pending flag detection.\n"
+    "\n"
+    "    The CAN bus is initialized like in the test (1). A message is transmitted\n"
+    "    on the CAN1 and the test waits for the TX pending flag to be set, which\n"
+    "    signalizes that there is a message transmission request pending. After the\n"
+    "    flag has been set, the test waits for its clearance, which means that the\n"
+    "    message has been sent. The test measures, how many flag test cycles passed,\n"
+    "    until the flag has been cleared. This value is then presented as a time.\n"
+    "    At the end, the message is received on the CAN2 and is compared with the\n"
+    "    sent message for verification.\n"
+    "\n"
+    "    If the initialization, transmission, reception or comparison fails or if\n"
+    "    timeout is reached while waiting for the flag set/clear or receive timeout\n"
+    "    is reached, an appropriate error code is printed.\n"
+    "\n"
+    "5.  Test of the message received (RX) indicator.\n"
+    "\n"
+    "    The CAN bus is initialized like in the test (1). A message is transmitted\n"
+    "    on the CAN1. The test then waits for the RX indicator to be set, which\n"
+    "    indicates that a message has been received. The message is picked up by\n"
+    "    the rpp_can_read(). This should clear the indicator, which is tested. Finally\n"
+    "    the received messages is compared with the sent one.\n"
+    "\n"
+    "    If the initialization, transmission, reception, message comparison or indicator\n"
+    "    test fails or if timeout is reached while waiting for the flag set, the\n"
+    "    appropriate error code is printed.\n"
     "\n"
     "At the end the CAN bus is reset and left with the configuration from test (1).\n"
     "Those tests assumes the CAN1 and CAN2 to be connected in HW loopback.\n"