summaryrefslogtreecommitdiff
path: root/lib/ansible/plugins/callback/osx_say.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/callback/osx_say.py')
-rw-r--r--lib/ansible/plugins/callback/osx_say.py33
1 files changed, 16 insertions, 17 deletions
diff --git a/lib/ansible/plugins/callback/osx_say.py b/lib/ansible/plugins/callback/osx_say.py
index d2f85f9a31..1b4b490146 100644
--- a/lib/ansible/plugins/callback/osx_say.py
+++ b/lib/ansible/plugins/callback/osx_say.py
@@ -1,20 +1,19 @@
-
-# (C) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
-
-# This file is part of Ansible
-#
-# Ansible 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.
-#
-# Ansible 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 Ansible. If not, see <http://www.gnu.org/licenses/>.
+# (c) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
+# (c) 2017 Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+'''
+DOCUMENTATION:
+ callback: osx_say
+ type: notification
+ requirements:
+ - whitelising in configuration
+ - the '/usr/bin/say' command line program (standard on OS X)
+ short_description: oneline Ansible screen output
+ version_added: historical
+ description:
+ - This plugin will use the 'say' program to "speak" about play events.
+'''
# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)