MultiVersionControl

java.lang.Object
- plume.MultiVersionControl

Deprecated.
use org.plumelib.multiversioncontrol.MultiVersionControl
```
@Deprecated
public class MultiVersionControl
extends java.lang.Object
```
This program, mvc for Multiple Version Control, lets you run a version control command, such as "status" or "update", on a set of CVS/Git/Hg/SVN checkouts rather than just one.
This program simplifies managing your checkouts/clones. You might want to update/pull all of them, or you might want to know whether any of them have uncommitted changes. When setting up a new account, you might want to clone or check them all out. This program does any of those tasks. In particular, it accepts these arguments:
```
   clone     -- Clone (check out) all repositories.
   checkout  -- Same as clone
   pull      -- Pull and update all clones.
   update    -- Same as pull.
   status    -- Show files that are changed but not committed, or committed
                but not pushed, or have shelved/stashed changes.
   list      -- List the clones/checkouts that this program is aware of.
 
```
(The commit action is not supported, because that is not something that should be done in an automated way -- it needs a user-written commit message.)
You can specify the set of checkouts/clones for the program to manage, or it can search your directory structure to find all of your checkouts, or both. To list all un-committed changed files under your home directory:
```
java plume.MultiVersionControl status --search=true
```
Command-line arguments
The command-line options are as follows:
- --home=string. User home directory
- --checkouts=string. File with list of checkouts. Set it to /dev/null to suppress reading. Defaults to $HOME/.mvc-checkouts. [default ~/.mvc-checkouts]
- --dir=string [+]. Directory under which to search for checkouts; default=home dir
- --ignore-dir=string [+]. Directory under which to NOT search for checkouts
- --search=boolean. Search for all checkouts, not just those listed in a file [default false]
- --show=boolean. Display commands as they are executed [default false]
- --print-directory=boolean. Print the directory before executing commands [default false]
- --dry-run=boolean. Do not execute commands; just print them. Implies --show --redo-existing [default false]
- --redo-existing=boolean. Default is for checkout command to skip existing directories. [default false]
- --timeout=int. Terminating the process can leave the repository in a bad state, so set this rather high for safety. Also, the timeout needs to account for the time to run hooks (that might recompile or run tests). [default 600]
- -q --quiet=boolean. Run quietly (e.g., no output about missing directories) [default true]
- --cvs-executable=string. Path to the cvs program [default cvs]
- --git-executable=string. Path to the git program [default git]
- --hg-executable=string. Path to the hg program [default hg]
- --svn-executable=string. Path to the svn program [default svn]
- --insecure=boolean. Pass --insecure argument to hg (and likewise for other programs) [default false]
- --cvs-arg=string [+]. Extra argument to pass to the cvs program
- --git-arg=string [+]. Extra argument to pass to the git program
- --hg-arg=string [+]. Extra argument to pass to the hg program
- --svn-arg=string [+]. Extra argument to pass to the svn program
- --debug=boolean. Print debugging output [default false]
- --debug-replacers=boolean. Debug 'replacers' that filter command output [default false]
- --debug-process-output=boolean. Lightweight debugging of 'replacers' that filter command output [default false]
[+] marked option can be specified multiple times
File format for .mvc-checkouts file
The remainder of this document describes the file format for the .mvc-checkouts file.
(Note: because mvc can search for all checkouts in your directory, you don't need a .mvc-checkouts file. Using a .mvc-checkouts file makes the program faster because it does not have to search all of your directories. It also permits you to process only a certain set of checkouts.)
The .mvc-checkouts file contains a list of sections. Each section names either a root from which a sub-part (e.g., a module or a subdirectory) will be checked out, or a repository all of which will be checked out. Examples include:
```
 CVSROOT: :ext:login.csail.mit.edu:/afs/csail.mit.edu/u/m/mernst/.CVS/.CVS-mernst
 SVNROOT: svn+ssh://tricycle.cs.washington.edu/cse/courses/cse403/09sp
 SVNREPOS: svn+ssh://login.csail.mit.edu/afs/csail/u/a/akiezun/.SVN/papers/parameterization-paper/trunk
 HGREPOS: https://jsr308-langtools.googlecode.com/hg
```
Within each section is a list of directories that contain a checkout from that repository. If the section names a root, then a module or subdirectory is needed. By default, the directory's basename is used. This can be overridden by specifying the module/subdirectory on the same line, after a space. If the section names a repository, then no module information is needed or used.
When performing a checkout, the parent directories are created if needed.
In the file, blank lines, and lines beginning with "#", are ignored.
Here are some example sections:
```
 CVSROOT: :ext:login.csail.mit.edu:/afs/csail.mit.edu/group/pag/projects/classify-tests/.CVS
 ~/research/testing/symstra-eclat-paper
 ~/research/testing/symstra-eclat-code
 ~/research/testing/eclat

 SVNROOT: svn+ssh://login.csail.mit.edu/afs/csail/group/pag/projects/.SVNREPOS/
 ~/research/typequals/igj
 ~/research/typequals/annotations-papers

 SVNREPOS: svn+ssh://login.csail.mit.edu/afs/csail/group/pag/projects/abb/REPOS
 ~/prof/grants/2008-06-abb/abb

 HGREPOS: https://checker-framework.googlecode.com/hg/
 ~/research/types/checker-framework

 SVNROOT: svn+ssh://login.csail.mit.edu/afs/csail/u/d/dannydig/REPOS/
 ~/research/concurrency/concurrentPaper
 ~/research/concurrency/mit.edu.concurrencyRefactorings concurrencyRefactorings/project/mit.edu.concurrencyRefactorings
 
```
Furthermore, these 2 sections have identical effects:
```
 SVNROOT: https://crashma.googlecode.com/svn/
 ~/research/crashma trunk

 SVNREPOS: https://crashma.googlecode.com/svn/trunk
 ~/research/crashma
```
and, all 3 of these sections have identical effects:
```
 SVNROOT: svn+ssh://login.csail.mit.edu/afs/csail/group/pag/projects/
 ~/research/typequals/annotations

 SVNROOT: svn+ssh://login.csail.mit.edu/afs/csail/group/pag/projects/
 ~/research/typequals/annotations annotations

 SVNREPOS: svn+ssh://login.csail.mit.edu/afs/csail/group/pag/projects/annotations
 ~/research/typequals/annotations
```

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`checkouts` Deprecated. File with list of checkouts.
`java.util.List<java.lang.String>`	`cvs_arg` Deprecated.
`java.lang.String`	`cvs_executable` Deprecated.
`static boolean`	`debug` Deprecated.
`boolean`	`debug_process_output` Deprecated.
`boolean`	`debug_replacers` Deprecated.
`java.util.List<java.lang.String>`	`dir` Deprecated.
`boolean`	`dry_run` Deprecated.
`java.util.List<java.lang.String>`	`git_arg` Deprecated.
`java.lang.String`	`git_executable` Deprecated.
`java.util.List<java.lang.String>`	`hg_arg` Deprecated.
`java.lang.String`	`hg_executable` Deprecated.
`static java.lang.String`	`home` Deprecated.
`java.util.List<java.lang.String>`	`ignore_dir` Deprecated.
`boolean`	`insecure` Deprecated.
`boolean`	`print_directory` Deprecated.
`boolean`	`quiet` Deprecated.
`boolean`	`redo_existing` Deprecated. Default is for checkout command to skip existing directories.
`boolean`	`search` Deprecated.
`boolean`	`show` Deprecated.
`java.util.List<java.lang.String>`	`svn_arg` Deprecated.
`java.lang.String`	`svn_executable` Deprecated.
`int`	`timeout` Deprecated. Terminating the process can leave the repository in a bad state, so set this rather high for safety.

Constructor Summary

Constructors
Constructor and Description

MultiVersionControl(java.lang.String[] args)
Deprecated.

Constructors
Constructor and Description
`MultiVersionControl(java.lang.String[] args)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`main(java.lang.String[] args)` Deprecated.
`void`	`parseArgs(java.lang.String[] args)` Deprecated.
`void`	`process(java.util.Set<plume.MultiVersionControl.Checkout> checkouts)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- home
```
public static java.lang.String home
```
  Deprecated.
- checkouts
```
public java.lang.String checkouts
```
  Deprecated.
  
  File with list of checkouts. Set it to /dev/null to suppress reading. Defaults to $HOME/.mvc-checkouts.
- dir
```
public java.util.List<java.lang.String> dir
```
  Deprecated.
- ignore_dir
```
public java.util.List<java.lang.String> ignore_dir
```
  Deprecated.
- search
```
public boolean search
```
  Deprecated.
- show
```
public boolean show
```
  Deprecated.
- print_directory
```
public boolean print_directory
```
  Deprecated.
- dry_run
```
public boolean dry_run
```
  Deprecated.
- redo_existing
```
public boolean redo_existing
```
  Deprecated.
  
  Default is for checkout command to skip existing directories.
- timeout
```
public int timeout
```
  Deprecated.
  
  Terminating the process can leave the repository in a bad state, so set this rather high for safety. Also, the timeout needs to account for the time to run hooks (that might recompile or run tests).
- quiet
```
public boolean quiet
```
  Deprecated.
- cvs_executable
```
public java.lang.String cvs_executable
```
  Deprecated.
- git_executable
```
public java.lang.String git_executable
```
  Deprecated.
- hg_executable
```
public java.lang.String hg_executable
```
  Deprecated.
- svn_executable
```
public java.lang.String svn_executable
```
  Deprecated.
- insecure
```
public boolean insecure
```
  Deprecated.
- cvs_arg
```
public java.util.List<java.lang.String> cvs_arg
```
  Deprecated.
- git_arg
```
public java.util.List<java.lang.String> git_arg
```
  Deprecated.
- hg_arg
```
public java.util.List<java.lang.String> hg_arg
```
  Deprecated.
- svn_arg
```
public java.util.List<java.lang.String> svn_arg
```
  Deprecated.
- debug
```
public static boolean debug
```
  Deprecated.
- debug_replacers
```
public boolean debug_replacers
```
  Deprecated.
- debug_process_output
```
public boolean debug_process_output
```
  Deprecated.

Constructor Detail

MultiVersionControl

public MultiVersionControl(java.lang.String[] args)

Deprecated.

Method Detail

main

public static void main(java.lang.String[] args)

Deprecated.

parseArgs

public void parseArgs(java.lang.String[] args)

Deprecated.

process

public void process(java.util.Set<plume.MultiVersionControl.Checkout> checkouts)

Deprecated.

Class MultiVersionControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

home

checkouts

dir

ignore_dir

search

show

print_directory

dry_run

redo_existing

timeout

quiet

cvs_executable

git_executable

hg_executable

svn_executable

insecure

cvs_arg

git_arg

hg_arg

svn_arg

debug

debug_replacers

debug_process_output

Constructor Detail

MultiVersionControl

Method Detail

main

parseArgs

process