[Likwid-commit] [likwid] 01/03: move manpage fixes to patch file

Christoph Martin chrism at debian.org
Mon Apr 27 10:46:02 UTC 2015


This is an automated email from the git hooks/post-receive script.

chrism pushed a commit to branch master
in repository likwid.

commit b1b3d3e3d49b345df7b83bea4b2ab273579ed1f6
Author: Christoph Martin <martin at uni-mainz.de>
Date:   Thu Apr 23 10:44:12 2015 +0200

    move manpage fixes to patch file
---
 debian/changelog                      |   2 +-
 debian/patches/02-man-pages-fix.patch | 121 ++++++----------------------------
 debian/patches/series                 |   2 +-
 doc/likwid-bench.1                    |   1 +
 doc/likwid-perfscope.1                |   2 +-
 5 files changed, 23 insertions(+), 105 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 29b107e..64096a3 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -2,7 +2,7 @@ likwid (3.1.3-1) experimental; urgency=medium
 
   * New upstream release
 
- -- Christoph Martin <martin at uni-mainz.de>  Wed, 25 Feb 2015 17:29:41 +0100
+ -- Christoph Martin <martin at uni-mainz.de>  Thu, 23 Apr 2015 10:29:52 +0200
 
 likwid (3.1.2-1) experimental; urgency=low
 
diff --git a/debian/patches/02-man-pages-fix.patch b/debian/patches/02-man-pages-fix.patch
index 8a07a7d..7aeac8c 100644
--- a/debian/patches/02-man-pages-fix.patch
+++ b/debian/patches/02-man-pages-fix.patch
@@ -3,105 +3,22 @@ Author: Thomas Roehl <thomas.roehl at 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
-@@ -54,7 +54,7 @@ specify the number of workgroups to perf
- Specify the affinity domain, thread count and data set size for the current benchmarking run (mandatory).
- 
- .SH WORKGROUP SYNTAX
--.B <thread_domain>:<size>[:<num_threads>[:<chunk_size>:<stride>]][-<streamId>:<domain_id>]
-+.B <thread_domain>:<size> [:<num_threads>[:<chunk_size>:<stride>]] [-<streamId>:<domain_id>]
- with size in kB, MB or GB.
- Where thread domain is where threads are placed. Size is the total data set size for the benchmark. num_threads specifies how many threads are used. Threads are always placed using a compact policy in
- .B likwid-bench.
-@@ -95,8 +95,8 @@ The option INSTRUMENT_BENCH in config.mk
- .PP
- .B likwid-perfctr 
- will configure and start the performance counters on socket 0 with 4 threads prior to the execution of
--.B likwid-bench
--. The performance counters are read right before and after running the benchmarking code to 
-+.B likwid-bench.
-+The performance counters are read right before and after running the benchmarking code to 
- minimize the interferences of the measurement.
- .IP 5. 4
- Run the copy benchmark and place the data on other socket
---- a/doc/likwid-perfctr.1
-+++ b/doc/likwid-perfctr.1
-@@ -137,13 +137,13 @@ or use the builtin pin functionality.
- .IP 1. 4
- As wrapper with performance group:
- .TP
--.B likwid-perfctr  -C 0-2  -g TLB   ./cacheBench -n 2 -l 1048576 -i 100 -t Stream
-+.B likwid-perfctr -C 0-2 -g TLB ./cacheBench -n 2 -l 1048576 -i 100 -t Stream
- .PP
- The parent process is pinned to processor 0, Thread 0 to processor 1 and Thread 1 to processor 2.
- .IP 2. 4
- As wrapper with custom event set on AMD:
- .TP
--.B likwid-perfctr  -C 0-4  -g INSTRUCTIONS_RETIRED_SSE:PMC0,CPU_CLOCKS_UNHALTED:PMC3   ./cacheBench
-+.B likwid-perfctr -C 0-4 -g INSTRUCTIONS_RETIRED_SSE:PMC0,CPU_CLOCKS_UNHALTED:PMC3 ./cacheBench
- .PP
- It is specified that the event
- .B INSTRUCTIONS_RETIRED_SSE
-@@ -160,7 +160,7 @@ event. If you want this you have to incl
- .IP 3. 4
- As wrapper with custom event set on Intel:
- .TP
--.B likwid-perfctr  -C 0  -g INSTR_RETIRED_ANY:FIXC0,CPU_CLK_UNHALTED_CORE:FIXC1,UNC_L3_LINES_IN_ANY:UPMC0  ./stream-icc
-+.B likwid-perfctr -C 0 -g INSTR_RETIRED_ANY:FIXC0,UOPS_ISSUED_ANY:PMC0 ./stream-icc
- .PP
- On Intel processors fixed events are measured on dedicated counters. These are
- .B INSTR_RETIRED_ANY
-@@ -175,7 +175,7 @@ will calculate the runtime and CPI metri
- .IP 4. 4
- Using the marker API to measure only parts of your code (this can be used both with groups or custom event sets):
- .TP
--.B likwid-perfctr -m -C 0-4  -g INSTRUCTIONS_RETIRED_SSE:PMC0,CPU_CLOCKS_UNHALTED:PMC3   ./cacheBench
-+.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.a/.so and use the marker API calls.
- The following code snippet shows the necessary calls:
-@@ -211,7 +211,7 @@ if (threadId == 0)
- .IP 5. 4
- Using likwid in timeline mode:
- .TP
--.B likwid-perfctr -c 0-3  -g FLOPS_DP -t 300ms  ./cacheBench > out.txt
-+.B likwid-perfctr -c 0-3 -g FLOPS_DP -t 300ms ./cacheBench > out.txt
- .PP
- This will read out the counters every 300ms on physical cores 0-3 and write the results to out.txt.
- For timeline mode there is a frontend application likwid-scope, which enables live plotting of selected events.
-@@ -220,7 +220,7 @@ For more code examples have a look at th
- .IP 6. 4
- Using likwid in stethoscope mode:
- .TP
--.B likwid-perfctr -c 0-3  -g FLOPS_DP -S 2s
-+.B likwid-perfctr -c 0-3 -g FLOPS_DP -S 2s
- .PP
- This will start the counters and read them out after 2s on physical cores 0-3 and write the results to stdout.
- 
---- a/doc/likwid-pin.1
-+++ b/doc/likwid-pin.1
-@@ -27,8 +27,8 @@ to a dedicated processor as specified in
- .PP
- Per default every generated thread is pinned to the core in the order of calls 
- to 
--.I pthread_create
--. It is possible to skip single threads using -s commandline option.
-+.I pthread_create.
-+It is possible to skip single threads using -s commandline option.
- .PP
- For OpenMP implementations gcc and icc compilers are explicitly supported. Others may also work.
- .B likwid-pin
---- a/doc/likwid-setFrequencies.1
-+++ b/doc/likwid-setFrequencies.1
-@@ -13,8 +13,8 @@ likwid-setFrequencies \- print and manag
- .SH DESCRIPTION
- .B likwid-setFrequencies
- is a command line application to set the clock frequency of CPU cores. Since only priviledged users are allowed to change the frequency of CPU cores, the application works in combination with a daemon 
--.B likwid-setFreq
--. The daemon needs the suid permission bit to be set in order to manipulate the sysfs entries. With 
-+.B likwid-setFreq.
-+The daemon needs the suid permission bit to be set in order to manipulate the sysfs entries. With 
- .B likwid-setFrequencies
- the clock of all cores inside a the cpu_list or affinity domain can be set to a specific frequency or governor at once.
- .SH OPTIONS
+--- likwid-3.1.3.orig/doc/likwid-bench.1
++++ likwid-3.1.3/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
+--- likwid-3.1.3.orig/doc/likwid-perfscope.1
++++ likwid-3.1.3/doc/likwid-perfscope.1
+@@ -1,7 +1,7 @@
+ .TH LIKWID-PERFSCOPE 1 <DATE> likwid\-<VERSION>
+ .SH NAME
+ likwid-perfscope \- Frontend for the timeline mode of
+-.N likwid-perfctr(1)
++.B likwid-perfctr(1)
+ that on-the-fly generates pictures from the measurements
+ .SH SYNOPSIS
+ .B likwid-perfscope 
diff --git a/debian/patches/series b/debian/patches/series
index e5f7a81..8dae98c 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,5 +1,5 @@
 #01-manpages.patch
