Skip to content

Commit

Permalink
Add more metadata and disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
PedroJSilva2001 committed Mar 10, 2024
1 parent d8cdfbf commit 67e2afc
Show file tree
Hide file tree
Showing 9 changed files with 32 additions and 3 deletions.
18 changes: 18 additions & 0 deletions DISCLAIMER
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
- The experiments done in this project utilize code snippets from many open-source projects.
- The following concerns apply:
1. **License Compliance:** The extracted code snippets are subject to the licenses of the respective open-source projects. The users of this project/thesis are responsible for understanding and complying with the terms of these licenses.
2. **Attribution:** The original authors and contributors of the open-source projects deserve credit for their work. Please refer to the metadata provided for information on the source of each function.
3. **No Endorsement:** The inclusion of code from open-source projects in this project/thesis does not imply endorsement or support from the original authors or the open-source community.

- The snippets are included in [snippets folder](/experiments/snippets/) and their only alterations include formatting and removal of some comments which don't add relevant information to the task at hand.

- The [metadata folder](/experiments/metadata/) includes relevant information on each open-source project (project.json files), namely:
- The project's name
- The project's organization
- Source code repository
- License

- Each project folder in the [metadata folder](/experiments/metadata/) also includes information on each snippet extracted from that project, namely:
- Hash of the commit where the snippet was extracted
- Function name(s) of the snippets
- Function path(s) of the snippets on the project tree
5 changes: 4 additions & 1 deletion experiments/init_experiment.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,9 @@ def main():
else:
project_metadata = {
"org": input("Enter project organization: "),
"project": input("Enter project name: ")
"project": input("Enter project name: "),
"repository": input("Enter project repository: "),
"license": input("Enter project license: ")
}

os.mkdir(project_path)
Expand All @@ -154,6 +156,7 @@ def main():
experiment["name"] = input("Enter the experiment name (press enter for same name as the snippet): ")
experiment["snippet"] = input("Enter the snippet name: ")
experiment["name"] = experiment["snippet"] if experiment["name"] == "" else experiment["name"]
experiment["commit_hash"] = input("Enter the commit hash: ")
experiment["function_name"] = input("Enter the function name: ")
experiment["function_path"] = input("Enter the function path: ")

Expand Down
1 change: 1 addition & 0 deletions experiments/metadata/doom/am_map_1.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "am_map_1",
"snippet": "am_map_1",
"commit_hash": "a77dfb96cb91780ca334d0d4cfd86957558007e0",
"function_name": "AM_getIslope",
"function_path": "/linuxdoom-1.10/am_map.c",
"language": "c",
Expand Down
1 change: 1 addition & 0 deletions experiments/metadata/doom/am_map_2.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "am_map_2",
"snippet": "am_map_2",
"commit_hash": "a77dfb96cb91780ca334d0d4cfd86957558007e0",
"function_name": "AM_activateNewScale",
"function_path": "/linuxdoom-1.10/am_map.c",
"language": "c",
Expand Down
2 changes: 1 addition & 1 deletion experiments/metadata/doom/am_map_3.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "am_map_3",
"snippet": "am_map_3",
"commit_hash": "a77dfb96cb91780ca334d0d4cfd86957558007e0",
"function_name": "AM_saveScaleAndLoc",
"function_path": "/linuxdoom-1.10/am_map.c",
"language": "c",


"errors": {
"use_undeclared_identifier": [
"old_m_x",
Expand Down
1 change: 1 addition & 0 deletions experiments/metadata/doom/am_map_4.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "am_map_4",
"snippet": "am_map_4",
"commit_hash": "a77dfb96cb91780ca334d0d4cfd86957558007e0",
"function_name": "AM_restoreScaleAndLoc",
"function_path": "/linuxdoom-1.10/am_map.c",
"language": "c",
Expand Down
1 change: 1 addition & 0 deletions experiments/metadata/doom/am_map_5.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "am_map_5",
"snippet": "am_map_5",
"commit_hash": "a77dfb96cb91780ca334d0d4cfd86957558007e0",
"function_name": "AM_addMark",
"function_path": "/linuxdoom-1.10/am_map.c",
"language": "c",
Expand Down
2 changes: 2 additions & 0 deletions experiments/metadata/doom/am_map_6.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
{
"name": "am_map_6",
"snippet": "am_map_6",
"commit_hash": "a77dfb96cb91780ca334d0d4cfd86957558007e0",
"function_name": "AM_findMinMaxBoundaries",
"function_path": "/linuxdoom-1.10/am_map.c",
"language": "c",

"errors": {
"use_undeclared_identifier": [
"max_y",
Expand Down
4 changes: 3 additions & 1 deletion experiments/metadata/doom/project.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"project": "DOOM",
"org": "id-Software"
"org": "id-Software",
"repository": "https://github.com/id-Software/DOOM",
"license": "GPLv2"
}

0 comments on commit 67e2afc

Please sign in to comment.