You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,10 @@ In the following, we describe how to replicate the validation from our paper (Se
4
4
The instructions explain how to build the Docker image and run the validation in a Docker container.
5
5
6
6
### 1. Install Docker (if required)
7
-
How to install Docker depends on your operating system.
7
+
How to install Docker depends on your operating system:
8
8
9
-
-Windows or Mac: You can find download and installation instructions [here](https://www.docker.com/get-started).
10
-
-Linux Distributions: How to install Docker on your system, depends on your distribution. However, the chances are high that Docker is part of your distributions package database.
9
+
-_Windows or Mac_: You can find download and installation instructions [here](https://www.docker.com/get-started).
10
+
-_Linux Distributions_: How to install Docker on your system, depends on your distribution. The chances are high that Docker is part of your distributions package database.
11
11
Docker's [documentation](https://docs.docker.com/engine/install/) contains instructions for common distributions.
12
12
13
13
Then, start the docker deamon.
@@ -31,7 +31,7 @@ Clone this repository to a directory of your choice using git:
Then, navigate to the root of your local clone of this repository.
34
+
Then, navigate to the root of your local clone of this repository:
35
35
```shell
36
36
cd DiffDetective
37
37
```
@@ -60,7 +60,7 @@ To execute the replication you can run the `execute` script corresponding to you
60
60
> Therefore, we offer a short verification (5-10 minutes) which runs DiffDetective on only four of the datasets.
61
61
> You can run it by providing "verification" as argument instead of "replication" (i.e., `.\execute.bat verification`, `./execute.sh verification`).
62
62
> If you want to stop the execution, you can call the provided script for stopping the container in a separate terminal.
63
-
> When restarted, the replication will continue processing by restarting at the last unfinished repository.
63
+
> When restarted, the execution will continue processing by restarting at the last unfinished repository.
64
64
> #### Windows:
65
65
> `.\stop-execution.bat`
66
66
> #### Linux/Mac (bash):
@@ -137,7 +137,7 @@ The input file must have the same format as the other dataset files (i.e., repos
137
137
### 'Got permission denied while trying to connect to the Docker daemon socket'
138
138
`Problem:` This is a common problem under Linux, if the user trying to execute Docker commands does not have the permissions to do so.
139
139
140
-
`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`)
140
+
`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`).
141
141
142
142
### 'Unable to find image 'replication-package:latest' locally'
143
143
`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.
@@ -147,5 +147,5 @@ The input file must have the same format as the other dataset files (i.e., repos
147
147
### No results after verification, or 'cannot create directory '../results/validation/current': Permission denied'
148
148
`Problem:` This problem can occur due to how permissions are managed inside the Docker container. More specifically, it will appear, if Docker is executed with elevated permissions (i.e., `sudo`) and if there is no [results](results) directory because it was deleted manually. In this case, Docker will create the directory with elevated permissions, and the Docker user has no permissions to access the directory.
149
149
150
-
`Fix:` If there is a _results_ directory delete it with elevated permission (e.g., `sudo rm -r results`).
150
+
`Fix:` If there is a _results_ directory, delete it with elevated permission (e.g., `sudo rm -r results`).
151
151
Then, create a new _results_ directory without elevated permissions, or execute `git restore .` to restore the deleted directory.
Copy file name to clipboardExpand all lines: STATUS.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ The library is accompanied by a small demo application that shows an example tes
33
33
The `proofs` project is described in detail in our appendix.
34
34
35
35
## Claims
36
-
We claim the _Artifacts Available_ badge as we made our artefacts publicly available on [Github][ddgithub] and [Zenodo][ddzenodo] with an [open-source license][ddlicense].
36
+
We claim the _Artifacts Available_ badge as we made our artefacts publicly available on [Github][ddgithub] and [Zenodo][ddzenodo] with an [open-source license][ddlicense]. All [44 input datasets][ddforks] are open-source projects and publicly available.
37
37
38
38
We claim the _Artifacts Evaluated Reusable_ badge as we implemented DiffDetective as a reusable library (see above).
39
39
Furthermore, both DiffDetective and our Haskell formalization serve as reference implementations if researchers or practitioners want to reimplement our theory in other programming languages.
0 commit comments