Skip to content

Commit a11bbb1

Browse files
committed
Fix md syntax in README file
1 parent 893912a commit a11bbb1

File tree

1 file changed

+16
-19
lines changed

1 file changed

+16
-19
lines changed

README.md

+16-19
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
#Score-P power and energy event plugin counter
1+
# Score-P power and energy event plugin counter
22

3-
This is the Score-P power and energy event plugin counter for Intel Sandybridge
4-
and AMD Bulldozer. The plugin supports reading `msr` registers directly or through the `x86_adapt`
5-
library.
3+
This is the Score-P power and energy event plugin counter for Intel Sandy Bridge and AMD Bulldozer. The plugin supports reading `msr` registers directly or through the `x86_adapt` library.
64

7-
##Compilation and Installation
5+
## Compilation and Installation
86

9-
###Prerequisites
7+
### Prerequisites
108

119
To compile this plugin, you need:
1210

@@ -30,7 +28,7 @@ To compile this plugin, you need:
3028
The kernel module `x86_adapt_driver` should be active and and should have reading access to
3129
`/dev/x86_adapt/cpu/*`.
3230

33-
###Build Options
31+
### Build Options
3432

3533
* `X86E_STATIC` (default off)
3634

@@ -53,7 +51,7 @@ To compile this plugin, you need:
5351

5452
Build for Score-P (alternative: build for VampirTrace).
5553

56-
###Building
54+
### Building
5755

5856
1. Create a build directory
5957

@@ -89,9 +87,9 @@ To compile this plugin, you need:
8987
> If `x86_energy` is linked dynamic then the location of `x86_energy` has to be in the
9088
> `LD_LIBRARY_PATH` as well.
9189
92-
##Usage
90+
## Usage
9391

94-
###Score-P
92+
### Score-P
9593

9694
To add a kernel event counter to your trace, you have to specify the environment variable
9795
`SCOREP_METRIC_PLUGINS`, e.g.
@@ -100,23 +98,23 @@ To add a kernel event counter to your trace, you have to specify the environment
10098

10199
Then you can select the software events that shall be recorded (see "Available Metrics").
102100

103-
###VampirTrace
101+
### VampirTrace
104102

105103
To add a kernel event counter to your trace, you have to specify the environment variable
106104
`VT_PLUGIN_CNTR_METRICS`.
107105

108-
###Available Metrics
106+
### Available Metrics
109107

110108
`SCOREP_METRIC_X86ENERGY_PLUGIN`/`VT_PLUGIN_CNTR_METRICS` specifies the software events that shall
111109
be recorded when tracing an application. You can add the following metrics:
112110

113111
* `*_energy`
114112

115-
Collect energy consumption information for every avaible counter.
113+
Collect energy consumption information for every available counter.
116114

117115
* `*_power`
118116

119-
Collect power consumption information for every avabile counter.
117+
Collect power consumption information for every available counter.
120118

121119
* `package_energy`
122120

@@ -158,7 +156,7 @@ or for VampirTrace:
158156

159157
export VT_PLUGIN_CNTR_METRICS=X86ENERGY_*_energy
160158

161-
###Environment variables
159+
### Environment variables
162160

163161
* `SCOREP_X86ENERGY_INTERVAL_US`/`VT_X86ENERGY_INTERVAL_US` (default=100000)
164162

@@ -180,7 +178,7 @@ or for VampirTrace:
180178
The size of the buffer for storing samples. Can be suffixed with G, M, and K.
181179

182180
The buffer size is per counter per package, e.g., on a system with 3 energy counters, 2 sockets
183-
and 4 MB bufer size this would be 24 MB in total.
181+
and 4 MB buffer size this would be 24 MB in total.
184182

185183
Typically, a sample consists of a 8 byte timestamp and 8 byte per selected counter. If the
186184
buffer is too small, it might not be capable of storing all events. If this is the case, then an
@@ -190,16 +188,15 @@ or for VampirTrace:
190188

191189
Save event data synchronously. *Use at your own risk!*
192190

193-
###If anything fails
191+
### If anything fails
194192

195193
1. Check whether the plugin library can be loaded from the `LD_LIBRARY_PATH`.
196194

197195
2. Check whether you are allowed to read `/dev/cpu/*/msr`.
198196

199197
3. Write a mail to the author.
200198

201-
##Authors
199+
## Authors
202200

203201
* Joseph Schuchart (joseph.schuchart at tu-dresden dot de)
204-
205202
* Michael Werner (michael.werner3 at tu-dresden dot de)

0 commit comments

Comments
 (0)