Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Which documents should be added to a svn repo?

Tags:

svn

I am working on a personal project and although I do have a wiki I would like to add different documentation files to the svn repository. Such files include XML (generated by monodoc) as well as UML diagrams(generated with dia).

In this a good idea, I have hear/read comments about not adding binary data to the svn repo and try to just keep code, is that right???

like image 797
mandel Avatar asked Nov 29 '22 20:11

mandel


2 Answers

It's not about binary versus text, it's about whether it's generated or not. If you generate these things, why not add the source of the generation along with the tools to do the generation to SVN rather than the generated files themselves? Then, coupled with good build scripts (also in SVN), you can always regenerate them again. Otherwise, you run the risk of the generated files being out of sync with the source files, or of people treating the generated files as "masters" and having their changes confusingly overwritten.

like image 173
Kent Boogaart Avatar answered Dec 02 '22 10:12

Kent Boogaart


I would add all documents, libraries and anything else to the repository. Basically anything that is relevant to the project because then everyone has access to it and will also have the latest version.

like image 26
Garry Shutler Avatar answered Dec 02 '22 10:12

Garry Shutler