From dadee8a49dd8f4d839e4c7cdb6a0e46a29652861 Mon Sep 17 00:00:00 2001
From: Felix Stupp <felix.stupp@outlook.com>
Date: Sun, 24 Oct 2021 14:32:03 +0200
Subject: [PATCH] ansible.cfg: Add comments for explaining every option / group
 of options

---
 ansible.cfg | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/ansible.cfg b/ansible.cfg
index 3eaeede..72fa049 100644
--- a/ansible.cfg
+++ b/ansible.cfg
@@ -1,15 +1,31 @@
 [defaults]
 
+# always ask for vault pass instead of expecting user to make it available unasked
 ask_vault_pass = True
+
+# force handlers to be executed always, especially after a normal task failed to execute
+# without this option, it might happen that a handler might be missed to be executed after the role was completed in multiple tries (e.g. reload certain services)
 force_handlers = True
+
+# select custom inventory parser for setting up inventory
 inventory = ./hosts.py
+
+# disable usage of cowsay for ansible-playbook's logging (increases readability drastically, only matters if cowsay is installed)
 nocows = True
+
+# disable storing retry files after fail because of no usage
 retry_files_enabled = False
+
+# automatically select python interpreter, should be sufficient
 interpreter_python = auto
 
+# add mitogen strategies and select mitogen as default strategy
 # mitogen, see https://mitogen.networkgenomics.com/ansible_detailed.html
 strategy_plugins = ./misc/mitogen/ansible_mitogen/plugins/strategy
 strategy = mitogen_linear
 
+
 [diff]
+
+# always enable --diff option
 always = True