From owner-svn-doc-all@freebsd.org Wed Mar 13 07:51:42 2019 Return-Path: Delivered-To: svn-doc-all@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 1330D152947B; Wed, 13 Mar 2019 07:51:42 +0000 (UTC) (envelope-from tobik@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) server-signature RSA-PSS (4096 bits) client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id A955F6CAF0; Wed, 13 Mar 2019 07:51:41 +0000 (UTC) (envelope-from tobik@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 852F97689; Wed, 13 Mar 2019 07:51:41 +0000 (UTC) (envelope-from tobik@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id x2D7pfNl034533; Wed, 13 Mar 2019 07:51:41 GMT (envelope-from tobik@FreeBSD.org) Received: (from tobik@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id x2D7pfE5034531; Wed, 13 Mar 2019 07:51:41 GMT (envelope-from tobik@FreeBSD.org) Message-Id: <201903130751.x2D7pfE5034531@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: tobik set sender to tobik@FreeBSD.org using -f From: Tobias Kortkamp Date: Wed, 13 Mar 2019 07:51:41 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52862 - in head/en_US.ISO8859-1/books/porters-handbook: special uses X-SVN-Group: doc-head X-SVN-Commit-Author: tobik X-SVN-Commit-Paths: in head/en_US.ISO8859-1/books/porters-handbook: special uses X-SVN-Commit-Revision: 52862 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: A955F6CAF0 X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-2.96 / 15.00]; local_wl_from(0.00)[FreeBSD.org]; NEURAL_HAM_MEDIUM(-1.00)[-0.995,0]; NEURAL_HAM_SHORT(-0.97)[-0.970,0]; ASN(0.00)[asn:11403, ipnet:2610:1c1:1::/48, country:US]; NEURAL_HAM_LONG(-1.00)[-1.000,0] X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 13 Mar 2019 07:51:42 -0000 Author: tobik (ports committer) Date: Wed Mar 13 07:51:40 2019 New Revision: 52862 URL: https://svnweb.freebsd.org/changeset/doc/52862 Log: Porter's Handbook: Update USES=cmake description - outsource is no longer a valid argument - Document noninja, insource Approved by: mat, tcberner Differential Revision: https://reviews.freebsd.org/D19567 Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Tue Mar 12 17:42:24 2019 (r52861) +++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Wed Mar 13 07:51:40 2019 (r52862) @@ -635,9 +635,7 @@ IGNORE= may not be redistributed because of licensing Using <command>cmake</command> For ports that use CMake, - define USES= cmake, or - USES= cmake:outsource to build in a - separate directory (see below). + define USES= cmake. Variables for Ports That Use @@ -756,9 +754,10 @@ IGNORE= may not be redistributed because of licensing <para>Most <application>CMake</application>-based projects support an out-of-source method of building. The - out-of-source build for a port can be requested by using the - <literal>:outsource</literal> suffix. When enabled, - <varname>CONFIGURE_WRKSRC</varname>, + out-of-source build for a port is the default setting. + An in-source build can be requested by using the + <literal>:insource</literal> suffix. With out-of-source + builds, <varname>CONFIGURE_WRKSRC</varname>, <varname>BUILD_WRKSRC</varname> and <varname>INSTALL_WRKSRC</varname> will be set to <literal>${WRKDIR}/.build</literal> and this @@ -776,7 +775,7 @@ IGNORE= may not be redistributed because of licensing in the top directory, or if only a subset of the project is intended to be built by the port.</para> - <programlisting>USES= cmake:outsource + <programlisting>USES= cmake CMAKE_SOURCE_PATH= ${WRKSRC}/subproject</programlisting> </example> @@ -3214,7 +3213,7 @@ USE_QT= buildtools_build</programlisting> <title><varname>USE_KDE</varname> ExampleThis is a simple example for a KDE 4 port. - USES= cmake:outsource instructs the + USES= cmake instructs the port to utilize CMake, a configuration tool widely used by KDE 4 projects (see for detailed usage). @@ -3228,7 +3227,7 @@ USE_QT= buildtools_build Qt 4 components, specify them in USE_QT. - USES= cmake:outsource kde:4 qt:4 + USES= cmake kde:4 qt:4 USE_KDE= kdelibs kdeprefix automoc4 USE_QT= moc_build qmake_build rcc_build uic_build @@ -3287,7 +3286,7 @@ USE_QT= moc_build qmake_build rcc_build uic_build - USES= cmake:outsource lxqt qt:5 tar:xz + USES= cmake lxqt qt:5 tar:xz USE_QT= core dbus widgets buildtools_build qmake_build USE_LXQT= buildtools libfmqt Modified: head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml Tue Mar 12 17:42:24 2019 (r52861) +++ head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml Wed Mar 13 07:51:40 2019 (r52862) @@ -263,15 +263,31 @@ <literal>cmake</literal> - Possible arguments: (none), outsource, - run + Possible arguments: (none), insource, + noninja, run Uses CMake for configuring and - building. With the outsource argument, an - out-of-source build will be performed. With the - run argument, a run-time dependency is - registered. For more information see . + building. + + 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 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. + + With the run argument, a run dependency + is registered in addition to a build dependency. + + For more information see .