aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorGravatar Benjamin Barenblat <bbarenblat@galois.com>2014-03-04 16:23:30 -0800
committerGravatar Benjamin Barenblat <bbarenblat@galois.com>2014-03-04 16:24:21 -0800
commitc1bf51b8e23c9f2d8d3147fe259a77b8f202e71a (patch)
tree8933e46995dfba3f2022656c3873fc7857b083c9 /README
parentdf0ab6ea1b788c682e3a2afa8ab4672f27504e94 (diff)
Tell Windows users to build with '--disable-shared'
As detailed in GitHub issue #1, attempting to build ppamltracer as a shared library on Cygwin fails. I believed commit bfc92ba (‘autotools: Don’t build DLLs on Cygwin by default’) fixed this; it does, but it also disables shared library building on non-Cygwin systems. We need to do a release, so this bug is getting deferred until later; for the time being, the documented workaround is to pass '--disable-shared' to 'configure'.
Diffstat (limited to 'README')
-rw-r--r--README13
1 files changed, 10 insertions, 3 deletions
diff --git a/README b/README
index e04c6be..b6de939 100644
--- a/README
+++ b/README
@@ -1,8 +1,8 @@
ppamltracer, v0.1.0
-ppamltracer is a lightweight tracing library designed for explicit instrumentation
-of generated code. If you're writing a compiler and need hard data on your
-optimizer's efficacy, ppamltracer is the library for you.
+ppamltracer is a lightweight tracing library designed for explicit
+instrumentation of generated code. If you're writing a compiler and need hard
+data on your optimizer's efficacy, ppamltracer is the library for you.
ppamltracer writes trace logs in the Open Trace Format [1], a free and open
standard developed by the Zentrum für Informationsdienste und
@@ -19,6 +19,13 @@ For examples that use the C API, see the examples directory. For examples that
use the APIs presented by the various language bindings, see the READMEs
associated with those bindings.
+*******************************************************************************
+* ATTENTION WINDOWS USERS: *
+* *
+* ppamltracer cannot build shared libraries on Cygwin. If you are building *
+* on Cygwin, please pass the --disable-shared option to 'configure'. *
+*******************************************************************************
+
[1] http://tu-dresden.de/die_tu_dresden/zentrale_einrichtungen/zih/forschung/projekte/otf
[2] http://darpa.mil/Our_Work/I2O/Programs/Probabilistic_Programming_for_Advanced_Machine_Learning_(PPAML%29.aspx)