Difference: ProjectSVNStructure (4 vs. 5)

Revision 52009-09-21 - AllanRempel

Line: 1 to 1

META TOPICPARENT	name="PsmSpace"

These are some thoughts I put together on how to structure an SVN repository for a new project. I wrote them while setting up the repository for the DepthPerception repository, because I thought my previous 2 repositories (HDRAmbLightPaper and Mesopic) were set up suboptimally. In particular:

Line: 34 to 34

A project directory can be used as a place to store files that are related to that project but don't necessarily fit obviously into any well-developed subdirectory (of the project directory) structure. These files can be simply left un-checked-in until such time as it makes sense to check them in as part of a more well-developed structure.

Changed:

<
<

In most cases, certain types of files should not be checked in. These include compiled files or other files that are derived from source files, such as .o, .so, .dep, .exe, .obj, .dll, .asv, .aux, .bbl, .log, .blg, .dvi, .ps, .pdf, etc. This is to avoid the saving of extraneous files, especially if they're large, and also to avoid continuously resaving subsequent extraneous versions, which can happen because every subsequent build will contain a (different) version of that derived file which will flag the whole directory as changed even if it really isn't. If it is really desired to keep a particular executable or derived file because its importance is high, then a tag should be made of the source code version that produced that file, and then that file can be SVN added and committed.

>
>

In most cases, certain types of files should not be checked in. These include compiled files or other files that are derived from source files, such as .o, .so, .dep, .exe (?), .obj, .dll (?), .asv, .aux, .bbl, .log, .blg, .dvi, etc. This is to avoid the saving of extraneous files, especially if they're large, and also to avoid continuously resaving subsequent extraneous versions, which can happen because every subsequent build will contain a (different) version of that derived file which will flag the whole directory as changed even if it really isn't. If it is really desired to keep a particular executable or derived file because its importance is high, then a tag should be made of the source code version that produced that file, and then that file can be SVN added and committed. Some derived files (like .pdf) may be worth checking in because they can be important files that have been submitted for some kind of review, and any such file should be kept.

A project directory should have a "Papers" directory in which are stored electronic copies of papers relevant to that project. Note that this may change if the use of papers-organizing software such as Mendeley becomes prominent within PSM.

View topic | History: r6 < r5 < r4 < r3 | More topic actions...