sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Porting guide: Fix a typo

Browse Source
This commit is contained in:
Gregory Nutt 2017-08-30 08:48:15 -06:00
parent 7e6ce93b61
commit 2e804e3bdb
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/NuttxPortingGuide.html
View File

@ -5001,12 +5001,12 @@ void iob_dump(FAR const char *msg, FAR struct iob_s *iob, unsigned int len,
</ul>
<p>
<b>Usage Note</b>:
When reading from the the CAN multiple messages may be returned, depending on (1) the size the returned can messages, and (2) the size of the buffer provided to receive CAN messages.
When reading from the CAN driver multiple messages may be returned, depending on (1) the size the returned can messages, and (2) the size of the buffer provided to receive CAN messages.
<i>Never assume that a single message will be returned</i>... if you do this, <i>you will lose CAN data</i> under conditions where your read buffer can hold more than one small message.
Below is an example about how you should think of the CAN read operation:
</p>
<ul><pre>
#define BUFLEN 128
#define BUFLEN 128 /* Arbitrary size of the CAN RX buffer */
FAR struct can_msg_s *msg;
char rxbuffer[BUFLEN];