summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew M. B. Boktor <[email protected]>2011-11-09 14:14:23 -0800
committerAndrew Boktor <[email protected]>2014-08-14 13:18:24 -0700
commit80483f2768a15ed1d8df6a11c60c75882e7622bd (patch)
treea5ba77480fd613fdf295b2494dd694aa0d7954bb
parentb0aa7577347f16cb825a053ef4e1068aec5006a0 (diff)
Added a new target for doxygen in the makefile and updated the README with that info.
"make docs" to build and "make cleandocs" to clean. You have to have doxygen and graphviz installed. The new docs target doesn't build with the simulator (you have to call it explicitly) to avoid giving unecessary errors to people. [git-p4: depot-paths = "//depot/gpgpu_sim_research/fermi/distribution/": change = 10872]
-rw-r--r--Makefile6
-rw-r--r--README5
2 files changed, 11 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index ddf3ca7..eed9f8f 100644
--- a/Makefile
+++ b/Makefile
@@ -138,6 +138,12 @@ makedirs:
all:
$(MAKE) gpgpusim
+docs:
+ $(MAKE) -C doc/doxygen/
+
+cleandocs:
+ $(MAKE) clean -C doc/doxygen/
+
clean:
$(MAKE) cleangpgpusim
diff --git a/README b/README
index f2adb78..f4f867a 100644
--- a/README
+++ b/README
@@ -77,6 +77,11 @@ simulator in gdb to debug it, then uncomment the line
in setup_environment and type "source setup_environment" again, then "make" again.
+Step 4.1 [optional]: Type "make docs" in this directory to build the doxygen
+documentation. You need to have doxygen and graphviz installed for this to work.
+"make cleandocs" will remove the generated documentation. The documentation resides
+at doc/doxygen/html.
+
Step 5: Copy or create the configuration files gpgpusim.conf and \
icnt_config_quadro_islip.txt in your working directory. Sample configuration
files are provided under gpgpu-sim/v3.x/configs/*/