[lwip-devel] Small documentation fix for TFTP

[Ivan Warren]

Apparently the TFTP server now also invokes the error() function in the 
tftp_context struct.

Some tftp clients (for example Windows 10 TFTP client) will open the 
remote file before checking the local file can be opened - and will then 
send an error indication to the server to indicate there was an error 
opening the local file. When the happens, the LWIP tftp server will 
invoke the error() member of the tftp_context.

Please find herein a small patch to update the TFTP documentation (no 
functional change)

*******************

diff --git a/src/include/lwip/apps/tftp_common.h 
b/src/include/lwip/apps/tftp_common.h
index 6c46a8c3..4bc2c173 100644
--- a/src/include/lwip/apps/tftp_common.h
+++ b/src/include/lwip/apps/tftp_common.h
@@ -85,10 +85,10 @@ struct tftp_context {
    */
   int (*write)(void* handle, struct pbuf* p);
   /**
-   * Error response (client mode only)
-   * @param handle File handle set by tftp_get()/tftp_put()
-   * @param err error code from server
-   * @param msg error message from server
+   * Error indication from client or response from server
+   * @param handle File handle set by open()/tftp_get()/tftp_put()
+   * @param err error code from client or server
+   * @param msg error message from client or server
    * @param size size of msg
    */
   void (*error)(void* handle, int err, const char* msg, int size);

*******************

smime.p7s
Description: Signature cryptographique S/MIME