From: Matthias Jung <jungma@eit.uni-kl.de>
Date: Mon, 9 Jan 2017 15:33:42 +0000 (-0600)
Subject: misc: Documentation Update
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=5b08ae2372c4d20e332891b54c1266b30df90b3e;p=gem5.git

misc: Documentation Update

Updates for READMEs of /util/cxx_config, /util/systemc, /util/tlm.
Some minor corrections, mostly with respect to MAC/OSX

Signed-off-by: Jason Lowe-Power <jason@lowepower.com>
---

diff --git a/util/cxx_config/README b/util/cxx_config/README
index a80f7ad8f..50c15bd7b 100644
--- a/util/cxx_config/README
+++ b/util/cxx_config/README
@@ -19,6 +19,15 @@ needed):
 > scons --with-cxx-config --without-python build/ARM/libgem5_opt.so
 > cd util/cxx_config
 
+Note: For MAC / OSX this command should be used:
+> scons --with-cxx-config --without-python build/ARM/libgem5_opt.dylib
+
+Set a proper LD_LIBRARY_PATH e.g. for bash:
+> export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/path/to/gem5/build/ARM/"
+
+or for MAC / OSX:
+> export DYLD_LIBRARY_PATH="$DYLD_LIBRARY_PATH:/path/to/gem5/build/ARM/"
+
 Then edit Makefile to set the paths for PYTHON and run make
 
 > make
diff --git a/util/systemc/README b/util/systemc/README
index a886e0220..b05c81058 100644
--- a/util/systemc/README
+++ b/util/systemc/README
@@ -32,9 +32,29 @@ needed):
 > cd ../..
 > scons build/ARM/gem5.opt
 > scons --with-cxx-config --without-python build/ARM/libgem5_opt.so
-> cd util/cxx_config
+> cd util/systemc
 
-Then edit Makefile to set the paths for SystemC and run make
+Note: For MAC / OSX this command should be used:
+> scons --with-cxx-config --without-python build/ARM/libgem5_opt.dylib
+
+Set a proper LD_LIBRARY_PATH e.g. for bash:
+> export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/path/to/gem5/build/ARM/"
+
+or for MAC / OSX:
+> export DYLD_LIBRARY_PATH="$DYLD_LIBRARY_PATH:/path/to/gem5/build/ARM/"
+
+
+Then edit the Makefile to set the paths for SystemC, e.g:
+
+    Linux:
+    SYSTEMC_INC = /opt/systemc/include
+    SYSTEMC_LIB = /opt/systemc/lib-linux64
+
+    MAC / OSX:
+    SYSTEMC_INC = /opt/systemc/include
+    SYSTEMC_LIB = /opt/systemc/lib-macosx64
+
+Then run make:
 
 > make
 
@@ -57,3 +77,6 @@ This should print:
 The .ini file can also be read by the Python .ini file reader example:
 
 > ../../build/ARM/gem5.opt ../../configs/example/read_ini.py m5out/config.ini
+
+If you are interested in SystemC Transaction Level Modeling (TLM2) please have
+a look into /util/tlm.
diff --git a/util/tlm/README b/util/tlm/README
index fc620f145..cf2a4acfd 100644
--- a/util/tlm/README
+++ b/util/tlm/README
@@ -35,10 +35,26 @@ without python.
 > scons --with-cxx-config --without-python build/ARM/libgem5_opt.so
 > cd util/tlm
 
+Note: For MAC / OSX this command should be used:
+> scons --with-cxx-config --without-python build/ARM/libgem5_opt.dylib
+
 Set a proper LD_LIBRARY_PATH e.g. for bash:
 > export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/path/to/gem5/build/ARM/"
 
-Then edit the Makefile to set the paths for SystemC and run make
+or for MAC / OSX:
+> export DYLD_LIBRARY_PATH="$DYLD_LIBRARY_PATH:/path/to/gem5/build/ARM/"
+
+Then edit the Makefile to set the paths for SystemC:
+
+    Linux:
+    SYSTEMC_INC = /opt/systemc/include
+    SYSTEMC_LIB = /opt/systemc/lib-linux64
+
+    MAC / OSX:
+    SYSTEMC_INC = /opt/systemc/include
+    SYSTEMC_LIB = /opt/systemc/lib-macosx64
+
+Then run make:
 
 > make