build: clean up make help output

This change is designed to help the uninformed find the right way
to run extended tests by using the test-all[-debug] targets.
'make test EXTENDED_TESTS=y' fails to build as it has a dependency
on 'vom-install' which is conveniently included in test-all[-debug].

- clarify test-all[-debug] description and
  make test-help description
- Also align indentation of make help output

Type: style

Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
Change-Id: Ief54cc8a5af68c052aacb0d660237c5eb63451b5

diff --git a/Makefile b/Makefile
index 923b0e8..cca8534 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -179,57 +179,57 @@ endef
 
 help:
        @echo "Make Targets:"
-       @echo " install-dep         - install software dependencies"
-       @echo " wipe                - wipe all products of debug build "
-       @echo " wipe-release        - wipe all products of release build "
-       @echo " build               - build debug binaries"
-       @echo " build-release       - build release binaries"
-       @echo " build-coverity      - build coverity artifacts"
-       @echo " rebuild             - wipe and build debug binares"
-       @echo " rebuild-release     - wipe and build release binares"
-       @echo " run                 - run debug binary"
-       @echo " run-release         - run release binary"
-       @echo " debug               - run debug binary with debugger"
-       @echo " debug-release       - run release binary with debugger"
-       @echo " test                - build and run (basic) functional tests"
-       @echo " test-debug          - build and run (basic) functional tests (debug build)"
-       @echo " test-all            - build and run (all) functional tests"
-       @echo " test-all-debug      - build and run (all) functional tests (debug build)"
-       @echo " test-gcov           - build and run functional tests (gcov build)"
-       @echo " test-shell          - enter shell with test environment"
-       @echo " test-shell-debug    - enter shell with test environment (debug build)"
-       @echo " test-wipe           - wipe files generated by unit tests"
-       @echo " retest              - run functional tests"
-       @echo " retest-debug        - run functional tests (debug build)"
-       @echo " test-help           - show help on test framework"
-       @echo " run-vat             - run vpp-api-test tool"
-       @echo " pkg-deb             - build DEB packages"
-       @echo " pkg-deb-debug       - build DEB debug packages"
-       @echo " vom-pkg-deb         - build vom DEB packages"
-       @echo " vom-pkg-deb-debug   - build vom DEB debug packages"
-       @echo " pkg-rpm             - build RPM packages"
-       @echo " install-ext-deps    - install external development dependencies"
-       @echo " ctags               - (re)generate ctags database"
-       @echo " gtags               - (re)generate gtags database"
-       @echo " cscope              - (re)generate cscope database"
-       @echo " checkstyle          - check coding style"
-       @echo " fixstyle            - fix coding style"
-       @echo " doxygen             - (re)generate documentation"
-       @echo " bootstrap-doxygen   - setup Doxygen dependencies"
-       @echo " wipe-doxygen        - wipe all generated documentation"
-       @echo " checkfeaturelist    - check FEATURE.yaml according to schema"
-       @echo " featurelist         - dump feature list in markdown"
-       @echo " json-api-files      - (re)-generate json api files"
+       @echo " install-dep          - install software dependencies"
+       @echo " wipe                 - wipe all products of debug build "
+       @echo " wipe-release         - wipe all products of release build "
+       @echo " build                - build debug binaries"
+       @echo " build-release        - build release binaries"
+       @echo " build-coverity       - build coverity artifacts"
+       @echo " rebuild              - wipe and build debug binares"
+       @echo " rebuild-release      - wipe and build release binares"
+       @echo " run                  - run debug binary"
+       @echo " run-release          - run release binary"
+       @echo " debug                - run debug binary with debugger"
+       @echo " debug-release        - run release binary with debugger"
+       @echo " test                 - build and run (basic) functional tests"
+       @echo " test-debug           - build and run (basic) functional tests (debug build)"
+       @echo " test-all             - build and run functional and extended tests"
+       @echo " test-all-debug       - build and run functional and extended tests (debug build)"
+       @echo " test-gcov            - build and run functional tests (gcov build)"
+       @echo " test-shell           - enter shell with test environment"
+       @echo " test-shell-debug     - enter shell with test environment (debug build)"
+       @echo " test-wipe            - wipe files generated by unit tests"
+       @echo " retest               - run functional tests"
+       @echo " retest-debug         - run functional tests (debug build)"
+       @echo " test-help            - show help on test framework"
+       @echo " run-vat              - run vpp-api-test tool"
+       @echo " pkg-deb              - build DEB packages"
+       @echo " pkg-deb-debug        - build DEB debug packages"
+       @echo " vom-pkg-deb          - build vom DEB packages"
+       @echo " vom-pkg-deb-debug    - build vom DEB debug packages"
+       @echo " pkg-rpm              - build RPM packages"
+       @echo " install-ext-deps     - install external development dependencies"
+       @echo " ctags                - (re)generate ctags database"
+       @echo " gtags                - (re)generate gtags database"
+       @echo " cscope               - (re)generate cscope database"
+       @echo " checkstyle           - check coding style"
+       @echo " fixstyle             - fix coding style"
+       @echo " doxygen              - (re)generate documentation"
+       @echo " bootstrap-doxygen    - setup Doxygen dependencies"
+       @echo " wipe-doxygen         - wipe all generated documentation"
+       @echo " checkfeaturelist     - check FEATURE.yaml according to schema"
+       @echo " featurelist          - dump feature list in markdown"
+       @echo " json-api-files       - (re)-generate json api files"
        @echo " json-api-files-debug - (re)-generate json api files for debug target"
        @echo " docs                 - Build the Sphinx documentation"
