[lwip-devel] [bug #59866] wrong comment in file fs_example.c

[Andrey Vinogradov]

URL:
  <https://savannah.nongnu.org/bugs/?59866>

                 Summary: wrong comment in file fs_example.c
                 Project: lwIP - A Lightweight TCP/IP stack
            Submitted by: andreyvinogradov
            Submitted on: Wed 13 Jan 2021 03:46:46 PM UTC
                Category: Documentation
                Severity: 3 - Normal
              Item Group: Change Request
                  Status: None
                 Privacy: Public
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: None
            lwIP version: git head

    _______________________________________________________

Details:

There is an example of fs_wait_read_custom() function definition:
u8_t
fs_wait_read_custom(struct fs_file *file, fs_wait_cb callback_fn, void
*callback_arg)
{
...

  /* Return
     - 1 if ready to read (at least one byte)
     - 0 if reading should be delayed (call 'tcpip_callback(callback_fn,
callback_arg)' when ready) */

  return 1;
}

probably 0 and 1 return values are messed up in comment and it should be:
  /* Return
     - 0 if ready to read (at least one byte)
     - 1 if reading should be delayed (call 'tcpip_callback(callback_fn,
callback_arg)' when ready) */




    _______________________________________________________

Reply to this item at:

  <https://savannah.nongnu.org/bugs/?59866>

_______________________________________________
  Message sent via Savannah
  https://savannah.nongnu.org/