Commit Graph

56 Commits

Author SHA1 Message Date
Zack Galbreath 2a34d0ac36 ctest: Add new variable CTEST_UPDATE_VERSION_OVERRIDE
Set this in a CTest script to explicitly define what the current revision
will be reported as in Update.xml.
2019-05-07 10:45:47 -04:00
Zack Galbreath 7ddac95121 Help: cross-ref and wording of docs related to ctest_update()
Provide better motivation for users to click through to the CTest manual
from the ctest_update command help page.
2019-05-03 20:26:50 +10:00
Bartosz Kosiorek cb33befe2d Modules: Update documentation formatting 2019-04-08 14:55:56 +02:00
Bartosz Kosiorek 0e4fbb4a1f Help: Improve formatting of Help documentation 2019-04-08 14:53:31 +02:00
Paul Seyfert 02ba5d57df Help: Fix --build-and-test synopsis in ctest(1)
The synopsis added by commit 9d3aa95ca4 (Help: Divide ctest(1) manual
options into sections, 2017-11-08, v3.11.0-rc1~359^2~2) is missing the
actual `--build-and-test` argument!  Add it now.
2019-02-26 07:37:29 -05:00
Regina Pfeifer 2915a75615 CTest: Add documentation and release notes for SubmitURL 2019-01-16 10:34:08 -05:00
Justin Goshi fc41a95f08 CTest: Add --show-only[=format] option to print test info
format can be 'human' to print the current text format or 'json-v1' to
print the test object model in json format and is useful for IDEs who
want to gather information about the tests. Defaults to 'human' format.
2019-01-10 07:37:32 -05:00
Regina Pfeifer 3e0eb3307f Help: clarify documentation of ctest --timeout 2018-12-09 22:10:31 +01:00
Regina Pfeifer 9501a6145d CTest: Remove special case for Dart version <= 1 2018-11-29 00:29:13 +01:00
Regina Pfeifer 8c25aa2feb CTest: Remove submission trigger 2018-11-29 00:29:13 +01:00
Regina Pfeifer a688c6b928 CTest: Remove submit method 'ftp' 2018-11-29 00:29:13 +01:00
Regina Pfeifer c339b64cf2 CTest: Remove submit method 'scp' 2018-11-29 00:29:13 +01:00
Regina Pfeifer aebdad399e CTest: Remove submit method 'cp' 2018-11-29 00:29:13 +01:00
Regina Pfeifer c2f6872c4e CTest: Remove submit method 'xmlrpc' 2018-11-29 00:29:12 +01:00
Joachim Wuttke (l) f9c3f7b164 Help: Emphasize tool names in their manuals
Print the name of the **cmake** executable in boldface, so that it does
not appear less prominent than other shell commands (which are underlaid
with links).  Similarly the other tool manuals.
2018-11-26 10:17:44 -05:00
Craig Scott 2154ea38f9 Help: Add missing docs for the ctest --progress option
These docs were missing from the changes that introduced the feature in
!2240.
2018-10-07 17:03:36 +11:00
Craig Scott fb2cdf4d4c Help: Use :envvar: links for env vars affecting ctest command 2018-10-07 17:03:36 +11:00
Brad King 909ab169eb Help: Fix command-line synopsis markup syntax
Use `{}` to surround required parts instead of `()`.

