Skip to content

Commit b61a9e7

Browse files
Tzafrir Cohensshaulnv
authored andcommitted
Fix format of man pages
1 parent 1a11412 commit b61a9e7

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

man/perftest.1

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
.TH perftest 1
2-
.SH NAME:
3-
.TP
4-
ib_write_bw, ib_read_bw, ib_send_bw, ib_atomic_bw
5-
ib_write_lat, ib_read_lat, ib_send_lat, ib_atomic_lat
6-
raw_ethernet_bw, raw_ethernet_lat, raw_ethernet_burst_lat
7-
raw_ethernet_fs_rate
8-
.SH DESCRIPTION:
9-
.SH
10-
.TP
11-
.B Perftest:
12-
This is a set of benchmarks that measures different metrics & verbs performance which include
2+
.SH NAME
3+
ib_write_bw, ib_read_bw, ib_send_bw, ib_atomic_bw,
4+
ib_write_lat, ib_read_lat, ib_send_lat, ib_atomic_lat,
5+
raw_ethernet_bw, raw_ethernet_lat, raw_ethernet_burst_lat,
6+
raw_ethernet_fs_rate \- benchmarks for various types of infinabnd performance
7+
.SH DESCRIPTION
8+
.TP
9+
Perftest is a package that includes various benchmarks that measures
10+
different metrics & verbs performance which include
1311
many different options and modes.
14-
.SS RUNNING TESTS:
15-
.SS
12+
.SS RUNNING TESTS
1613
.TP
1714
.B Server:
1815
./<test name> <options>
@@ -29,14 +26,13 @@ many different options and modes.
2926
Server: ./ib_read_lat -s 32 -n 5000
3027
Client: ./ib_read_lat -s 32 -n 5000 192.168.0.1
3128

32-
.SS IMPORTANT NOTES:
29+
.SS IMPORTANT NOTES
3330
.TP
3431
1- The options that specific to modes in perftest must be the same for both server and client.
3532
2- Perftest applications may need to be ran with sudo when running from non root.
3633
3- Perftest applications usually installed to the /usr/bin/.
3734
4- Perftest may print some failures with syndroms to the stderr, perftest get those errors from rdma-core.
38-
.SH OPTIONS:
39-
.SH
35+
.SH OPTIONS
4036
.TP
4137
.B -h, --help
4238
Lists the available options to the screen.
@@ -419,8 +415,7 @@ many different options and modes.
419415
.B --write_with_imm
420416
Use write-with-immediate verb instead of write.
421417
Write tests only.
422-
.SS RawEth only options:
423-
.SS
418+
.SS RawEth only options
424419
.TP
425420
.B -B, --source_mac
426421
Source MAC address by this format XX:XX:XX:XX:XX:XX **MUST** be entered.
@@ -499,8 +494,7 @@ many different options and modes.
499494
.TP
500495
.B --raw_mcast.
501496
Relevant only for bandwidth.
502-
.SH AUTHORS:
503-
.SH
497+
.SH AUTHORS
504498
.TP
505499
.B Hassan Khadour <[email protected]>
506500
.TP

0 commit comments

Comments
 (0)