From a73ec2b34018a7d9086eaeb38b53351bd51c4740 Mon Sep 17 00:00:00 2001
From: Juan Ferrer Toribio <juan@verdnatura.es>
Date: Mon, 7 Apr 2025 09:41:43 +0200
Subject: [PATCH] doc: refs #8869 make-backup.sh doc added

---
 roles/db/files/mariabackup/make-backup.sh | 35 ++++++++++++++++++++---
 1 file changed, 31 insertions(+), 4 deletions(-)

diff --git a/roles/db/files/mariabackup/make-backup.sh b/roles/db/files/mariabackup/make-backup.sh
index 47bad8f..91e1963 100644
--- a/roles/db/files/mariabackup/make-backup.sh
+++ b/roles/db/files/mariabackup/make-backup.sh
@@ -1,8 +1,35 @@
 #!/bin/bash
-# https://mariadb.com/kb/en/mariabackup/
-# https://mariadb.com/kb/en/mariabackup-options/
-# https://mariadb.com/kb/en/incremental-backup-and-restore-with-mariabackup/
-# https://mariadb.com/kb/en/setting-up-a-replica-with-mariabackup/
+#
+# Author: Juan Ferrer
+# Copyright (c) 2025 Verdnatura S.L. All rights reserved.
+# Version: 0.0.2
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+#
+# Backups the MariaDB database, it supports three modes:
+#  - Full: Full backup of all DB data, deletes all previous backups.
+#  - Differential: Backup changes since the last full backup, deletes all 
+#    previous differential backups.
+#  - Incremental: Backup changes since the last full backup, same as 
+#    differential, but does not erase any previous backups.
+#
+# References:
+#  - https://mariadb.com/kb/en/mariabackup/
+#  - https://mariadb.com/kb/en/mariabackup-options/
+#  - https://mariadb.com/kb/en/incremental-backup-and-restore-with-mariabackup/
+#  - https://mariadb.com/kb/en/setting-up-a-replica-with-mariabackup/
+#
 set -e
 
 myDir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"