google/gvisor

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

Open

#6 024 ouverte le 19 mai 2021

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)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.

Guide contributeur

Stack technique
go
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Go programming
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
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.