Gabe Black has uploaded this change for review. (
https://gem5-review.googlesource.com/c/public/gem5/+/58170 )
Change subject: scons: Flesh out the help text for "magic" targets.
......................................................................
scons: Flesh out the help text for "magic" targets.
These targets are not necessarily obvious, and tell SCons to do useful
things, like build a particular version of the gem5 binary with a
particular configuration, or run the unit tests.
Add descriptions of these targets to the help so that they are much
more discoverable.
Change-Id: If84399be1a7155ff5f66f511efe1f1c241089c84
---
M SConstruct
1 file changed, 70 insertions(+), 10 deletions(-)
diff --git a/SConstruct b/SConstruct
index e331054..ce4f1e6 100755
--- a/SConstruct
+++ b/SConstruct
@@ -44,15 +44,6 @@
#
# SCons top-level build description (SConstruct) file.
#
-# While in this directory ('gem5'), just type 'scons' to build the default
-# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
-# to build some other configuration (e.g., 'build/X86/gem5.opt' for
-# the optimized X86 version).
-#
-# You can build gem5 in a different directory as long as there is a
-# 'build/<CONFIG>' somewhere along the target path. The build system
-# expects that all configs under the same build directory are being
-# built for the same host system.
#
# Examples:
#
@@ -81,7 +72,7 @@
import os
import sys
-from os import mkdir, remove, environ
+from os import mkdir, remove, environ, listdir
from os.path import abspath, dirname, expanduser
from os.path import isdir, isfile
from os.path import join, split
@@ -183,6 +174,59 @@
# Find default configuration & binary.
Default(environ.get('M5_DEFAULT_BINARY', 'build/ARM/gem5.debug'))
+defconfig_dir = Dir('#defconfig')
+defconfigs = list([f for f in os.listdir(defconfig_dir.abspath) if
+ isfile(os.path.join(defconfig_dir.abspath, f))])
+defconfigs.sort()
+
+defconfig_list = '\n'.join(' ' * 10 + defconfig for defconfig in
defconfigs)
+
+Help(f"""
+Targets:
+ To build gem5 using a predefined configuration, use a target with
+ a directory called "build" in the path, followed by a directory
named
+ after a predefined configuration, and then the actual target,
likely
+ a gem5 binary. For example:
+
+ scons build/X86/gem5.opt
+
+ The "build" component tells SCons that the next part names an
initial
+ configuration, and the part after that is the actual target.
+ The predefined targets currently available are:
+
+{defconfig_list}
+
+ The extension on the gem5 binary specifies what type of binary to
+ build. Options are:
+
+ debug: A debug binary with optimizations turned off and debug info
+ turned on.
+ opt: An optimized binary with debugging still turned on.
+ fast: An optimized binary with debugging, asserts, and tracing
+ disabled.
+
+ gem5 can also be built as a static or dynamic library. In that
case,
+ the extension is fixed by the operating system, so the binary type
+ is part of the target file name. For example:
+
+ scons build/ARM/libgem5_opt.so
+
+ To build unit tests, you can use a target like this:
+
+ scons build/RISCV/unittests.debug
+
+ The unittests.debug part of the target is actual a directory which
+ holds the results for all the unit tests built with the "debug"
+ settings. When that's used as the target, SCons will build all the
+ files under that directory, which will run all the tests.
+
+ To build and run an individual test, you can built it's binary
+ specifically and then run it manually:
+
+ scons build/SPARC/base/bitunion.test.opt
+ build/SPARC/base/bitunion.test.opt
+""", append=True)
+
########################################################################
#
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/58170
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: If84399be1a7155ff5f66f511efe1f1c241089c84
Gerrit-Change-Number: 58170
Gerrit-PatchSet: 1
Gerrit-Owner: Gabe Black <gabe.bl...@gmail.com>
Gerrit-MessageType: newchange
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