-#02-man-pages-fix.patch
+02-man-pages-fix.patch
 #03-Makefile-man.patch
 04-Makefile-overload.patch
 05-ghashc-copyright.patch
diff --git a/doc/likwid-bench.1 b/doc/likwid-bench.1
index e9cb8c8..45d0f6c 100644
--- a/doc/likwid-bench.1
+++ b/doc/likwid-bench.1
@@ -1,4 +1,5 @@
 .TH LIKWID-BENCH 1 <DATE> likwid\-<VERSION>
+.WARN
 .SH NAME
 likwid-bench \- low-level benchmark suite and microbenchmarking framework
 .SH SYNOPSIS
diff --git a/doc/likwid-perfscope.1 b/doc/likwid-perfscope.1
index 8c140ab..2d48e21 100644
--- a/doc/likwid-perfscope.1
+++ b/doc/likwid-perfscope.1
@@ -1,7 +1,7 @@
 .TH LIKWID-PERFSCOPE 1 <DATE> likwid\-<VERSION>
 .SH NAME
 likwid-perfscope \- Frontend for the timeline mode of
-.B likwid-perfctr(1)
+.N likwid-perfctr(1)
 that on-the-fly generates pictures from the measurements
 .SH SYNOPSIS
 .B likwid-perfscope 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/likwid/likwid.git



More information about the Likwid-commit mailing list