Skip to content

Commit 45fcd8d

Browse files
committed
docs: minor improvements
1 parent 1d56ad8 commit 45fcd8d

3 files changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This is the replication package for our paper _Classifying Edits to Variability
1111
This replication package consists of four parts:
1212

1313
1. **DiffDetective**: For our validation, we built _DiffDetective_, a java library and command-line tool to classify edits to variability in git histories of preprocessor-based software product lines.
14-
2. **Appendix**: The appendix of our paper is given in PDF format in the file [appendix.pdf](appendix.pdf).
14+
2. **Appendix**: The appendix of our paper is given in PDF format in the file [appendix.pdf][appendix].
1515
3. **Haskell Formalization**: We provide an extended formalization in the Haskell programming language as described in our appendix. Its implementation can be found in the Haskell project in the [proofs](proofs) directory.
1616
4. **Dataset Overview**: We provide an overview of the 44 inspected datasets with updated links to their repositories in the file [docs/datasets.md][dataset].
1717

@@ -73,7 +73,7 @@ DiffDetective's code base is documented with javadoc and can be accessed on this
7373

7474
## 2. Appendix
7575

76-
Our appendix consists of:
76+
Our [appendix][appendix] consists of:
7777
1. An extended formalization of our concepts in the [Haskell][haskell] programming language. The corresponding source code is also part of this replication package (see below).
7878
2. The proofs for (a) the completeness of variation tree diffs to represent edits to variation trees, and (b) the completeness and unambiguity of our elementary edit patterns.
7979
3. An inspection of edit patterns from related work to show that existing patterns are either composite patterns built from our elementary patterns or similar to our elementary patterns.
@@ -110,6 +110,7 @@ The input file must have the same format as the other dataset files (i.e., repos
110110
[difftree_class]: src/main/java/org/variantsync/diffdetective/diff/difftree/DiffTree.java
111111
[haskell]: https://www.haskell.org/
112112
[dataset]: docs/datasets.md
113+
[appendix]: appendix.pdf
113114

114115
[documentation]: https://variantsync.github.io/DiffDetective/docs/javadoc/
115116
[website]: https://variantsync.github.io/DiffDetective/

REQUIREMENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ None
55
## Software Requirements
66

77
We do not require a certain operating system or prepared environment.
8-
We tested our setup on Windows 10, WSL2, and Linux.
8+
We tested our setup on Windows 10, WSL2, and Manjaro.
99

1010
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.

STATUS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The `proofs` Haskell project provides an extended formal specification of our th
2828
The library is accompanied by a small demo application that shows an example test case for our proof for completeness, by creating a variation tree diff from two variation trees and re-projecting them.
2929

3030
## Claims
31-
We claim the _Artifacts Available_ badge as we made our artefacts publicly available on [Github][ddgithub] and [Zenodo][ddzenodo].
31+
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].
3232

3333
We claim the _Artifacts Evaluated Reusable_ badge as we implemented DiffDetective as a reusable library (see above).
3434
Furthermore, both DiffDetective and our Haskell formalization serve as reference implementations if researchers or practitioners want to reimplement our theory in other programming languages.
@@ -37,3 +37,4 @@ Furthermore, both DiffDetective and our Haskell formalization serve as reference
3737
[ddzenodo]: UNDEFINED
3838
[ddappendix]: https://github.com/VariantSync/DiffDetective/raw/esecfse22/appendix.pdf
3939
[ddproofs]: https://github.com/VariantSync/DiffDetective/tree/esecfse22/proofs
40+
[ddlicense]: https://github.com/VariantSync/DiffDetective/blob/main/LICENSE.LGPL3

0 commit comments

Comments
 (0)