pkgsrc-WIP-changes archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

provider.mk: Add documentation for all the variables that are package-settable



Module Name:	pkgsrc-wip
Committed By:	Leonardo Taccari <leot%NetBSD.org@localhost>
Pushed By:	leot
Date:		Mon May 3 00:23:26 2021 +0200
Changeset:	4f4c607f85aa3a08b8bb062936d68d56c4ff4bd1

Modified Files:
	terraform/provider.mk

Log Message:
provider.mk: Add documentation for all the variables that are package-settable

To see a diff of this commit:
https://wip.pkgsrc.org/cgi-bin/gitweb.cgi?p=pkgsrc-wip.git;a=commitdiff;h=4f4c607f85aa3a08b8bb062936d68d56c4ff4bd1

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

diffstat:
 terraform/provider.mk | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diffs:
diff --git a/terraform/provider.mk b/terraform/provider.mk
index bacf79b5b1..0e7b910c91 100644
--- a/terraform/provider.mk
+++ b/terraform/provider.mk
@@ -2,19 +2,32 @@
 #
 # This file implements common logic for Terraform providers in pkgsrc.
 #
-# === Package-settable variables ===
+# Package-settable variables:
 #
 # TERRAFORM_PROVIDER_HOSTNAME (optional)
+#	Hostname of the Terraform registry that distributes the provider.
+#
+#	Default: registry.terraform.io
 #
 # TERRAFORM_PROVIDER_BIN
+#	Binary name of the provider that will be installed under
+#       TERRAFORM_PROVIDER_DIR.
 #
 # TERRAFORM_PROVIDER_NAMESPACE
+#	Organizational namespace within the Terraform registry.
 #
 # TERRAFORM_PROVIDER_TYPE
+#	Short name for the platform or system the provider manages.
 #
 # TERRAFORM_PROVIDER_VERSION (optional)
+#	Version of the provider.
+#
+#	Default: ${PKGVERSION_NOREV}
 #
 # TERRAFORM_PROVIDER_DIR (optional)
+#	Directory where the provider will be installed.
+#
+#	Default: share/terraform/plugins/${TERRAFORM_PROVIDER_HOSTNAME}/${TERRAFORM_PROVIDER_NAMESPACE}/${TERRAFORM_PROVIDER_TYPE}/${TERRAFORM_PROVIDER_VERSION}/${GO_PLATFORM}
 #
 # Keywords: terraform
 #


Home | Main Index | Thread Index | Old Index