Fixes: #17917
2018-04-18 08:28:32 -04:00
Craig Scott 8b43adc45c Help: Clarify ctest build-and-test mode options
Fixes: #17807
2018-03-14 07:27:54 +11:00
Betsy McPhail d15f199c14 CTest: Expand 'Label and Subproject Summary' section of manual 2017-12-15 12:49:17 -05:00
Betsy McPhail 3b272ff8e4 Help: Add 'Label and Subproject Summary' section to ctest(1) manual 2017-11-10 07:53:45 -05:00
Betsy McPhail 002d0a1cf9 Help: Normalize capitalization of 'CTest' in ctest(1) manual 2017-11-10 07:53:42 -05:00
Betsy McPhail 9d3aa95ca4 Help: Divide ctest(1) manual options into sections 2017-11-10 07:52:45 -05:00
Betsy McPhail e80dc2ad7f cmCTest: Remove dead code
The option 'ctest-config' is ignored.
2017-11-07 14:15:20 -05:00
Rolf Eike Beer 67529aab81 Doc: document that CoverageExtraFlags will come first 2017-09-15 17:50:56 +02:00
Betsy McPhail 47b3a57c9b Display subproject timing summary
Use the '--no-subproject-summary' option to disable timing summary.
2017-07-10 16:25:18 -04:00
Betsy McPhail d08ec4d25a Add CTEST_LABELS_FOR_SUBPROJECTS as a CTest module and script variable
Use this variable to specify a list of labels that will be reported to
CDash as subprojects.
2017-07-10 16:25:18 -04:00
Craig Scott c1b2b7c03c Add ctest options for limiting which tests fixtures add
The new options allow the user to restrict the setup and cleanup tests
automatically added for fixtures.
2017-05-02 01:54:13 +10:00
Jean-Christophe Fillion-Robin 61fcd08a49 Help: Fix documentation of ctest --build-and-test
Since commit v3.0.0-rc1~260^2~14 (ctest: Make the --build-makeprogram
optional for --build-and-test, 2013-11-14), binary dictionary is also
required to run CTest given the option `--build-nocmake`.
2016-07-05 11:19:01 -04:00
Jean-Christophe Fillion-Robin 7c67d4011e Help: Consistently use quotes and fix punctuation in ctest(1) manual 2016-07-05 11:19:01 -04:00
Brad King 1b18180ed4 Help: Document CTest Git fetch-and-reset behavior 2016-06-08 09:58:43 -04:00
Ben Boeckel 06b310b5d5 cmCTestGIT: add an option to initialize submodules on update
Currently, CTest will not initialize any submodules within the already
checked out source tree. Add an option to do so. The use case for not
doing so is that some submodules may not be necessary for the current
test and keeping network usage down may be important.
2016-04-01 15:50:31 -04:00
Roman Wüger fd47df4503 CTest: Add options to limit output of passed and failed tests
Add ctest command-line options:

  --test-output-size-passed <n>
  --test-output-size-failed <n>

to set the amount of test output to store in Test.xml as a command-line
dashboard client.
2015-09-18 11:32:06 -04:00
Betsy McPhail f62d301b92 ctest: Optionally avoid starting tests that may exceed a given CPU load
Add a TestLoad setting to CTest that can be set via a new --test-load
command-line option, CTEST_TEST_LOAD variable, or TEST_LOAD option to
the ctest_test command.  Teach cmCTestMultiProcessHandler to measure
the CPU load and avoid starting tests that may take more than the
spare load currently available.  The expression

 <current_load> + <test_processors> <= <max-load>

must be true to start a new test.

