File: 02-man-pages-fix.patch

package info (click to toggle)
likwid 5.4.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 18,328 kB
  • sloc: ansic: 106,654; perl: 18,686; python: 1,922; makefile: 1,219; sh: 508; cpp: 456; f90: 214; asm: 61
file content (105 lines) | stat: -rw-r--r-- 6,523 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
Description: Fix some warnings in man pages
Author: Thomas Roehl <thomas.roehl@fau.de>$
Last-Update: 2014-10-29$
---$
This patch header follows DEP-3: http://dep.debian.net/deps/dep3/$
--- a/doc/likwid-bench.1
+++ b/doc/likwid-bench.1
@@ -1,5 +1,4 @@
 .TH LIKWID-BENCH 1 <DATE> likwid\-<VERSION>
-.WARN
 .SH NAME
 likwid-bench \- low-level benchmark suite and microbenchmarking framework
 .SH SYNOPSIS
@@ -89,7 +88,7 @@ and
 .B <stride>
 can be provided. Optionally for every stream (array, vector) the placement can be controlled. Per default all arrays are placed in the same
 .B <thread_domain>
-the threads are running in. To place the data in a different domain for every stream of a benchmark case (the total number of streams can be aquired by the
+the threads are running in. To place the data in a different domain for every stream of a benchmark case (the total number of streams can be acquired by the
 .B \-l
 option) the domain to place the data in can be specified. Multiple streams are comma separated. Either the placement is provided or all streams have to be explicitly placed. Please refer to the Wiki pages on
 .B https://github.com/RRZE-HPC/likwid/wiki/Likwid-Bench
--- a/doc/likwid-perfctr.1
+++ b/doc/likwid-perfctr.1
@@ -46,8 +46,8 @@ or
 is a lightweight command line application to configure and read out hardware performance monitoring data
 on supported x86, ARM and POWER processors and Nvidia GPUs. It can measure either as wrapper without changing
 the measured application or with marker API functions inside the code, which will turn on and off the counters.
-There are preconfigured performance groups with useful event sets and derived metrics. Additonally, arbitrary
-events can be measured with custom event sets. The marker API can measure mulitple named regions and the
+There are preconfigured performance groups with useful event sets and derived metrics. Additionally, arbitrary
+events can be measured with custom event sets. The marker API can measure multiple named regions and the
 results are accumulated over multiple region calls.
 .IR (*) Option only available if built with Nvidia GPU support
 .IR (**) Option only available if built with AMD GPU support
@@ -61,7 +61,7 @@ prints version information to standard o
 prints a help message to standard output, then exits.
 .TP
 .B \-\^H
-prints group help message (use together with -g switch).
+prints group help message (use together with \-g switch).
 .TP
 .B \-\^V <level>, \-\-\^verbose <level>
 verbose output during execution for debugging. 0 for only errors, 1 for informational output, 2 for detailed output and 3 for developer output
@@ -76,9 +76,9 @@ print available performance groups for c
 print available counters and performance events of current processor and (if available) Nvidia or AMD GPUs.
 .TP
 .B \-\^o, \-\-\^output <filename>
-store all ouput to a file instead of stdout. For the filename the following placeholders are supported:
+store all output to a file instead of stdout. For the filename the following placeholders are supported:
 %j for PBS_JOBID, %r for MPI RANK (only Intel MPI at the moment), %h host name and %p for process pid.
-The placeholders must be separated by underscore as, e.g., -o test_%h_%p. You must specify a suffix to
+The placeholders must be separated by underscore as, e.g., \-o test_%h_%p. You must specify a suffix to
 the filename. For txt the output is printed as is to the file. Other suffixes trigger a filter on the output.
 Available filters are csv (comma separated values), xml and json at the moment.
 .TP
@@ -100,7 +100,7 @@ items, separated by comma, and ranges. F
 also pin the threads to the cores. Also logical numberings can be used.
 .TP
 .B \-\^g, \-\-\^group <performance group> or <performance event set string>
-specify which performance group to measure. This can be one of the tags output with the -a flag.
+specify which performance group to measure. This can be one of the tags output with the \-a flag.
 Also a custom event set can be specified by a comma separated list of events. Each event has the format
 eventId:register with the the register being one of a architecture supported performance counter registers.
 .TP
@@ -193,7 +193,7 @@ Using the marker API to measure only par
 .B likwid-perfctr -m -C 0-4 -g INSTRUCTIONS_RETIRED_SSE:PMC0,CPU_CLOCKS_UNHALTED:PMC3 ./cacheBench
 .PP
 You have to link you code against liblikwid.so and use the marker API calls.
-Examples can be found in examples folder <INSTALLEDPREFIX>/share/likwid/examples.
+Examples can be found in examples folder <INSTALLED_PREFIX>/share/likwid/examples.
 The following code snippet shows the necessary calls:
 
 .nf
--- a/doc/likwid-topology.1
+++ b/doc/likwid-topology.1
@@ -14,7 +14,7 @@ is a command line application to print t
 topology on multicore x86, ARM and POWER processors and Nvidia/AMD GPUs.
 Used with mono spaced fonts it can draw the processor topology of a
 machine in ASCII art. Beyond topology likwid-topology determines the
-clock of a processor and prints detailed informations about the caches hierarchy.
+clock of a processor and prints detailed information about the caches hierarchy.
 When compiled with NVIDIA_INTERFACE=true in config.mk and the CUDA/CUPTI library reachable
 at runtime, likwid-topology prints information about the Nvidia GPUs in the system. The same is possible for AMD GPUs with ROCM_INTERFACE=TRUE and the required ROCm libraries.
 .SH OPTIONS
@@ -44,7 +44,7 @@ prints detailed information about the Nv
 write the output to file instead of stdout.
 Likwid applies filter scripts according to filename suffix.
 Currently available scripts are csv, xml and json.
-You can place additional filter scripts in <INSTALLEDPREFIX>/share/likwid/filter.
+You can place additional filter scripts in <INSTALLED_PREFIX>/share/likwid/filter.
 
 .SH AUTHOR
 Written by Thomas Gruber <thomas.roehl@googlemail.com>.
--- a/doc/likwid-powermeter.1
+++ b/doc/likwid-powermeter.1
@@ -19,7 +19,7 @@ only Intel SandyBridge is supported. It
 The Turbo Mode information works on all Turbo mode enabled Intel processors. The tool can be either used
 in stethoscope mode for a specified duration or as a wrapper to your application measuring your complete 
 run. RAPL works on a per package (socket) base.
-Please note that the RAPL counters are also accessible as normal events withing likwid-perfctr.
+Please note that the RAPL counters are also accessible as normal events within likwid-perfctr.
 .SH OPTIONS
 .TP
 .B \-\^h,\-\-\^help