acassis commented on code in PR #17283: URL: https://github.com/apache/nuttx/pull/17283#discussion_r2498759474
########## Documentation/components/drivers/character/can.rst: ########## @@ -34,8 +34,12 @@ is used to store the timestamp of the CAN message. **Usage Note**: 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. *Never assume that a single message will be returned*... +messages. *Do not assume that a single message will be returned*... if you do this, *you will lose CAN data* 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: +your read buffer can hold more than one small message. This +behavior can be controlled by using +``ioctl(fd, CANIOC_SET_IWATERMARK, &(size_t)0)`` that limits the Review Comment: @michallenc that is true, I'm not forcing him and I didn't Request a Change. But Documentation/ is something we need to worry to improve. That is something that everybody pointed in the workshop. So, I will request Documentation for all contributions that include new features or that modify existing things. I know nobody like to write documentation, but if the developer doesn't do it how will do? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
