From 866a7254fb5971385f5a93ae9e578fb6df62a0ec Mon Sep 17 00:00:00 2001
From: Lorin Hochstein <lorin@nimbisservices.com>
Date: Fri, 15 Mar 2013 11:40:54 -0400
Subject: [PATCH] Document mysql_(user,db) login_unix_socket option

mysql_user and mysql_db both take a login_unix_socket option.

This patch adds docs that describe how to use it.
---
 mysql_db   | 5 +++++
 mysql_user | 7 +++++++
 2 files changed, 12 insertions(+)

diff --git a/mysql_db b/mysql_db
index b26fc9c889d..7e35ff8172b 100644
--- a/mysql_db
+++ b/mysql_db
@@ -47,6 +47,11 @@ options:
       - Host running the database
     required: false
     default: localhost
+  login_unix_socket:
+    description:
+      - The path to a Unix domain socket for local connections
+    required: false
+    default: null
   state:
     description:
       - The database state
diff --git a/mysql_user b/mysql_user
index 4ca2587bbf5..954b8eff423 100644
--- a/mysql_user
+++ b/mysql_user
@@ -56,6 +56,11 @@ options:
       - Host running the database
     required: false
     default: localhost
+  login_unix_socket:
+    description:
+      - The path to a Unix domain socket for local connections
+    required: false
+    default: null
   priv:
     description:
       - "MySQL privileges string in the format: C(db.table:priv1,priv2)"
@@ -74,6 +79,8 @@ examples:
      description: Ensure no user named 'sally' exists, also passing in the auth credentials.
    - code: mydb.*:INSERT,UPDATE/anotherdb.*:SELECT/yetanotherdb.*:ALL
      description: Example privileges string format
+   - code: "mysql_user: name=root password=abc123 login_unix_socket=/var/run/mysqld/mysqld.sock"
+     description: Example using login_unix_socket to connect to server
 notes:
    - Requires the MySQLdb Python package on the remote host. For Ubuntu, this
      is as easy as apt-get install python-mysqldb.