Skip to content

Commit 70fa1ea

Browse files
updated readme file
1 parent 18be90f commit 70fa1ea

File tree

2 files changed

+44
-44
lines changed

2 files changed

+44
-44
lines changed

README.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,50 @@
22
<h2>Table of Contents</h2>
33
<div id="text-table-of-contents">
44
<ul>
5-
<li><a href="#orgb7da3f4">1. License</a></li>
6-
<li><a href="#org69e9e53">2. Introduction</a></li>
7-
<li><a href="#org217b743">3. Prerequisites</a></li>
8-
<li><a href="#org7b62322">4. Installation</a>
5+
<li><a href="#org8ca70b5">1. License</a></li>
6+
<li><a href="#orgc6a2b10">2. Introduction</a></li>
7+
<li><a href="#org3249413">3. Prerequisites</a></li>
8+
<li><a href="#org9a459f1">4. Installation</a>
99
<ul>
10-
<li><a href="#orgb144c8f">4.1. Automatic Building</a></li>
11-
<li><a href="#orga24197f">4.2. Manual Building</a>
10+
<li><a href="#org5074a2e">4.1. Automatic Building</a></li>
11+
<li><a href="#org7099418">4.2. Manual Building</a>
1212
<ul>
13-
<li><a href="#org603c87a">4.2.1. Stand-alone building with official LLVM OpenMP Runtime and ThreadSanitizer OMPT support</a></li>
13+
<li><a href="#org8f09f21">4.2.1. Stand-alone building with official LLVM OpenMP Runtime and ThreadSanitizer OMPT support</a></li>
1414
</ul>
1515
</li>
16-
<li><a href="#orgca14700">4.3. Build Archer within Clang/LLVM</a></li>
16+
<li><a href="#orgb799b9e">4.3. Build Archer within Clang/LLVM</a></li>
1717
</ul>
1818
</li>
19-
<li><a href="#org7ea4464">5. Usage</a>
19+
<li><a href="#orgb820ad0">5. Usage</a>
2020
<ul>
21-
<li><a href="#orgafdd25c">5.1. How to compile</a>
21+
<li><a href="#org213ff1a">5.1. How to compile</a>
2222
<ul>
23-
<li><a href="#orgb8c2451">5.1.1. Single source</a></li>
24-
<li><a href="#org06407db">5.1.2. Makefile</a></li>
25-
<li><a href="#org793aee7">5.1.3. Hybrid MPI-OpenMP programs</a></li>
23+
<li><a href="#orgf7abb97">5.1.1. Single source</a></li>
24+
<li><a href="#orgf87b00e">5.1.2. Makefile</a></li>
25+
<li><a href="#org7009afe">5.1.3. Hybrid MPI-OpenMP programs</a></li>
2626
</ul>
2727
</li>
28-
<li><a href="#org056c2b1">5.2. Options</a></li>
29-
<li><a href="#orgb83c4fb">5.3. Command-Line Flags</a></li>
30-
<li><a href="#org0e47352">5.4. Runtime Flags</a></li>
28+
<li><a href="#org1af9794">5.2. Options</a></li>
29+
<li><a href="#orge5e8c59">5.3. Command-Line Flags</a></li>
30+
<li><a href="#org110062c">5.4. Runtime Flags</a></li>
3131
</ul>
3232
</li>
33-
<li><a href="#org98a2e4d">6. Example</a></li>
34-
<li><a href="#org21b6e2e">7. Contacts and Support</a></li>
35-
<li><a href="#orgea44b97">8. Members</a></li>
33+
<li><a href="#org73e58a9">6. Example</a></li>
34+
<li><a href="#orgcc38a36">7. Contacts and Support</a></li>
35+
<li><a href="#org9999451">8. Members</a></li>
3636
</ul>
3737
</div>
3838
</div>
3939

4040

41-
<a id="orgb7da3f4"></a>
41+
<a id="org8ca70b5"></a>
4242

4343
# License
4444

4545
Please see LICENSE for usage terms.
4646

4747

48-
<a id="org69e9e53"></a>
48+
<a id="orgc6a2b10"></a>
4949

5050
# Introduction
5151

@@ -60,7 +60,7 @@ on open-source tools infrastructure such as LLVM, ThreadSanitizer, and
6060
OMPT to provide portability.
6161

6262

63-
<a id="org217b743"></a>
63+
<a id="org3249413"></a>
6464

6565
# Prerequisites
6666

@@ -76,23 +76,23 @@ development at <https://github.com/OpenMPToolsInterface/LLVM-openmp>
7676
(under the branch "tr4-stable").
7777

7878

79-
<a id="org7b62322"></a>
79+
<a id="org9a459f1"></a>
8080

8181
# Installation
8282

8383
Archer has been developed under LLVM 3.9 (for more information visit
8484
<http://llvm.org>).
8585

8686

87-
<a id="orgb144c8f"></a>
87+
<a id="org5074a2e"></a>
8888

8989
## Automatic Building
9090

9191
For an automatic building script (recommended) please visit the GitHub
9292
page <https://github.com/PRUNERS/llvm_archer>.
9393

9494

95-
<a id="orga24197f"></a>
95+
<a id="org7099418"></a>
9696

9797
## Manual Building
9898

@@ -105,7 +105,7 @@ based on bash shell, Clang/LLVM 3.9 version, Ninja build system, and
105105
the LLVM OpenMP Runtime with OMPT support).
106106

