Skip to content

Commit 3eaf111

Browse files
committed
Improved documentation.
1 parent 5e3ddd6 commit 3eaf111

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ NetPerfMeter supports randomised frame rate and frame size, to create variable b
280280
* exp<p>: Exponential distribution with mean <mean>. Example: exp1000.
281281
* pareto<location>,<shape>: Pareto distribution with location <location> and shape <shape>. Example: pareto0.166667,1.5.
282282
* normal<mean>,<stddev>: Normal distribution with mean <mean> and standard deviation <stddev>. Example: normal1000,500.
283-
Note that normal distribution may result in negative values, which may be ignored (frame size) or interpreted as saturated traffic (frame rate).
283+
Note that normal distribution may result in negative values, which may be ignored (frame size) or interpreted as saturated traffic (frame rate). Use truncnormal to prevent negative values.
284284
* truncnormal<mean>,<stddev>: Truncated normal distribution with mean <mean> and standard deviation <stddev>, i.e. normal distribution without negative values. Example: truncnormal1000,500.
285285

286286
A configured distribution is used to determine:

src/netperfmeter.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ Exponential distribution with mean <mean>. Example: exp1000.
212212
Pareto distribution with location <location> and shape <shape>. Example: pareto0.166667,1.5.
213213
.It normal<mean>,<stddev>
214214
Normal distribution with mean <mean> and standard deviation <stddev>. Example: normal1000,500.
215-
Note that normal distribution may result in negative values, which may be ignored (frame size) or interpreted as saturated traffic (frame rate).
215+
Note that normal distribution may result in negative values, which may be ignored (frame size) or interpreted as saturated traffic (frame rate). Use truncnormal to prevent negative values.
216216
.It truncnormal<mean>,<stddev>
217217
Truncated normal distribution with mean <mean> and standard deviation <stddev>, i.e. normal distribution without negative values. Example: truncnormal1000,500.
218218
.El

0 commit comments

Comments
 (0)