google/gvisor

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

Open

#6,024 opened on May 19, 2021

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Go (12,713 stars) (1,061 forks)batch import
area: networkinggood first issuetype: bug

Description

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.

Contributor guide

Tech stack
go
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Locate the tcpip.Endpoint.Write method in the gvisor repository, likely in the tcpip package. Check the issue comments for any direction on the current signature, then update the doc comment to match the actual behavior. No linked PRs, so ensure the fix is consistent with the codebase.