Skip to content

Commit 5662521

Browse files
committed
pw_hash: use less confusing language for return type (doc)
The return type is not a (Puppet) hash, but a normal text string.
1 parent 5ae71be commit 5662521

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

lib/puppet/parser/functions/pw_hash.rb

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,24 @@
1515
The first argument to this function is the password to hash. If it is
1616
undef or an empty string, this function returns undef.
1717
18-
The second argument to this function is which type of hash to use. It
18+
The second argument to this function is which hash algorithm to use. It
1919
will be converted into the appropriate crypt(3) hash specifier. Valid
2020
hash types are:
2121
22-
|Hash type|Prefix|Note |
23-
|---------|------|--------------------|
24-
|MD5 |1 | |
25-
|SHA-256 |5 | |
26-
|SHA-512 |6 |Recommended |
27-
|bcrypt |2b | |
28-
|bcrypt-a |2a |bug compatible |
29-
|bcrypt-x |2x |bug compatible |
30-
|bcrypt-y |2y |historic alias to 2b|
22+
|Hash type|Prefix|Note |
23+
|---------|------|---------------------|
24+
|MD5 |1 | |
25+
|SHA-256 |5 | |
26+
|SHA-512 |6 |Recommended |
27+
|bcrypt |2b | |
28+
|bcrypt-a |2a |bug compatible |
29+
|bcrypt-x |2x |bug compatible |
30+
|bcrypt-y |2y |historic alias for 2b|
3131
3232
The third argument to this function is the salt to use.
3333
34-
@return [Hash]
35-
Provides a hash usable on most POSIX systems.
34+
@return [String]
35+
Provides a crypt hash usable on most POSIX systems.
3636
3737
> *Note:*: this uses the Puppet Server's implementation of crypt(3). If your
3838
environment contains several different operating systems, ensure that they

0 commit comments

Comments
 (0)