Co-Author: Zack Galbreath <zack.galbreath@kitware.com>
2015-06-30 10:21:37 -04:00
Brad King 7244e8452f ctest: Consolidate documentation of CTEST_USE_LAUNCHERS (#15533)
The documentation of this variable in the CTest module is outdated
and has been superseded by the ctest(1) manual.  In particular, the
latter mentions that it works with the Ninja generator as well as
makefile generators.  Remove the documentation from the CTest module
and replace it with a link to the main variable documentation (which
already references the ctest(1) manual).
2015-04-28 13:32:23 -04:00
Brad King a61e09948f Help: Fix formatting of env var refs in ctest.1 manual 2015-04-22 08:30:51 -04:00
Brad King fef1f26749 Help: Fix {GIT,P4}UpdateCustom documentation (#15512)
The GITUpdateCustom and P4UpdateCustom options take only one command
line with all arguments as a ;-list, not a ;-list of multiple command
lines.  Fix the incorrect documentation originally added by commit
v3.1.0-rc1~463^2 (Help: Document ctest dashboard client usage,
2014-05-30).
2015-04-13 13:00:58 -04:00
Bill Hoffman fde70a1b26 ctest: Add a new --repeat-until-fail option
This option tells ctest to run each test N times until the test fails or
the N times have run. This is useful for finding random failing tests.
2015-03-23 09:08:22 -04:00
Christopher Dembia df53aafdac Help: Add missing space to ctest -j option description 2014-12-01 09:26:48 -05:00
Brad King 6b135a6c29 Merge topic 'doc-drop-dart'
b8aa0cdf Help: Replace 'Dart' with 'CDash' in ctest.1 manual
2014-10-09 16:12:04 -04:00
Brad King b8aa0cdf9b Help: Replace 'Dart' with 'CDash' in ctest.1 manual
The modern dashboard server is CDash, not Dart, so update the manual
to talk about CTest as a CDash client.  Also drop documentation for
a Dart2-specific option.
2014-10-08 09:58:30 -04:00
Ben Boeckel ca9cc25ce8 ctest: add support for additional sanitizer options
Sanitizers receive options through their environment variable; support
user-specified options here.
2014-10-03 13:45:07 -04:00
Ben Boeckel 0b9ffffcd4 ctest: update documentation for CTEST_MEMORYCHECK_TYPE
The AddressSanitizer value was not documented.

Also fix some typos.
2014-10-03 13:43:44 -04:00
Brad King 8d33209170 CTest: Add options to set generator platform
The ctest_configure command already reads the CTEST_CMAKE_GENERATOR
variable to get the value for the cmake -G option.  Read new variable
CTEST_CMAKE_GENERATOR_PLATFORM to pass on as CMAKE_GENERATOR_PLATFORM.

The "ctest --build-and-test" mode already has "--build-generator" to
specify the -G option to CMake.  Add a "--build-generator-platform" option
to specify a value to pass on as CMAKE_GENERATOR_PLATFORM.
2014-09-05 15:18:21 -04:00
Bill Hoffman 39b5df2f37 ctest_update: Add CTEST_UPDATE_VERSION_ONLY option to only note the version
This allows ctest_update to get the current version without actually
changing the repository.  This is useful when using Jenkins or an
external project to update the source to a specific version, but you
still want the current version to show up in CDash.
2014-08-18 11:21:36 -04:00
Brad King 34c6fd3ac0 Help: Convert CTest Script variable references to cross-references
In the ctest(1) manual and ctest_start() command documentation, convert
mentions of CTest Script variables to cross-references so they will be
rendered as links.
2014-06-03 14:34:13 -04:00
Brad King 2d57a390da Help: Document ctest dashboard client usage
Extend the ctest(1) manual with a section describing configuration
and usage of CTest as a CDash software quality dashboard client.
2014-05-30 14:16:47 -04:00
Brad King 96966b5c80 ctest: Make the --build-makeprogram optional for --build-and-test
GenerateBuildCommand now knows how to lookup CMAKE_MAKE_PROGRAM or
choose a generator-provided default build tool.  Therefore the
--build-makeprogram can now be optional and simply override the
default selection when provided.

Note that with --build-nocmake we now need to load the cache in order to
make the CMAKE_MAKE_PROGRAM entry available to GenerateBuildCommand.
2013-11-18 11:30:49 -05:00
Kitware Robot 3442f2bcc4 Help: Format manual/*.1.rst options as definition lists
Convert the command-line option documentation formatting from bullet
lists to definition lists.
2013-11-14 10:05:32 -05:00
Brad King d1e8a0240b Help: Refine manual/*.1.rst usage summaries
Use a parsed-literal block to list possible command-line signatures.
Add an "Options" section header before the list of options.
2013-11-04 11:06:14 -05:00