Как мне сообщить об опечатке (отправив файл diff)?

Question

Я бы хотел максимально упростить исправление опечаток для разработчиков R. Как я могу отправить файл сравнения с таким «патчем»?

Кроме того, куда я должен отправить опечатку? Через электронную почту? Опубликовать ошибку? Отправить его на r-devel?

Меня больше всего волнуют мелкие опечатки, такие как орфографические ошибки или грамматические исправления.

Я не могу вспомнить, где была последняя опечатка, которую я видел, но только в качестве примера, давайте просто предположим, что я хотел бы изменить "back" на "backward" in "back compatibility в файле справки для ls. Как можно Сделать различий патч?

Спасибо

Answer 1

Патчи часто делаются с использованием унифицированного контекста diff.Вы можете создать такой diff, используя 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

Обратите внимание, что различия во многих системах контроля версий отображают унифицированный контекстный diff.

Что касается того, куда отправлять ошибки в R: похоже, для этого есть встроенная функция: bug.report.Кроме того, есть веб-интерфейс для системы отслеживания ошибок R .

Answer 2

@ Совет Дэвида Альбера о форматах diff хорош (хотя я часто использую diff -c вместо этого), но я позволю себе не согласиться с лучшей целью (он предлагает bug.report и систему отслеживания ошибок R).

• Для простых опечаток обычно лучше использовать быстрое электронное письмо с достаточным неформальным контекстом для списка рассылки r-devel@r-project.org (убедитесь, что вы используете последнюю версию! - см. Следующий пункт). Вот как я это делаю, и разработчики R предпочитают его, потому что это означает, что им не приходится иметь дело с полным механизмом сообщения об ошибках. (Единственная документация по этому протоколу, которую я могу легко найти - это заметка Брайана Рипли в 2007 году .)
• Если вы собираетесь сообщать об ошибках более систематически, лучшее, что вы можете сделать для инвестирования, это получить последний выпуск Subversion от https://svn.R -project.org / R / trunk (здесь есть краткое, хотя и немного устаревшее описание ), внесите изменения в файл Rd, а затем запустите svn diff, чтобы получить diff-файлы для последней версии. Как указано выше, отправьте его на r-devel (я полагаю, что текстовые вложения сохраняются в электронном письме на r-devel).
• Не забывайте об обычных предостережениях при отправке отчетов об ошибках: (1) убедитесь, что вы сообщаете о самой последней версии (как указано выше, SVN лучше, если вы можете ее выдержать); (2) убедитесь, что все, что вы сообщаете, определенно ошибка / опечатка; (3) убедитесь, что сообщили в соответствующие органы, то есть сообщите об ошибках / опечатках в предоставленных пакетах сопровождающему (соответствующий пакет должен быть указан в начале файла справки, и maintainer("pkg") находит адрес электронной почты сопровождающий).