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