Question

我想为R开发人员尽可能简单地纠正拼写错误。如何发送制作这样一个“补丁”的差异文件？

另外，我应该在哪里发送错字？通过邮件？发布错误？发送到r-devel？

我主要关注小错字，例如拼写错误或语法修正。

我不记得我看到的最后一个拼写错误的位置，但仅作为一个例子，让我们假设我想在ls的帮助文件中的“后兼容性”中将“返回”改为“向后”。如何我做了一个差异补丁？

谢谢

Answer 1

补丁通常使用统一的上下文差异进行。您可以使用diff -u创建此类差异。

例如，假设您从文件foo开始，其中包含以下内容。

Blah
Blah
Blah

然后修改它，将修改保存在名为foo.modified的新文件中。以下是foo.modified：

的内容

Blah
Blah
New information!
Blah -- changing this line

现在执行diff -u foo foo.modified会产生以下结果。

--- foo 2011-11-05 20:59:13.000000000 -0700
+++ foo.modified    2011-11-05 20:59:44.000000000 -0700
@@ -1,3 +1,4 @@
 Blah
 Blah
-Blah
+New information!
+Blah -- changing this line

请注意，许多版本控制系统的差异显示统一的上下文差异。

关于在R中发送错误的位置：看起来有一个内置函数：bug.report。或者，还有R bug tracking system的网络界面。

Answer 2

@David Alber关于diff格式的建议很好（虽然我经常使用diff -c），但我不同意最佳目标（他建议bug.report和R bug跟踪系统）。

对于简单的印刷错误，通常最好的r-devel@r-project.org邮件列表中包含足够非正式上下文的快速电子邮件（请确保您使用的是最新版本！ - 请参阅下一点）。这就是我的工作方式，它似乎是R开发人员的首选，因为这意味着他们不必处理完整的错误报告机制。（我可以很容易地找到该协议的唯一文档是note from Brian Ripley in 2007。）
如果你要更系统地报告错误，那么最好的办法就是从https://svn.R-project.org/R/trunk获得最新的Subversion版本（有一个简短但有点过时的描述{{} 3}}），对Rd文件进行更改，然后运行svn diff以获取最新版本的差异。如上所述，将其发送到r-devel（我相信文本文件附件会通过电子邮件保存到r-devel）。
不要忘记发送错误报告的常见注意事项：（1）确保您报告最新版本（如上所述，如果您能够忍受，SVN最好）; （2）确保你报告的任何内容肯定是一个错误/错字; （3）确保向相关机构报告，即向维护者报告提供包中的错误/拼写错误（相关包应列在帮助文件的头部，maintainer("pkg")找到电子邮件地址维护者）。

如何报告拼写错误（通过发送差异文件）？

2 个答案: