From 739e4c0386b3b596d90bdcc95eae95ad98e4b810 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Wed, 13 Jan 2016 10:32:36 -0500 Subject: [PATCH] corrected info about windows module naming and loc --- docsite/rst/intro_windows.rst | 5 +---- lib/ansible/modules/core | 2 +- lib/ansible/modules/extras | 2 +- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/docsite/rst/intro_windows.rst b/docsite/rst/intro_windows.rst index 1adcc35010..375e5984a4 100644 --- a/docsite/rst/intro_windows.rst +++ b/docsite/rst/intro_windows.rst @@ -256,10 +256,7 @@ Developers: Supported modules and how it works Developing Ansible modules are covered in a `later section of the documentation `_, with a focus on Linux/Unix. What if you want to write Windows modules for Ansible though? -For Windows, Ansible modules are implemented in PowerShell. Skim those Linux/Unix module development chapters before proceeding. - -Windows modules live in a "windows/" subfolder in the Ansible "library/" subtree. For example, if a module is named -"library/windows/win_ping", there will be embedded documentation in the "win_ping" file, and the actual PowerShell code will live in a "win_ping.ps1" file. Take a look at the sources and this will make more sense. +For Windows, Ansible modules are implemented in PowerShell. Skim those Linux/Unix module development chapters before proceeding. Windows modules in the core and extras repo live in a "windows/" subdir. Custom modules can go directly into the Ansible "library/" directories or those added in ansible.cfg. Documentation lives in a a `.py` file with the same name. For example, if a module is named "win_ping", there will be embedded documentation in the "win_ping.py" file, and the actual PowerShell code will live in a "win_ping.ps1" file. Take a look at the sources and this will make more sense. Modules (ps1 files) should start as follows:: diff --git a/lib/ansible/modules/core b/lib/ansible/modules/core index 5f6d0f73f4..b77bf7a9aa 160000 --- a/lib/ansible/modules/core +++ b/lib/ansible/modules/core @@ -1 +1 @@ -Subproject commit 5f6d0f73f4203f05c7a51d906e6c04108d397b39 +Subproject commit b77bf7a9aa1889fbee75f3db17c89816ca7c7838 diff --git a/lib/ansible/modules/extras b/lib/ansible/modules/extras index 39d6066f51..4d2a20b2f4 160000 --- a/lib/ansible/modules/extras +++ b/lib/ansible/modules/extras @@ -1 +1 @@ -Subproject commit 39d6066f512b3ceaa4f16592c452cb26c17675f6 +Subproject commit 4d2a20b2f433db2492b6b3eb0554177fa42662e4