F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document example and test filtering per module feature

Browse Source
This commit is contained in:
Gabriel Ferreira
2023-08-24 20:29:05 +00:00
parent 1d980f33ce
commit 7ffbde57a1
2 changed files with 49 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
doc/manual/source/enable-tests.rst
View File

@@ -173,3 +173,48 @@ Running test.py will cause all of the examples and tests to be run:
.. sourcecode:: text
170 of 170 tests passed (170 passed, 0 skipped, 0 failed, 0 crashed, 0 valgrind errors)
Enable examples and tests that depend on a set of modules using |ns3|
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
As seen above, the following command only builds the requested modules (core and wifi),
plus any modules that are implicitly needed (e.g., network), and the resulting compatible examples and tests:
.. sourcecode:: terminal
./ns3 configure --enable-modules="wifi;core" --enable-examples --enable-tests
However, when developing a new module, you may prefer to use the following alternative, which builds
all module libraries, but will filter out any examples and tests from modules that are not explicitly listed.
.. sourcecode:: terminal
./ns3 configure --filter-module-examples-and-tests="wifi;core" --enable-examples --enable-tests
The first command will generally lead to a shorter build time, but the second option will provide better
coverage, by building additional test cases and examples directly related to the specified modules.
Enable examples and tests that depend on a set of modules using the |ns3| configuration file
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
As seen above, examples and tests can be enabled for just a subset of the available modules via the
``ns3`` script. The same can be accomplished via the ``.ns3rc`` configuration file.
.. sourcecode:: cmake
# A list of the modules that will be enabled when ns-3 is run.
# Modules that depend on the listed modules will be enabled also.
#
# All modules can be enabled by emptying the list.
set(ns3rc_enabled_modules)
# ...
# Override other ns-3 settings by setting their values below
# Note: command-line settings will also be overridden.
#set(NS3_LOG ON)
# The following will build core and wifi tests, plus their examples
# and examples on /ns-3-dev/examples that depend on either of them
set(NS3_FILTER_MODULE_EXAMPLES_AND_TESTS wifi core) # <==

7
ns3
View File

@@ -167,13 +167,14 @@ def parse_args(argv):
parser_configure = on_off_argument(parser_configure, *on_off_option)
parser_configure.add_argument('--enable-modules',
help='List of modules to build (e.g. core;network;internet)',
help='List of modules to build (e.g. \"core;network;internet\")',
action="store", type=str, default=None)
parser_configure.add_argument('--disable-modules',
help='List of modules not to build (e.g. lte;wimax)',
help='List of modules not to build (e.g. \"lte;wimax\")',
action="store", type=str, default=None)
parser_configure.add_argument('--filter-module-examples-and-tests',
help='List of modules that should have their examples and tests built (e.g. lte;wifi)',
help=('List of modules that should have their examples '
'and tests built (e.g. \"lte;wifi\")'),
action="store", type=str, default=None)
parser_configure.add_argument('--lcov-report',
help=('Generate a code coverage report '