mirror of
				https://github.com/catchorg/Catch2.git
				synced 2025-10-31 20:27:11 +01:00 
			
		
		
		
	Documented benchmark-resolution-multiple command line option
- and increased default to 100
This commit is contained in:
		| @@ -29,6 +29,7 @@ Click one of the followings links to take you straight to that option - or scrol | |||||||
| <a href="#rng-seed">                                    `    --rng-seed`</a><br /> | <a href="#rng-seed">                                    `    --rng-seed`</a><br /> | ||||||
| <a href="#libidentify">                                 `    --libidentify`</a><br /> | <a href="#libidentify">                                 `    --libidentify`</a><br /> | ||||||
| <a href="#wait-for-keypress">                           `    --wait-for-keypress`</a><br /> | <a href="#wait-for-keypress">                           `    --wait-for-keypress`</a><br /> | ||||||
|  | <a href="#benchmark-resolution-multiple">               `    --benchmark-resolution-multiple`</a><br /> | ||||||
|  |  | ||||||
| </br> | </br> | ||||||
|  |  | ||||||
| @@ -228,6 +229,13 @@ See [The LibIdentify repo for more information and examples](https://github.com/ | |||||||
| Will cause the executable to print a message and wait until the return/ enter key is pressed before continuing - | Will cause the executable to print a message and wait until the return/ enter key is pressed before continuing - | ||||||
| either before running any tests, after running all tests - or both, depending on the argument. | either before running any tests, after running all tests - or both, depending on the argument. | ||||||
|  |  | ||||||
|  | <a id="benchmark-resolution-multiple"></a> | ||||||
|  | ## Specify multiples of clock resolution to run benchmarks for | ||||||
|  | <pre>--benchmark-resolution-multiple <multiplier></pre> | ||||||
|  |  | ||||||
|  | When running benchmarks the clock resolution is estimated. Benchmarks are then run for exponentially increasing | ||||||
|  | numbers of iterations until some multiple of the estimated resolution is exceed. By default that multiple is 100, but  | ||||||
|  | it can be overriden here. | ||||||
|  |  | ||||||
| <a id="usage"></a> | <a id="usage"></a> | ||||||
| ## Usage | ## Usage | ||||||
|   | |||||||
| @@ -39,7 +39,7 @@ namespace Catch { | |||||||
|  |  | ||||||
|         int abortAfter = -1; |         int abortAfter = -1; | ||||||
|         unsigned int rngSeed = 0; |         unsigned int rngSeed = 0; | ||||||
|         int benchmarkResolutionMultiple = 10; |         int benchmarkResolutionMultiple = 100; | ||||||
|  |  | ||||||
|         Verbosity verbosity = Verbosity::Normal; |         Verbosity verbosity = Verbosity::Normal; | ||||||
|         WarnAbout::What warnings = WarnAbout::Nothing; |         WarnAbout::What warnings = WarnAbout::Nothing; | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user
	 Phil Nash
					Phil Nash