git: a4888aa345 - main - Document new USES=cmake argument PR: 254677 Submitted by: adridg
Mathieu Arnold
mat at FreeBSD.org
Wed Apr 7 14:52:01 UTC 2021
The branch main has been updated by mat:
URL: https://cgit.FreeBSD.org/doc/commit/?id=a4888aa345f7eb52766d2753c697fb23df99b902
commit a4888aa345f7eb52766d2753c697fb23df99b902
Author: Adriaan de Groot <adridg at FreeBSD.org>
AuthorDate: 2021-04-07 14:50:15 +0000
Commit: Mathieu Arnold <mat at FreeBSD.org>
CommitDate: 2021-04-07 14:51:35 +0000
Document new USES=cmake argument
PR: 254677
Submitted by: adridg
---
.../content/en/books/porters-handbook/uses/_index.adoc | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc
index 41d7a5f73a..fcfdfc1d46 100644
--- a/documentation/content/en/books/porters-handbook/uses/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc
@@ -194,16 +194,18 @@ Prevents the port from installing [.filename]#charset.alias#. This must be insta
[[uses-cmake]]
== `cmake`
-Possible arguments: (none), `insource`, `noninja`, `run`
+Possible arguments: (none), `insource`, `noninja`, `run`, `testing`
-Uses CMake for configuring and building.
+Use CMake for configuring the port and generating a build system.
-By default an out-of-source build is performed, leaving the sources in `WRKSRC` free from build artifacts. With the `insource` argument, an in-source build will be performed instead. Setting it should be the exception when a regular out-of-source build does not work.
+By default an out-of-source build is performed, leaving the sources in `WRKSRC` free from build artifacts. With the `insource` argument, an in-source build will be performed instead. This argument should be an exception, used only when a regular out-of-source build does not work.
-By default Ninja is used for the build. In some cases this does not work correctly. With the `noninja` argument, the build will fallback to using regular `make` for builds. It should only be used if a Ninja-based build does not work.
+By default Ninja (package:devel/ninja[]) is used for the build. In some cases this does not work correctly. With the `noninja` argument, the build will use regular `make` for builds. This argument should only be used if a Ninja-based build does not work.
With the `run` argument, a run dependency is registered in addition to a build dependency.
+With the `testing` argument, a test-target is added that uses CTest. When running tests the port will be re-configured for testing and re-built.
+
For more information see crossref:special[using-cmake,Using `cmake`].
[[uses-compiler]]
More information about the dev-commits-doc-all
mailing list