Fix documentation of TCP_WRITE_FLAG_MORE.

The description of the flag was erroneous in src/core/tcp_out.c, and
self-contradictory in doc/rawapi.txt.
This commit is contained in:
Edgar Bonet 2015-05-05 16:27:21 +02:00 committed by sg
parent 851e03966d
commit fb456e00ac
2 changed files with 2 additions and 2 deletions

View File

@ -196,7 +196,7 @@ callback function.
should be allocated and the data should only be referenced by pointer. This should be allocated and the data should only be referenced by pointer. This
also means that the memory behind dataptr must not change until the data is also means that the memory behind dataptr must not change until the data is
ACKed by the remote host ACKed by the remote host
- TCP_WRITE_FLAG_MORE: indicates that more data follows. If this is given, - TCP_WRITE_FLAG_MORE: indicates that more data follows. If this is omitted,
the PSH flag is set in the last segment created by this call to tcp_write. the PSH flag is set in the last segment created by this call to tcp_write.
If this flag is given, the PSH flag is not set. If this flag is given, the PSH flag is not set.

View File

@ -364,7 +364,7 @@ tcp_write_checks(struct tcp_pcb *pcb, u16_t len)
* @param len Data length in bytes * @param len Data length in bytes
* @param apiflags combination of following flags : * @param apiflags combination of following flags :
* - TCP_WRITE_FLAG_COPY (0x01) data will be copied into memory belonging to the stack * - TCP_WRITE_FLAG_COPY (0x01) data will be copied into memory belonging to the stack
* - TCP_WRITE_FLAG_MORE (0x02) for TCP connection, PSH flag will be set on last segment sent, * - TCP_WRITE_FLAG_MORE (0x02) for TCP connection, PSH flag will not be set on last segment sent,
* @return ERR_OK if enqueued, another err_t on error * @return ERR_OK if enqueued, another err_t on error
*/ */
err_t err_t