git: 0bb186d842 - main - [phb]: Add missing Uses=ansible

Fernando Apesteguía <[email protected]>
Newsgroups gmane.os.freebsd.devel.cvs.doc
Message-ID <[email protected]>
The branch main has been updated by fernape:

URL: https://cgit.FreeBSD.org/doc/commit/?id=0bb186d842fb03a626cc540fe56ca6c9b73bebbb

commit 0bb186d842fb03a626cc540fe56ca6c9b73bebbb
Author:     Fernando Apesteguía <[email protected]>
AuthorDate: 2025-02-07 18:45:32 +0000
Commit:     Fernando Apesteguía <[email protected]>
CommitDate: 2025-02-21 16:46:11 +0000

    [phb]: Add missing Uses=ansible
---
 .../en/books/porters-handbook/uses/_index.adoc     | 42 ++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc
index a174d5a48f..4a3facc28f 100644
--- a/documentation/content/en/books/porters-handbook/uses/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc
@@ -139,6 +139,48 @@ The tagname of the `angr` binaries.
 `ANGR_NOSETESTS`::
 The path to the `nosetests` program.
 
+[[uses-ansible]]
+== `ansible`
+
+Possible arguments: `env`, `module`, `plugin`
+
+Provide support for ports depending on package:sysutils/ansible[].
+
+If the `env` argument is present, the port does not depend on
+package:sysutils/ansible[] but needs some Ansible variables set.
+
+If the `module` argument is present then the port is an Ansible module.
+
+If the `plugin` argument is present then the port is an Ansible plugin.
+
+The framework exposes the following variables to the port:
+
+`ANSIBLE_CMD`::
+Path to the ansible program.
+
+`ANSIBLE_DOC_CMD`::
+Path to the ansible-doc program.
+
+`ANSIBLE_RUN_DEPENDS`::
+RUN_DEPENDS with the Ansible port.
+
+`ANSIBLE_DATADIR`::
+Path to the root of the directory structure where all Ansible's modules and plugins are stored.
+
+`ANSIBLE_ETCDIR`::
+Path to the Ansible etc directory.
+
+`ANSIBLE_PLUGINS_PREFIX`::
+Path to the "plugins" directory within `${ANSIBLE_DATADIR}`.
+`ANSIBLE_MODULESDIR`::
+Path to the directory for local Ansible modules.
+
+`ANSIBLE_PLUGINSDIR`::
+Path to the directory for local Ansible plugins.
+
+`ANSIBLE_PLUGIN_TYPE`::
+Ansible plugin type (e.g., "connection", "inventory", or "vars").
+
 [[uses-autoreconf]]
 == `autoreconf`
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.