Archiving files

From GSA

The GATK svn includes a archive area at the root of the repository. The archive is for files that aren't ready for use at the moment, but will be completely or partially resurrected at some point in the future. In other words, the archive should store code and data that are ahead of their time, not files that have outlived their purpose.

Rules for use of the archive are as follows:

• Files going into the archive should be well commented.
• Files going into the archive do not need to compile.
• Files should be moved into the archive with 'svn mv', to preserve svn file history.
• Files should mirror their location in the main repository; however, we're not going to bother splitting the archive into playground and core. Everything in the archive is basically playground.

For example, I would archive DepthOfCoverage as follows:

Sting/java/src/org/broadinstitute/sting/gatk/walkers/DepthOfCoverageWalker.java -> Sting/archive/java/src/org/broadinstitute/sting/gatk/walkers/DepthOfCoverageWalker.java

But FlagStatReadWalker would have the 'playground' package removed.

Sting/java/src/org/broadinstitute/sting/playground/gatk/walkers/FlagStatReadWalker.java -> Sting/archive/java/src/org/broadinstitute/sting/gatk/walkers/FlagStatReadWalker.java

• Every few months, we'll ask group members to review the list of walkers in the archive. If we can't find someone to defend the existence of a file in the archive, that file will be deleted.