如何报告拼写错误(通过发送diff文件)？

Question

我想让R开发人员尽可能容易地纠正拼写错误。我怎样才能发送一个做这样一个“补丁”的diff文件？

另外，我应该把打字错误发送到哪里？通过电子邮件？发布bug？把它送到研发中心？

我最关心的是小的打字错误，比如拼写错误或语法更正。

我不记得我最后一次看到的拼写错误是在哪里了，但只是一个例子，让我们假设我想要在ls的帮助文件中将"back“改为"back”in“back”。我如何制作一个不同的补丁？

谢谢

Answer 1

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

• 对于简单的打字错误，在r-devel@r-project.org邮件列表中提供充分的非正式上下文的快速电子邮件通常是最好的(请确保您使用的是最新版本！--请参阅下一点)。这就是我的做法，R开发人员似乎更喜欢这样做，因为这意味着他们不必处理完整的bug报告机制。(我能轻松找到的关于该协议的唯一文档是这个note from Brian Ripley in 2007.)
• If，您将更系统地报告错误，如果您可以进行投资，最好的事情是从https://svn.R-project.org/R/trunk获得最新的Subversion发行版(有一个简短但有点过时的描述here)，对Rd文件进行更改，然后运行svn diff来与最新版本进行比较。如上所述，将其发送到r-devel).
• Don't (我相信文本文件附件保存在电子邮件中)忘记发送错误报告的常见注意事项：(1)确保您报告的是最新版本(如上所述，如果您能忍受，r-devel是最好的)；(2)确保您报告的任何内容都肯定是错误/打字错误；(3)确保向适当的权威机构报告，即向维护者报告贡献包中的错误/拼写错误(相关包应列在帮助文件的头部，maintainer("pkg")会找到maintainer).

的电子邮件地址

Answer 2

补丁通常是使用统一的上下文差异制作的。您可以使用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发送到哪里:看起来有一个内置的函数：bug.report。或者，也可以使用R bug tracking system的web界面。