diff --git a/CHANGES.md b/CHANGES.md index af6ab053b..f4f4c09d6 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -33,6 +33,12 @@ Changes from ns-3.36 to ns-3.37 ### Changes to build system +* Enabled precompiled headers (`NS3_PRECOMPILE_HEADERS`) by default when CCache is found. +* Added a `./ns3 show targets` option to list buildable/runnable targets. +* Replaced `./ns3 --check-config` with `./ns3 show config`. +* Replaced `./ns3 --check-profile` with `./ns3 show profile`. +* Replaced `./ns3 --check-version` with `./ns3 show version`. + ### Changed behavior * Lr-wpan: **LrWpanPhy** now change to TRX_OFF after a CSMA-CA failure when the RxOnWhenIdle flag is set to false in the **LrWpanMac**. diff --git a/doc/tutorial/source/getting-started.rst b/doc/tutorial/source/getting-started.rst index 567b2227b..0cb0751d7 100644 --- a/doc/tutorial/source/getting-started.rst +++ b/doc/tutorial/source/getting-started.rst @@ -691,7 +691,7 @@ would not be enabled and a message would be displayed. Note further that there a feature to use the program ``sudo`` to set the suid bit of certain programs. This is not enabled by default and so this feature is reported as "not enabled." Finally, to reprint this summary of which optional features are enabled, use -the ``--check-config`` option to ns3. +the ``show config`` option to ns3. Now go ahead and switch back to the debug build that includes the examples and tests. @@ -715,7 +715,7 @@ for an already configured project: .. sourcecode:: console - $ ./ns3 --check-profile + $ ./ns3 show profile Build profile: debug The build.py script discussed above supports also the ``--enable-examples`` @@ -1495,12 +1495,12 @@ or If these prerequisites are not met, the configuration will fail. When these prerequisites are met and ns-3 is configured with the -``--enable-build-version`` option, the ns3 command ``--check-version`` can be +``--enable-build-version`` option, the ns3 command ``show version`` can be used to query the local git repository and display the current version metadata. .. sourcecode:: console - $ ./ns3 --check-version + $ ./ns3 show version ns3 will collect information about the build and print out something similar to the output below. @@ -1509,7 +1509,7 @@ to the output below. ns-3.33+249@g80e0dd0-dirty-debug -If ``--check-version`` is run when ``-enable-build-version`` was not configured, +If ``show version`` is run when ``--enable-build-version`` was not configured, an error message indicating that the option is disabled will be displayed instead. .. sourcecode:: text @@ -1517,10 +1517,10 @@ an error message indicating that the option is disabled will be displayed instea Build version support is not enabled, reconfigure with --enable-build-version flag The build information is generated by examining the current state of the git -repository. The output of ``--check-version`` will change whenever the state +repository. The output of ``show version`` will change whenever the state of the active branch changes. -The output of ``--check-version`` has the following format: +The output of ``show version`` has the following format: .. sourcecode:: text @@ -1559,7 +1559,7 @@ profile A new class, named Version, has been added to the core module. The Version class contains functions to retrieve individual fields of the build version as well -as functions to print the full build version like ``--check-version``. +as functions to print the full build version like ``show version``. The ``build-version-example`` application provides an example of how to use the Version class to retrieve the various build version fields. See the documentation for the Version class for specifics on the output of the Version @@ -1598,7 +1598,7 @@ option which will print the full build version and exit. ns-3.33+249@g80e0dd0-dirty-debug If the ``--enable-build-version`` option was not configured, ``--version`` -will print out a message similar to ``--check-version`` indicating that the build +will print out a message similar to ``show version`` indicating that the build version option is not enabled. Source version