Skip to content

Commit 27493a4

Browse files
committed
docs: minor fixes
1 parent c089bfb commit 27493a4

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

INSTALL.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ In the following, we describe how to replicate the validation from our paper (Se
44
The instructions explain how to build the Docker image and run the validation in a Docker container.
55

66
### 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:
88

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.
1111
Docker's [documentation](https://docs.docker.com/engine/install/) contains instructions for common distributions.
1212

1313
Then, start the docker deamon.
@@ -31,7 +31,7 @@ Clone this repository to a directory of your choice using git:
3131
```shell
3232
git clone https://github.com/VariantSync/DiffDetective.git
3333
```
34-
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:
3535
```shell
3636
cd DiffDetective
3737
```
@@ -60,7 +60,7 @@ To execute the replication you can run the `execute` script corresponding to you
6060
> Therefore, we offer a short verification (5-10 minutes) which runs DiffDetective on only four of the datasets.
6161
> You can run it by providing "verification" as argument instead of "replication" (i.e., `.\execute.bat verification`, `./execute.sh verification`).
6262
> 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.
6464
> #### Windows:
6565
> `.\stop-execution.bat`
6666
> #### Linux/Mac (bash):
@@ -137,7 +137,7 @@ The input file must have the same format as the other dataset files (i.e., repos
137137
### 'Got permission denied while trying to connect to the Docker daemon socket'
138138
`Problem:` This is a common problem under Linux, if the user trying to execute Docker commands does not have the permissions to do so.
139139

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`).
141141

142142
### 'Unable to find image 'replication-package:latest' locally'
143143
`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
147147
### No results after verification, or 'cannot create directory '../results/validation/current': Permission denied'
148148
`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.
149149

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`).
151151
Then, create a new _results_ directory without elevated permissions, or execute `git restore .` to restore the deleted directory.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ To execute the replication you can run the `execute` script corresponding to you
4545
> Therefore, we offer a short verification (5-10 minutes) which runs DiffDetective on only four of the datasets.
4646
> You can run it by providing "verification" as argument instead of "replication" (i.e., `.\execute.bat verification`, `./execute.sh verification`).
4747
> If you want to stop the execution, you can call the provided script for stopping the container in a separate terminal.
48-
> When restarted, the replication will continue processing by restarting at the last unfinished repository.
48+
> When restarted, the execution will continue processing by restarting at the last unfinished repository.
4949
> #### Windows:
5050
> `.\stop-execution.bat`
5151
> #### Linux/Mac (bash):

REQUIREMENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ None
77
We do not require a certain operating system or prepared environment.
88
We tested our setup on Windows 10, WSL2, and Manjaro.
99

10-
To run DiffDetective, JDK16 and Maven are required.
10+
To run DiffDetective, JDK16, and Maven are required.
1111
Dependencies to other packages are documented in the maven build file ([pom.xml](pom.xml)) and are handled automatically by Maven.
1212
Alternatively, the docker container can be used on any system supporting docker.
1313
Docker will take care of all requirements and dependencies to replicate our validation.

STATUS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The library is accompanied by a small demo application that shows an example tes
3333
The `proofs` project is described in detail in our appendix.
3434

3535
## 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.
3737

3838
We claim the _Artifacts Evaluated Reusable_ badge as we implemented DiffDetective as a reusable library (see above).
3939
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

Comments
 (0)