website: Update building doc to reflect .prof/.perf removal
As of this change:
https://gem5-review.googlesource.com/c/public/gem5/+/51988 the perf and
prof builds have been removed and replaced with `--gprof` and `--pprof`
compilation flags. This patch updates the building documentation to
reflect this.
Change-Id: Ia88b7b1769edac688dbaad4b899de4812599ec61
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5-website/+/55685
Reviewed-by: Gabe Black <gabe.black@gmail.com>
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Bobby Bruce <bbruce@ucdavis.edu>
diff --git a/_pages/documentation/general_docs/building/index.md b/_pages/documentation/general_docs/building/index.md
index e9fc795..f07ccdc 100644
--- a/_pages/documentation/general_docs/building/index.md
+++ b/_pages/documentation/general_docs/building/index.md
@@ -177,24 +177,14 @@
of run time error checking and the ability to turn on debug output. This
version is recommended if you're very confident everything is working correctly
and want to get peak performance from the simulator.
-* **prof** is similar to gem5.fast but also includes instrumentation that
-allows it to be used with the gprof profiling tool. This version is not needed
-very often, but can be used to identify the areas of gem5 that should be
-focused on to improve performance.
-* **perf** also includes instrumentation, but does so using google perftools,
-allowing it to be profiled with google-pprof. This profiling version is
-complementary to gem5.prof, and can probably replace it for all Linux-based
-systems.
These versions are summarized in the following table.
-|Build variant|Optimizations|Run time debugging support|Profiling support|
-|-------------|-------------|--------------------------|-----------------|
-|**debug** | |X | |
-|**opt** |X |X | |
-|**fast** |X | | |
-|**prof** |X | |X |
-|**perf** |X | |X |
+|Build variant|Optimizations|Run time debugging support|
+|-------------|-------------|--------------------------|
+|**debug** | |X |
+|**opt** |X |X |
+|**fast** |X | |
For example, to build gem5 on 4 threads with `opt` and targeting x86:
@@ -202,6 +192,16 @@
scons build/X86/gem5.opt -j 4
```
+In addition, users may make use of the "gprof" and "pperf" build options to
+enable profiling:
+
+* **gprof** allows gem5 to be used with the gprof profiling tool. It can be
+enabled by compiling with the `--gprof` flag. E.g.,
+`scons build/ARM/gem5.debug --gprof`.
+* **pprof** allows gem5 to be used with the pprof profiling tool. It can be
+enabled by compiling with the `--pprof` flag. E.g.,
+`scons build/X86/gem5.debug --pprof`.
+
## Usage
Once compiled, gem5 can then be run using:
