Skip to content

Commit 20dae1f

Browse files
blizzzBackportbot
authored andcommitted
extended documentation
Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
1 parent ada1db3 commit 20dae1f

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

config/config.sample.php

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1431,19 +1431,25 @@
14311431
*/
14321432

14331433
/**
1434-
* The allowed maximum memory to be used by the algorithm for computing a hash.
1434+
* The allowed maximum memory in KiB to be used by the algorithm for computing a
1435+
* hash. The smallest possible value is 8. Values that undershoot the minimum
1436+
* will be ignored in favor of the default.
14351437
*/
14361438
'hashingMemoryCost' => PASSWORD_ARGON2_DEFAULT_MEMORY_COST,
14371439

14381440
/**
1439-
* The allowed maximum time that can be used by the algorithm for computing a
1440-
* hash.
1441+
* The allowed maximum time in seconds that can be used by the algorithm for
1442+
* computing a hash. The value must be an integer, and the minimum value is 1.
1443+
* Values that undershoot the minimum will be ignored in favor of the default.
14411444
*/
14421445
'hashingTimeCost' => PASSWORD_ARGON2_DEFAULT_TIME_COST,
14431446

14441447
/**
14451448
* The allowed number of CPU threads that can be used by the algorithm for
1446-
* computing a hash.
1449+
* computing a hash. The value must be an integer, and the minimum value is 1.
1450+
* Rationally it does not help to provide a number higher than the available
1451+
* threads on the machine. Values that undershoot the minimum will be ignored
1452+
* in favor of the default.
14471453
*/
14481454
'hashingThreads' => PASSWORD_ARGON2_DEFAULT_THREADS,
14491455

0 commit comments

Comments
 (0)