summaryrefslogtreecommitdiff
path: root/doc/git-annex-proxy.mdwn
blob: 2744b11347ebf0e9d869b0dddfaf9fdc7b515d8d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# NAME

git-annex proxy - safely bypass direct mode guard

# SYNOPSIS

git annex proxy `-- git cmd [options]`

# DESCRIPTION

Only useful in a direct mode repository, this runs the specified git
command with a temporary work tree, and updates the working tree to
reflect any changes staged or committed by the git command.

For example, to revert the most recent change that was committed
to the repository:

	git annex proxy -- git revert HEAD
  
To check out a past version of the repository:

	git annex proxy -- git checkout HEAD^^
  
To rename a directory:

	git annex proxy -- git mv mydir newname

To commit the changes to a specific file, first use git annex add to
stage the changes in the index, and then proxy a commit:

	git annex add myfile
	git annex proxy -- git commit myfile -m foo

The temporary work tree that the git command is run in is set up by
checking out all files that are in the index, and copying (or hard linking)
any unstaged files from the real work tree. Since the git command is run
using this temporary work tree, it won't see eg, local modifications to
files. So, it probably is not useful to proxy a command like "git add".
However, you can use the proxy with any git command you like, as long as
you think about how it will interact with the temporary work tree.

# SEE ALSO

[[git-annex]](1)

[[git-annex-direct]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.