Skip to content

Commit c6667b3

Browse files
authored
doc: fix volume binding paths in README for GumTree
Updated volume binding paths in usage instructions for clarity.
1 parent 16e36ed commit c6667b3

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docker/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ You can also compile the image on your machine. Go to the root GumTree's folder
99
## Usage
1010

1111
To use GumTree's image, You need to:
12-
* bind the "original" folder to the `/diff/left` volume of the container
13-
* bind the "modified" folder to the `/diff/right` volume of the container
12+
* bind the "original" folder to the `/left` volume of the container
13+
* bind the "modified" folder to the `/right` volume of the container
1414
* bind the port `4567` of the container to access GumTree's web interface
1515

16-
The classical way to run a GumTree's container is the command `docker run --rm -v /my/original-folder:/diff/left -v /my/modified-folder:/diff/right -p 4567:4567 gumtreediff/gumtree webdiff left/ right/`. You can consult the diff at the URL `http://localhost:4567`. Of course, all other GumTree's commands are available.
16+
The classical way to run a GumTree's container is the command `docker run --rm -v /my/original-folder:/left -v /my/modified-folder:/right -p 4567:4567 gumtreediff/gumtree webdiff /left /right`.
17+
You can consult the diff at the URL `http://localhost:4567`. Of course, all other GumTree's commands are available.
1718

1819
**Beware, the paths inputs to GumTree's commands are relative to the `/diff` path inside the container.**
1920

@@ -25,13 +26,13 @@ You can easily integrate GumTree's container with Git by adding the following co
2526

2627
```properties
2728
[difftool "gumtree-docker"]
28-
cmd = docker run --rm -v /private/$LOCAL:/diff/left -v /private/$REMOTE:/diff/right -p 4567:4567 gumtreediff/gumtree webdiff left/ right/
29+
cmd = docker run --rm -v /private/$LOCAL:/left -v /private/$REMOTE:/right -p 4567:4567 gumtreediff/gumtree webdiff /left /right
2930
```
3031
### Linux - Windows
3132

3233
```properties
3334
[difftool "gumtree-docker"]
34-
cmd = docker run --rm -v $LOCAL:/diff/left -v $REMOTE:/diff/right -p 4567:4567 gumtreediff/gumtree webdiff left/ right/
35+
cmd = docker run --rm -v $LOCAL:/left -v $REMOTE:/right -p 4567:4567 gumtreediff/gumtree webdiff /left /right
3536
```
3637
### Usage
3738

@@ -46,4 +47,4 @@ You can then use the command `git gd`.
4647

4748
## Debug
4849

49-
If you want to debug GumTree's image use the following command line: `docker run --rm -it -v /my/original-folder:/diff/left -v /my/modified-folder:/diff/right -p 4567:4567 --entrypoint "/bin/bash" gumtreediff/gumtree`.
50+
If you want to debug GumTree's image use the following command line: `docker run --rm -it -v /my/original-folder:/left -v /my/modified-folder:/right -p 4567:4567 --entrypoint "/bin/bash" gumtreediff/gumtree`.

0 commit comments

Comments
 (0)