diff options
| author | Adriaan de Groot <adridg@FreeBSD.org> | 2021-04-07 14:50:15 +0000 |
|---|---|---|
| committer | Mathieu Arnold <mat@FreeBSD.org> | 2021-04-07 14:51:35 +0000 |
| commit | a4888aa345f7eb52766d2753c697fb23df99b902 (patch) | |
| tree | 9002fa101c1f6c2528c3cc4af695258cb314dbc5 | |
| parent | b3b90b4ff88b988cb809fdffd97c3794a95ae5af (diff) | |
| download | doc-a4888aa345f7eb52766d2753c697fb23df99b902.tar.gz doc-a4888aa345f7eb52766d2753c697fb23df99b902.zip | |
Document new USES=cmake argument
PR: 254677
Submitted by: adridg
| -rw-r--r-- | documentation/content/en/books/porters-handbook/uses/_index.adoc | 10 |
1 files 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]] |