buglwIP - A Lightweight TCP/IP stack - Bugs: bug #45024, Incorrect documentation of...

 
 

You are not allowed to post comments on this tracker with your current authentication level.

bug #45024: Incorrect documentation of TCP_WRITE_FLAG_MORE

Submitter:  Edgar Bonet <ebonet>
Submitted:  Tue 05 May 2015 02:31:07 PM UTC
   
 
Category:  Documentation Severity:  3 - Normal
Item Group:  Change Request Status:  Fixed
Privacy:  Public Assigned to:  goldsimon
Open/Closed:  Closed Planned Release:  None
lwIP version:  git head

Wed 05 Aug 2015 07:21:00 PM UTC, comment #1: 

Fixed, thanks for the patch.

Simon Goldschmidt <goldsimon>
Group administrator
Tue 05 May 2015 02:31:07 PM UTC, original submission:  

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.

Edgar Bonet <ebonet>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attached Files

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by goldsimon (Posted a comment)
  • -email is unavailable- added by ebonet (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

    Follow 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2015-08-05 goldsimon StatusNone Fixed
        Assigned toNone goldsimon
        Open/ClosedOpen Closed
    2015-05-05 ebonet Attached File- Added 0001-Fix-documentation-of-TCP_WRITE_FLAG_MORE.patch, #33922

    Back to the top

    Powered by Savane 3.13-02a9.
    Corresponding source code