From 826e9c7c89305d38e37464d37ed250feed863d13 Mon Sep 17 00:00:00 2001
From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com>
Date: Tue, 4 Oct 2022 14:35:05 +0200
Subject: [PATCH] * add `socket` option suggestion in documentation (#437)
 (#455)

* * add `socket` option suggestion in documentation

* white space fix

* * move first two at the end

(cherry picked from commit b9a6ec4f7d5c8e7293cb3f84e333d1f5fba20be8)

Co-authored-by: Gabriel PREDA <eRadical@users.noreply.github.com>
---
 .gitignore                     | 3 +++
 plugins/doc_fragments/mysql.py | 7 +++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index 6bbe85a..1922df0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -134,3 +134,6 @@ dmypy.json
 
 # MacOS
 .DS_Store
+
+# IntelliJ IDEA or PyCharm
+.idea/
diff --git a/plugins/doc_fragments/mysql.py b/plugins/doc_fragments/mysql.py
index 7d4ec96..939126c 100644
--- a/plugins/doc_fragments/mysql.py
+++ b/plugins/doc_fragments/mysql.py
@@ -79,8 +79,6 @@ requirements:
    - PyMySQL (Python 2.7 and Python 3.x) or
    - MySQLdb (Python 2.x)
 notes:
-   - "To avoid the C(Please explicitly state intended protocol) error, use the I(login_unix_socket) argument,
-     for example, C(login_unix_socket: /run/mysqld/mysqld.sock)."
    - Requires the PyMySQL (Python 2.7 and Python 3.X) or MySQL-python (Python 2.X) package installed on the remote host.
      The Python package may be installed with apt-get install python-pymysql (Ubuntu; see M(ansible.builtin.apt)) or
      yum install python2-PyMySQL (RHEL/CentOS/Fedora; see M(ansible.builtin.yum)). You can also use dnf install python2-PyMySQL
@@ -107,4 +105,9 @@ notes:
    - "If credentials from the config file (for example, C(/root/.my.cnf)) are not needed to connect to a database server, but
      the file exists and does not contain a C([client]) section, before any other valid directives, it will be read and this
      will cause the connection to fail, to prevent this set it to an empty string, (for example C(config_file: ''))."
+   - "To avoid the C(Please explicitly state intended protocol) error, use the I(login_unix_socket) argument,
+     for example, C(login_unix_socket: /run/mysqld/mysqld.sock)."
+   - Alternatively, to avoid using I(login_unix_socket) argument on each invocation you can specify the socket path
+     using the `socket` option in your MySQL config file (usually C(~/.my.cnf)) on the destination host, for
+     example C(socket=/var/lib/mysql/mysql.sock).
 '''