tcpip.Endpoint.Write() doc is out of date

[bemasc]

The doc says

	// Unlike io.Writer.Write, Endpoint.Write transfers ownership of any bytes
	// successfully written to the Endpoint. That is, if a call to
	// Write(SlicePayload{data}) returns (n, err), it may retain data[:n], and
	// the caller should not use data[:n] after Write returns.

but the signature of Write has since changed. It no longer accepts a slice payload, so this advice is no longer applicable.

[ianlewis]

For posterity the comment in question is here:

gvisor/pkg/tcpip/tcpip.go

Lines 506 to 509 in b8b43f7

	// Unlike io.Writer.Write, Endpoint.Write transfers ownership of any bytes
	// successfully written to the Endpoint. That is, if a call to
	// Write(SlicePayload{data}) returns (n, err), it may retain data[:n], and
	// the caller should not use data[:n] after Write returns.

[himanshu007-creator]

hi i would like to work on this issue. But i wanted to ask, Do we have to update L508 or simply remove it?
if update then with what.
thanks

[himanshu007-creator]

@ianlewis 👀

[milantracy]

imo you have to update the comment.

From the implementations[0][1] of the interface, the behavior is still valid

[0] https://github.com/google/gvisor/blob/master/pkg/tcpip/transport/tcp/endpoint.go#L1563
[1] https://github.com/google/gvisor/blob/master/pkg/tcpip/transport/udp/endpoint.go#L430

[namit-chandwani]

Hey @ianlewis, I'd like to work on this issue. Can you please assign it to me?

[github-actions]

A friendly reminder that this issue had no activity for 120 days.