[lwip-devel] [bug #45024] Incorrect documentation of TCP_WRITE_FLAG_MORE

[Edgar Bonet]

URL:
  <http://savannah.nongnu.org/bugs/?45024>

                 Summary: Incorrect documentation of TCP_WRITE_FLAG_MORE
                 Project: lwIP - A Lightweight TCP/IP stack
            Submitted by: ebonet
            Submitted on: mar. 05 mai 2015 14:31:07 GMT
                Category: Documentation
                Severity: 3 - Normal
              Item Group: Change Request
                  Status: None
                 Privacy: Public
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: 
            lwIP version: git head

    _______________________________________________________

Details:

lwip/doc/rawapi.txt documents TCP_WRITE_FLAG_MORE in a
self-contradictory way:

  "If this is given, the PSH flag is set [...]. If this flag is given,
  the PSH flag is not set."

The Doxygen comments in lwip/src/core/tcp_out.c provide coherent, but
incorrect documentation of the same flag:

  "TCP_WRITE_FLAG_MORE (0x02) for TCP connection, PSH flag will be set
  on last segment sent"

According to the source code (lwip/src/core/tcp_out.c:719), if
TCP_WRITE_FLAG_MORE is given, the PSH flag is *not* set.

The attached patch fixes these documents.



    _______________________________________________________

File Attachments:


-------------------------------------------------------
Date: mar. 05 mai 2015 14:31:07 GMT  Name:
0001-Fix-documentation-of-TCP_WRITE_FLAG_MORE.patch  Size: 2 ko   By: ebonet

<http://savannah.nongnu.org/bugs/download.php?file_id=33922>

    _______________________________________________________

Reply to this item at:

  <http://savannah.nongnu.org/bugs/?45024>

_______________________________________________
  Message posté via/par Savannah
  http://savannah.nongnu.org/