Skip to content

Commit

Permalink
Doc: Rename svn into git, add instructions to build with perf-events
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
laksono committed Oct 10, 2017
1 parent 528c238 commit 6a790af
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/README
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This file contains notes for developers on how to edit and install
files in the docs subdirectory. The toolkit docs are handled
differently from the rest of the source code.

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

To edit the www/html files in the svn source tree:
To edit the www/html files in the git source tree:

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

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

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

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

6. When you're satisfied with your edits, then 'svn commit' from the
svn source tree.
6. When you're satisfied with your edits, then 'git commit' from the
git source tree.

Note: always edit the html.in files (source directory) and run make
from the build directory. If you're only editing doc files, you may
Expand Down
7 changes: 7 additions & 0 deletions doc/www/software-instructions.html
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,13 @@ <h2>Building and Installing</h2>

<ol class="noindent">

<li>Configuring the perf_events sample source:
<p>
HPCToolkit's configure command will automatically check the availability of the Linux perf_events interface on the build system.
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.
</p>
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.
</li>
<li><p>Build and install HPCToolkit's Externals, which typically does not require any special options; we recommend using the GCC compilers:
</p>
<div class="indent">
Expand Down
7 changes: 7 additions & 0 deletions doc/www/software-instructions.html.in
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,13 @@ Please note that a list of examples below provides <code>configure</code> comman

<ol class="noindent">

<li>Configuring the perf_events sample source:
<p>
HPCToolkit's configure command will automatically check the availability of the Linux perf_events interface on the build system.
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.
</p>
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.
</li>
<li><p>Build and install HPCToolkit's Externals, which typically does not require any special options; we recommend using the GCC compilers:
</p>
<div class="indent">
Expand Down

0 comments on commit 6a790af

Please sign in to comment.