From 28f6a4f58bcd5d8d9919d98b11c1440b530779a3 Mon Sep 17 00:00:00 2001 From: eleonore12345 Date: Thu, 25 Jul 2024 10:54:34 +0200 Subject: [PATCH] README.md plus jolis --- test/README.md | 3 ++- test/functional_tests/README.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/test/README.md b/test/README.md index 3aeddb8..b4a4e3c 100644 --- a/test/README.md +++ b/test/README.md @@ -7,6 +7,7 @@ Both have to be run from their directory because they rely on relative paths. # Creation of the test repository The script test_repo_creation.sh creates a remote/$REPO_NAME repository. ## Help extract +``` NAME test_repo_creation.sh SYNOPSIS @@ -18,7 +19,7 @@ OPTIONS -h prints the help. -l [link] adds the linked online repository as remote and pushes changes to it. Must be en empty repository. -s creates a submodule remote/$SUB_NAME and includes it in remote/$REPO_NAME. - +``` # Description of the created repository Here is a history of the commits: ### branch main diff --git a/test/functional_tests/README.md b/test/functional_tests/README.md index 2b24771..3877c47 100644 --- a/test/functional_tests/README.md +++ b/test/functional_tests/README.md @@ -8,6 +8,7 @@ Each test consists of calling git_update.sh, eventually after some modifications If all booleans of checks conducted are true, then the boolean case* is also true and the test is a success. ## Help extract +``` NAME test_git_update.sh SYNOPSIS @@ -28,7 +29,7 @@ DESCRIPTION TEST7: git updated, switching to a tag, deleting and adding files in the process TEST8: git updated, before and after changing a tag, deleting and adding files in the process TEST9: git updated fast-forward on submodule on main" - +``` ## Debugging In case of problem, it is adviced to run test_git_update.sh -c to clean the repository. This will force test_repo_creation.sh to run again and provide a new test repository. \ No newline at end of file