107107

108-
<a id="org603c87a"></a>
108+
<a id="org8f09f21"></a>
109109

110110
### Stand-alone building with official LLVM OpenMP Runtime and ThreadSanitizer OMPT support
111111

@@ -156,7 +156,7 @@ and build it with the following commands:
156156
cd ../..
157157

158158

159-
<a id="orgca14700"></a>
159+
<a id="orgb799b9e"></a>
160160

161161
## Build Archer within Clang/LLVM
162162

@@ -298,12 +298,12 @@ To make the environment permanent, add the previous lines or
298298
equivalents to your shell start-up script such as "~/.bashrc".
299299

300300

301-
<a id="org7ea4464"></a>
301+
<a id="orgb820ad0"></a>
302302

303303
# Usage
304304

305305

306-
<a id="orgafdd25c"></a>
306+
<a id="org213ff1a"></a>
307307

308308
## How to compile
309309

@@ -324,14 +324,14 @@ library *libarcher.so*. (In the example below the runtime library will
324324
be shown in square brackets).
325325

326326

327-
<a id="orgb8c2451"></a>
327+
<a id="orgf7abb97"></a>
328328

329329
### Single source
330330

331331
clang-archer example.c -o example [ -L/path/to/archer/runtime/library -larcher ]
332332

333333

334-
<a id="org06407db"></a>
334+
<a id="orgf87b00e"></a>
335335

336336
### Makefile
337337

@@ -341,7 +341,7 @@ In your Makefile, set the following variables:
341341
[ LD_FLAGS=-L/path/to/archer/runtime/library -larcher ]
342342

343343

344-
<a id="org793aee7"></a>
344+
<a id="org7009afe"></a>
345345

346346
### Hybrid MPI-OpenMP programs
347347

@@ -351,15 +351,15 @@ In your Makefile, set the following variables:
351351
[ LD_FLAGS=-L/path/to/archer/runtime/library -larcher ]
352352

353353

354-
<a id="org056c2b1"></a>
354+
<a id="org1af9794"></a>
355355

356356
## Options
357357

358358
The command *clang-archer* works as a compiler wrapper, all the
359359
options available for clang are also available for *clang-archer*.
360360

361361

362-
<a id="orgb83c4fb"></a>
362+
<a id="orge5e8c59"></a>
363363

364364
## Command-Line Flags
365365

@@ -389,13 +389,13 @@ options available for clang are also available for *clang-archer*.
389389
<td class="org-left">&#45;&#45;sa</td>
390390
<td class="org-left">disabled</td>
391391
<td class="org-left">>= 6.0.1</td>
392-
<td class="org-left">Enable static analysis (runtime and memory overhead may be longer).</td>
392+
<td class="org-left">Enable static analysis (can reduce runtime and memory overhead).</td>
393393
</tr>
394394
</tbody>
395395
</table>
396396

397397

398-
<a id="org0e47352"></a>
398+
<a id="org110062c"></a>
399399

400400
## Runtime Flags
401401

@@ -454,7 +454,7 @@ different flags are separated by spaces, e.g.:
454454
</table>
455455

456456

457-
<a id="org98a2e4d"></a>
457+
<a id="org73e58a9"></a>
458458

459459
# Example
460460

@@ -518,7 +518,7 @@ the report will look as follow:
518518
ThreadSanitizer: reported 1 warnings
519519

520520

521-
<a id="org21b6e2e"></a>
521+
<a id="orgcc38a36"></a>
522522

523523
# Contacts and Support
524524

@@ -531,7 +531,7 @@ the report will look as follow:
531531
<ul style="list-style-type:circle"> <li> <a href="mailto:[email protected]?Subject=[archer-dev]%20" target="_top">Simone Atzeni</a> </li> <li> <a href="mailto:[email protected]?Subject=[archer-dev]%20" target="_top">Joachim Protze</a> </li> </ul>
532532

533533

534-
<a id="orgea44b97"></a>
534+
<a id="org9999451"></a>
535535

536536
# Members
537537

README.org

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -391,11 +391,11 @@ options available for clang are also available for /clang-archer/.
391391

392392
** Command-Line Flags
393393

394-
|--------------+---------------+--------------------+---------------------------------------------------------------------|
395-
| Flag Name | Default value | Clang/LLVM Version | Description |
396-
|--------------+---------------+--------------------+---------------------------------------------------------------------|
397-
| &#45;&#45;sa | disabled | >= 6.0.1 | Enable static analysis (runtime and memory overhead may be longer). |
398-
|--------------+---------------+--------------------+---------------------------------------------------------------------|
394+
|--------------+---------------+--------------------+------------------------------------------------------------------|
395+
| Flag Name | Default value | Clang/LLVM Version | Description |
396+
|--------------+---------------+--------------------+------------------------------------------------------------------|
397+
| &#45;&#45;sa | disabled | >= 6.0.1 | Enable static analysis (can reduce runtime and memory overhead). |
398+
|--------------+---------------+--------------------+------------------------------------------------------------------|
399399

400400
** Runtime Flags
401401

0 commit comments

Comments
 (0)