From owner-dev-commits-doc-all@freebsd.org Wed Apr 7 14:52:01 2021 Return-Path: Delivered-To: dev-commits-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id B21845B94B8 for ; Wed, 7 Apr 2021 14:52:01 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4FFnRP4lDHz3RKk; Wed, 7 Apr 2021 14:52:01 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 95C17211AB; Wed, 7 Apr 2021 14:52:01 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 137Eq1Nl066772; Wed, 7 Apr 2021 14:52:01 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 137Eq1Ua066771; Wed, 7 Apr 2021 14:52:01 GMT (envelope-from git) Date: Wed, 7 Apr 2021 14:52:01 GMT Message-Id: <202104071452.137Eq1Ua066771@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Mathieu Arnold Subject: git: a4888aa345 - main - Document new USES=cmake argument PR: 254677 Submitted by: adridg MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: mat X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: a4888aa345f7eb52766d2753c697fb23df99b902 Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 07 Apr 2021 14:52:01 -0000 The branch main has been updated by mat: URL: https://cgit.FreeBSD.org/doc/commit/?id=a4888aa345f7eb52766d2753c697fb23df99b902 commit a4888aa345f7eb52766d2753c697fb23df99b902 Author: Adriaan de Groot AuthorDate: 2021-04-07 14:50:15 +0000 Commit: Mathieu Arnold 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]]