Skip to content

Commit d5eea3d

Browse files
docs: add more documentatoin
1 parent 6a5a27c commit d5eea3d

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,21 @@ docker run --rm -v "./evaluation-workdir/":"/home/user/evaluation-workdir" mpatc
133133
> Depending on your hardware, the full reproduction may require a very long time. The expected runtime are 5-10 days, but the reproduction may also require several weeks if the drive is too slow.
134134
135135

136-
## Local dataset setup
137-
- The `repo-sample.zip` file in `evaluation-workdir/data/` contains a single yaml file which enumerates the metadata for all sampled repositories.
138-
- To unpack the dataset of cherry picks, you may need to perform the following command on a Linux console first. Thereafter, you can extract all the mined cherry picks from the created `unsplit-mined-cherries.zip` file.
139-
```shell
140-
zip -s 0 mined-cherries.zip --out unsplit-mined-cherries.zip
141-
```
136+
137+
## Troubleshooting
138+
139+
### 'Got permission denied while trying to connect to the Docker daemon socket'
140+
`Problem:` This is a common problem under Linux, if the user trying to execute Docker commands does not have the permissions to do so.
141+
142+
`Fix:` You can fix this problem by either following the [post-installation instructions](https://docs.docker.com/engine/install/linux-postinstall/), or by executing the scripts in the replication package with elevated permissions (i.e., `sudo`).
143+
144+
### 'Unable to find image 'mpatch-reproduction:latest' locally'
145+
`Problem:` The Docker container could not be found. This either means that the name of the container that was built does not fit the name of the container that is being executed (this only happens if you changed the provided scripts), or that the Docker container was not built yet.
146+
147+
`Fix:` Follow the instructions described above in the section `Build the Docker Container`.
148+
149+
### Failed to load class "org.slf4j.impl.StaticLoggerBinder"
150+
`Problem:` An operation within the initialization phase of the logger library we use (tinylog) failed.
151+
152+
`Fix:` Please ignore this warning. Tinylog will fall back onto a default implementation (`Defaulting to no-operation (NOP) logger implementation`) and logging will work as expected.
153+

0 commit comments

Comments
 (0)