-       @echo " docs-venv         - Build the virtual environment for the Sphinx docs"
-       @echo " docs-clean        - Remove the generated files from the Sphinx docs"
-       @echo " test-doc            - generate documentation for test framework"
-       @echo " test-wipe-doc       - wipe documentation for test framework"
-       @echo " test-cov            - generate code coverage report for test framework"
-       @echo " test-wipe-cov       - wipe code coverage report for test framework"
-       @echo " test-checkstyle     - check PEP8 compliance for test framework"
-       @echo " test-refresh-deps   - refresh the Python dependencies for the tests"
+       @echo " docs-venv            - Build the virtual environment for the Sphinx docs"
+       @echo " docs-clean           - Remove the generated files from the Sphinx docs"
+       @echo " test-doc             - generate documentation for test framework"
+       @echo " test-wipe-doc        - wipe documentation for test framework"
+       @echo " test-cov             - generate code coverage report for test framework"
+       @echo " test-wipe-cov        - wipe code coverage report for test framework"
+       @echo " test-checkstyle      - check PEP8 compliance for test framework"
+       @echo " test-refresh-deps    - refresh the Python dependencies for the tests"
        @echo ""
        @echo "Make Arguments:"
        @echo " V=[0|1]                  - set build verbosity level"

diff --git a/test/Makefile b/test/Makefile
index d8bbf4d..025f865 100644 (file)
--- a/test/Makefile
+++ b/test/Makefile
@@ -281,8 +281,8 @@ help:
        @echo ""
        @echo " test                - build and run (basic) functional tests"
        @echo " test-debug          - build and run (basic) functional tests (debug build)"
-       @echo " test-all            - build and run (all) functional tests"
-       @echo " test-all-debug      - build and run (all) functional tests (debug build)"
+       @echo " test-all            - build and run functional and extended tests"
+       @echo " test-all-debug      - build and run functional and extended tests (debug build)"
        @echo " retest              - run functional tests"
        @echo " retest-debug        - run functional tests (debug build)"
        @echo " papi-wipe           - rebuild vpp_papi sources"
@@ -307,7 +307,7 @@ help:
        @echo "                        same as above"
        @echo " STEP=[yes|no]        - ease debugging by stepping through a testcase"
        @echo " SANITY=[yes|no]      - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)"
-       @echo " EXTENDED_TESTS=[1|y] - run extended tests"
+       @echo " EXTENDED_TESTS=[1|y] - used by 'test-all' & 'test-all-debug' to run extended tests"
        @echo " TEST=<filter>        - filter the set of tests:"
        @echo "    by file-name      - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py"
        @echo "    by file-suffix    - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py"