Skip to content

Commit

Permalink
Some fixes to README formatting and structure.
Browse files Browse the repository at this point in the history
Change-Id: Ifb16efa00407656c2c5b74e57d303b3d22cd0659
  • Loading branch information
xyzsam committed Feb 17, 2020
1 parent 2fb892c commit 273bcef
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ International Symposium on Performance Analysis of Systems and Software

Requirements:
-------------------
We *highly* recomend that users use the provided Docker image, available for download
[here](https://hub.docker.com/repository/docker/xyzsam/gem5-aladdin). This will solve
basically all environment issues. If you cannot use Docker, then read on.
We *highly* recommend that users use the provided Docker image, available for
download [here](https://hub.docker.com/repository/docker/xyzsam/gem5-aladdin).
This will solve basically all environment issues. If you cannot use Docker,
then read on.

1. LLVM 6.0 and Clang 6.0 64-bit. Users cannot download a pre-built package
because the Release build type strips value names from LLVM IR, and
Expand All @@ -25,11 +26,12 @@ basically all environment issues. If you cannot use Docker, then read on.
2. GCC 5.4 or later.
3. CMake 2.8.12 or newer.

Build:
Changelog:
-----------------
**Feburary 2020: New features**

## Breaking changes from v1.2 to v2.0: ##
### Feburary 2020: v2 new features ###

**Breaking changes from v1.2 to v2.0:**

* LLVM-Tracer now uses LLVM 6.0. Support for all previous versions of LLVM
have been removed. Minor versions 6.0.0 and 6.0.1 have been tested to work.
Expand All @@ -38,7 +40,7 @@ Build:
it is *highly* recommended that you build the `Debug` build type by adding
the cmake flag `-DCMAKE_BUILD_TYPE=Debug`.

## C++ support ##
#### C++ support ####

LLVM-Tracer now supports C++ for uninstrumented code! Users can write C++
to build applications and only have LLVM-Tracer instrument and generate
Expand All @@ -50,14 +52,16 @@ the class's constructor.

See playground/test.cc for a live example.

## Multithreading support ##
#### Multithreading support ####

LLVM-Tracer can now trace multithreaded applications. Each thread should call
the `llvmtracer_set_trace_name` API first to assign a unique name for the
dynamic trace file that will be produced.

See playground/multithreading.cc for an example.

### November 2016: v1.2 changelog ###

**Breaking changes from v1.1 to v1.2:**

* CMake is no longer optional. LLVM-Tracer only supports CMake for building.
Expand All @@ -67,6 +71,9 @@ See playground/multithreading.cc for an example.
`lib/` instead of `full-trace/` and `profile-func/`. The `BUILD_ON_SOURCE`
option has been removed.

Build:
-----------------

CMake is a configure tool which allows you to do out-of-source build.
LLVM-Tracer requires CMake newer than 2.8.12. By default, CMake
searches for LLVM 6.0.
Expand Down

0 comments on commit 273bcef

Please sign in to comment.