From 020254f570717dd4c863b18b7d1f8d3e615a9554 Mon Sep 17 00:00:00 2001
From: Robert Collins <rbtcollins@hp.com>
Date: Wed, 4 Sep 2013 10:32:35 +1200
Subject: [PATCH] Document review.pp parameters a bit.

This is sourced from IRC, they may be entirely wrong of course.

Change-Id: I715db1ee3311eb67bbd63c03f0b1129e60d2cc36
---
 modules/openstack_project/manifests/review.pp | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/modules/openstack_project/manifests/review.pp b/modules/openstack_project/manifests/review.pp
index 967c309421..27d941b260 100644
--- a/modules/openstack_project/manifests/review.pp
+++ b/modules/openstack_project/manifests/review.pp
@@ -30,30 +30,43 @@
 # 12:09 <@spearce> so. you get 5 milliseconds before aborting
 # thus, set it to 5000minutes until the bug is fixed.
 class openstack_project::review (
+  # Created by running jeepyb ?
   $github_oauth_token = '',
+  # Create a dedicated user e.g. openstack-project-creator, put
+  # details here.
   $github_project_username = '',
   $github_project_password = '',
+  # Create arbitrary values and put here, puppet will use during
+  # provisioning.
   $mysql_password = '',
   $mysql_root_password = '',
   $email_private_key = '',
+  # Register an IRC bot and supply it's password here.
   $gerritbot_password = '',
+  # Register SSL keys and pass their contents in.
   $ssl_cert_file_contents = '',
   $ssl_key_file_contents = '',
   $ssl_chain_file_contents = '',
+  # Create SSH server key by hand and supply here.
   $ssh_dsa_key_contents = '',
   $ssh_dsa_pubkey_contents = '',
   $ssh_rsa_key_contents = '',
   $ssh_rsa_pubkey_contents='',
+  # manage-projects's user ssh key.
   $ssh_project_rsa_key_contents='',
   $ssh_project_rsa_pubkey_contents='',
+  # To be deleted.
   $lp_sync_key='', # If left empty puppet will not create file.
   $lp_sync_pubkey='', # If left empty puppet will not create file.
   $lp_sync_consumer_key='',
   $lp_sync_token='',
   $lp_sync_secret='',
+  # For gerrit's contactstore feature
+  # https://review.openstack.org/Documentation/config-contact.html
   $contactstore_appsec='',
   $contactstore_pubkey='',
   $sysadmins = [],
+  # For openstackwatch.
   $swift_username = '',
   $swift_password = ''
 ) {