Skip to content
This repository was archived by the owner on Apr 2, 2025. It is now read-only.

Commit 6a790af

Browse files
committed
Doc: Rename svn into git, add instructions to build with perf-events
Minor update in the www html part with information on building with perf-events for remote machines. Also rename svn words into git. We don't use svn anymore.
1 parent 528c238 commit 6a790af

3 files changed

Lines changed: 20 additions & 6 deletions

File tree

doc/README

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This file contains notes for developers on how to edit and install
66
files in the docs subdirectory. The toolkit docs are handled
77
differently from the rest of the source code.
88

9-
Briefly, we keep both source and generated doc files in the svn tree.
9+
Briefly, we keep both source and generated doc files in the git tree.
1010
In some cases (manual), building the doc files from source requires
1111
tools (latex) outside the normal build procedure. In that case,
1212
'make' doesn't regenerate the doc files, and 'make install' merely
@@ -29,9 +29,9 @@ Use either no target or target 'all'.
2929
WWW directory and html files
3030
-----------------------------
3131

32-
To edit the www/html files in the svn source tree:
32+
To edit the www/html files in the git source tree:
3333

34-
1. Svn checkout and configure as usual. If you're using this sandbox
34+
1. Git checkout and configure as usual. If you're using this sandbox
3535
only to edit doc files, then you can omit the --with-externals option.
3636

3737
2. In the source doc/www directory, edit the *.html.in files. Just
@@ -40,7 +40,7 @@ style that's there.
4040

4141
3. From the *build* directory, eg, build/doc/www, run 'make'. This
4242
will remake the *.html files back in the source directory. You can
43-
check this with svn stat or diff. There should be corresponding diffs
43+
check this with git stat or diff. There should be corresponding diffs
4444
in both the html.in and html files.
4545

4646
4. Still in the build/doc/www directory, run 'make install'. This
@@ -49,8 +49,8 @@ installs a copy of the html files into install/share/doc/hpctoolkit/.
4949
5. View the new files by opening a web browser on index.html in the
5050
*install* directory: install/share/doc/hpctoolkit/index.html.
5151

52-
6. When you're satisfied with your edits, then 'svn commit' from the
53-
svn source tree.
52+
6. When you're satisfied with your edits, then 'git commit' from the
53+
git source tree.
5454

5555
Note: always edit the html.in files (source directory) and run make
5656
from the build directory. If you're only editing doc files, you may

doc/www/software-instructions.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,13 @@ <h2>Building and Installing</h2>
239239

240240
<ol class="noindent">
241241

242+
<li>Configuring the perf_events sample source:
243+
<p>
244+
HPCToolkit's configure command will automatically check the availability of the Linux perf_events interface on the build system.
245+
The test includes checking the existence of <code>/usr/include/linux/perf_event.h</code> and <code>/proc/sys/kernel/perf_event_paranoid</code> files. If the two files do not exist, it assumes the system does not support the perf_events interface.
246+
</p>
247+
To profile on a remote machine that has different system or architecture configuration, one must download and build the libpfm4 library (<a href="http://perfmon2.sourceforge.net">http://perfmon2.sourceforge.net</a>) and indicate its install directory by specifying the option <code>--with-perfmon=&lt;libpfm4_install_directory&gt;</code> to HPCToolkit's <code>configure</code> command.
248+
</li>
242249
<li><p>Build and install HPCToolkit's Externals, which typically does not require any special options; we recommend using the GCC compilers:
243250
</p>
244251
<div class="indent">

doc/www/software-instructions.html.in

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,13 @@ Please note that a list of examples below provides <code>configure</code> comman
240240

241241
<ol class="noindent">
242242

243+
<li>Configuring the perf_events sample source:
244+
<p>
245+
HPCToolkit's configure command will automatically check the availability of the Linux perf_events interface on the build system.
246+
The test includes checking the existence of <code>/usr/include/linux/perf_event.h</code> and <code>/proc/sys/kernel/perf_event_paranoid</code> files. If the two files do not exist, it assumes the system does not support the perf_events interface.
247+
</p>
248+
To profile on a remote machine that has different system or architecture configuration, one must download and build the libpfm4 library (<a href="http://perfmon2.sourceforge.net">http://perfmon2.sourceforge.net</a>) and indicate its install directory by specifying the option <code>--with-perfmon=&lt;libpfm4_install_directory&gt;</code> to HPCToolkit's <code>configure</code> command.
249+
</li>
243250
<li><p>Build and install HPCToolkit's Externals, which typically does not require any special options; we recommend using the GCC compilers:
244251
</p>
245252
<div class="indent">

0 commit comments

Comments
 (0)