From 7ae451d72c7547ab4469785929007476f05c3c28 Mon Sep 17 00:00:00 2001 From: Lamont Granquist Date: Thu, 23 Apr 2020 15:29:28 -0700 Subject: update descriptions Signed-off-by: Lamont Granquist --- lib/chef/resource/scm/_scm.rb | 4 ++-- lib/chef/resource/scm/git.rb | 4 +++- lib/chef/resource/scm/subversion.rb | 4 ++-- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/lib/chef/resource/scm/_scm.rb b/lib/chef/resource/scm/_scm.rb index da1e100fcf..ddb6619cab 100644 --- a/lib/chef/resource/scm/_scm.rb +++ b/lib/chef/resource/scm/_scm.rb @@ -32,10 +32,10 @@ property :revision, String, default: "HEAD" property :user, [String, Integer], - description: "The system user that is responsible for the checked-out code." + description: "The system user that should own the checked-out code." property :group, [String, Integer], - description: "The system group that is responsible for the checked-out code." + description: "The system group that should own the checked-out code." property :timeout, Integer, description: "The amount of time (in seconds) to wait before timing out.", diff --git a/lib/chef/resource/scm/git.rb b/lib/chef/resource/scm/git.rb index f2d5b6980a..788eafbd3b 100644 --- a/lib/chef/resource/scm/git.rb +++ b/lib/chef/resource/scm/git.rb @@ -45,10 +45,12 @@ class Chef default: true property :remote, String, + description: "The remote repository to use when synchronizing an existing clone.", default: "origin" property :ssh_wrapper, String, - desired_state: false + desired_state: false, + description: "The path to the wrapper script used when running SSH with git. The `GIT_SSH` environment variable is set to this." property :checkout_branch, String, description: "Set this to use a local branch to avoid checking SHAs or tags to a detatched head state." diff --git a/lib/chef/resource/scm/subversion.rb b/lib/chef/resource/scm/subversion.rb index 0f615ba8db..619df673b4 100644 --- a/lib/chef/resource/scm/subversion.rb +++ b/lib/chef/resource/scm/subversion.rb @@ -46,10 +46,10 @@ class Chef description: "The location of the svn binary." property :svn_username, String, - description: "The username to use for interacting with subversion." + description: "The user name for a user that has access to the Subversion repository." property :svn_password, String, - description: "The password to use for interacting with subversion.", + description: "The password for a user that has access to the Subversion repository.", sensitive: true, desired_state: false # Override exception to strip password if any, so it won't appear in logs and different Chef notifications -- cgit v1.2.1