google/gvisor

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

Open

#6,024 建立於 2021年5月19日

在 GitHub 查看
 (6 留言) (0 反應) (0 負責人)Go (1,061 fork)batch import
area: networkinggood first issuetype: bug

倉庫指標

Star
 (12,713 star)
PR 合併指標
 (平均合併 4天 22小時) (30 天內合併 184 個 PR)

描述

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.

貢獻者指南

研究方向
在 gvisor 程式碼庫中定位 tcpip.Endpoint.Write 方法，該方法很可能位於 tcpip 套件中。查看 issue 評論以獲取關於目前函式簽章的任何指引，然後更新文件註解以符合實際行為。沒有關聯的 PR，因此請確保修復與程式碼庫保持一致。
技術棧
go
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1 小時以內
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90