From fd25cf8f54e9341b005004f1dd991b9458c0be2e Mon Sep 17 00:00:00 2001
From: ikkemaniac <ikkemaniac@localhost>
Date: Sun, 30 Oct 2022 14:37:45 +0100
Subject: [PATCH] Update wording

---
 roles/matrix-base/defaults/main.yml           | 11 ++++++-----
 roles/matrix-base/tasks/setup_matrix_base.yml |  2 +-
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/roles/matrix-base/defaults/main.yml b/roles/matrix-base/defaults/main.yml
index 22d89c23..4ad5fe55 100644
--- a/roles/matrix-base/defaults/main.yml
+++ b/roles/matrix-base/defaults/main.yml
@@ -284,6 +284,11 @@ matrix_docker_installation_enabled: true
 # Possible values are "docker-ce" (default) and "docker.io" (Debian).
 matrix_docker_package_name: docker-ce
 
+# Controls whether the current playbook's commit hash is saved in `git_hash.yml` on the target
+# Set this to false if GIT is not installed on the local system (the system where the ansible command is run on)
+# to suppres the warning message.
+matrix_playbook_commit_hash_preservation_enabled: true
+
 # Variables to Control which parts of our roles run.
 run_postgres_import: true
 run_postgres_upgrade: true
@@ -297,8 +302,4 @@ run_dendrite_register_user: true
 run_setup: true
 run_self_check: true
 run_start: true
-run_stop: true
-
-# Saves the git hash in a file called git_hash.yml 
-# Set this to false if GIT is not installed on the local system (the system where the ansible command is run on)
-matrix_playbook_commit_hash_preservation_enabled: true
\ No newline at end of file
+run_stop: true
\ No newline at end of file
diff --git a/roles/matrix-base/tasks/setup_matrix_base.yml b/roles/matrix-base/tasks/setup_matrix_base.yml
index 59dbe087..44e4137c 100644
--- a/roles/matrix-base/tasks/setup_matrix_base.yml
+++ b/roles/matrix-base/tasks/setup_matrix_base.yml
@@ -59,7 +59,7 @@
     - name: Get GIT hash error
       ansible.builtin.fail:
         msg: >-
-          Error when trying to get the GIT hash.
+          Error when trying to get the GIT hash. Please consult the error message above.
           You can disable saving the GIT hash by setting 'matrix_playbook_commit_hash_preservation_enabled: false' in vars.yml
       when: "git_describe.stderr.find('git: not found') == -1"