Какие документы следует добавить в репозиторий SVN?

Question

Я работаю над личным проектом, и хотя у меня есть вики, я бы хотел добавить разные файлы документации в репозиторий svn. К таким файлам относятся XML (сгенерированный monodoc), а также диаграммы UML (сгенерированные с помощью dia).

В этой хорошей идее я слышу / читаю комментарии о том, что нельзя добавлять двоичные данные в репозиторий svn и пытаюсь просто сохранить код, верно?

Answer 1

Речь идет не о двоичном, а о текстовом, речь идет о том, сгенерирован он или нет. Если вы генерируете эти вещи, почему бы не добавить источник генерации вместе с инструментами для генерации в SVN, а не сами генерируемые файлы? Затем, в сочетании с хорошими сценариями сборки (также в SVN), вы всегда можете восстановить их снова. В противном случае вы рискуете, чтобы сгенерированные файлы не синхронизировались с исходными файлами, или люди, воспринимающие сгенерированные файлы как «основные», и их изменения были сбиты с толку.

Answer 2

Я бы добавил все документы, библиотеки и все остальное в хранилище. В основном все, что имеет отношение к проекту, потому что тогда каждый имеет к нему доступ и будет иметь самую последнюю версию.

Answer 3

Я не склонен помещать много бинарных файлов в Subversion, за исключением, возможно, версий конечного продукта. Как правило, если я могу генерировать что-то на лету, я не беспокоюсь, если только это не занимает слишком много времени, тогда я просто вставляю их туда.

Тем не менее, я бы предпочел бросить копию последних документов (независимо от того, смогу ли я их различить или нет) в svn, если это облегчит мою жизнь. Всегда хорошо иметь возможность взять в руки копию (будь то последняя или предыдущая версия) чего-либо, когда начальник или клиент говорит: «У вас есть документ xyz с октября?».

Что касается ваших конкретных потребностей, хорошо ... только вы знаете наверняка, но место на диске дешево, и если есть смысл иметь их там, я бы сделал это.

Только мои два цента.

Answer 4

Я думаю, что это нормально, чтобы сохранить любые файлы, которые не могут быть восстановлены из исходных файлов в SVN. Это включает в себя документацию dia / xml и изображения.

Конечно, лучше по возможности хранить их в виде текста, поэтому лучше использовать электронную таблицу CSV, чем файл Excel.

Answer 5

Я помещаю данные, которые я создаю, и могу изменить их в SVN. Например, я помещаю исходный код, файлы решений и сборок, а также документацию в SVN. Я стараюсь избегать добавления сгенерированных файлов, таких как PDF-файлы, сгенерированные из других форматов, двоичные файлы и сторонние библиотеки. Содержимое, которое я не генерирую и не изменяю, например руководства других производителей, попадает в общую папку. Это все вполне соответствует тому, что говорят другие люди.

Тем не менее, я добавляю сгенерированные файлы и двоичные файлы, когда я (1) делаю релиз и мне нужно сохранять точно выпущенные файлы или (2) файлы сложно создавать, и я не хочу, чтобы другие разработчики имели дело с процессом сборки. Иногда для удобства я добавляю сторонние библиотеки, чтобы новым разработчикам не приходилось их искать, загружать и устанавливать - это очень полезно для меня, поскольку многие из моих машин для разработки не имеют подключения к Интернету.

Answer 6

Если у вас есть система документации, которая может быть с умом объединена и распространена, я думаю, что «источник» документов должен быть в дереве. I.E файл .tex, а не .pdf.

Если вы переходите с выпуска, который нуждается в редактировании кода и документации, это изменение документации также будет в SVN. Когда вы делаете релиз, вы создаете бинарный файл из кода и документацию из источника документации.

Если вы бэкпортируете материал из филиала, вы также можете сделать бэкпорт соответствующей документации.

Answer 7

Мое личное правило - не добавлять вещи, которые вы можете генерировать из других вещей. Хорошим примером являются файлы документации, которые могут быть сгенерированы из комментариев кода.

Answer 8

svn прекрасно обрабатывает двоичные файлы, но я бы не стал добавлять встроенные файлы, только исходники. Если ваша документация создана из других файлов, не регистрируйте ее, попросите других разработчиков создать ее самостоятельно. Только если файлы сложно собрать, я проверю их в Subversion.

Answer 9

Добавьте все, что связано с проектом. Добавление двоичных файлов (например, библиотек) не проблема, , но : избегайте добавления дублированных данных, таких как файлы, скомпилированные из источника.

Answer 10

Subversion прекрасно обрабатывает двоичные файлы:

http://subversion.tigris.org/faq.html#binary-files

Так что, если есть смысл поместить эти файлы в дерево исходных текстов, я бы сказал, зарегистрируйте их.