From nobody Tue Jan 31 11:34:10 2023 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4P5jcf5shPz3cGNT for ; Tue, 31 Jan 2023 11:34:10 +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 4P5jcf5J6gz3Bxq; Tue, 31 Jan 2023 11:34:10 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1675164850; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=yj6XKjKI7Qc3baX3PDXsVXSmANtY1PLTaShV+uM5kJo=; b=szXfKwbVc3iGa1GJw5U75nW+7tjsOJ8tELMLSpXFiNEtxUL7MTqhwWvUsn1woipI+8xQ6R HqVji2JwoWjk80eAKbNeR7YgACBIPud6ir/AZa2ZH99kaMpllBQ8ny+F23iTsiU23IvFkn zx9wjg4VFy50Xs14oAnQiy6krPgoWhx0cSEICRn4B1OtYCrd17yK4GkOHLeXBprGV4tLP1 9RDciHgkVETUvpB/q2+KWvBNuyIRJyAVbFkndavJkjxJFXGD0CvE1PC48VXjnbMqcVtmA0 zC7AcGoJC9MxpOEifoBdf1h/xS7sUjg3t0GQtGx3NhqMvWc4fd8E9IzPsnCVUA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1675164850; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=yj6XKjKI7Qc3baX3PDXsVXSmANtY1PLTaShV+uM5kJo=; b=RKhvNX508Tnsm1wkaXEpHynyyQPNdu091FILwuM/tAGJ1ROXpwqwSLJ9UCpYmziGxrYAtN hbvsTZ8AELs2v7Tr/bS+e7h3CB0CJC6FFtIDq2df2SbLxQSpXXgMJrnULezLYvdvsFEJpN KgyzpW9TiCKHrjrSJUjaSlxnadeXl/A9IRYRzMGUna272z8HFZ087wGv4Hpgjnk4JlUz+T mEfOCK7oyXPZFlL+walnuDlzRg40JkLBZ8SEURKciGwJR5R6OjDNd78SuWHJUczBPJdGvE wAwsugOO8UV/Q+timl9x5yNs0WDiHYoMjC7o8FligAYmyRu2QDexZY1bunpcQg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1675164850; a=rsa-sha256; cv=none; b=hH5YuUKQKvXZijxCQctzG/q4sRZvjGdZdPl0hWK6py0pDFxb396zV3y9za5RpY7G886hVI 4vCjGcEiLBT5agepk++S9dGIWGnp0Gy6oqh7S673AFRLGyra9/e0KHhSfhTdNUcXwJnVqm 9jRjKmmYtcip1aa0cIbbRbcBvW2rE1xryZ6Q/eU9k+3cpsKg9R6iMnHVNgQ+uW4Mg7KW9d TgaPKGtfCM05mk1g5z+IvzHWp+KTPVeXotVxGJO0jS9Exl2AWXFMj5SSl/8SSsTGZ/0Axz zq1ClhO9yvg4RdzVoekXxtmVDif1bfQsh/FAhTrh49RbK/vQ5Ody1OlPTyVblg== 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 4P5jcf4KjbznQ8; Tue, 31 Jan 2023 11:34:10 +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 30VBYAij098149; Tue, 31 Jan 2023 11:34:10 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 30VBYABw098148; Tue, 31 Jan 2023 11:34:10 GMT (envelope-from git) Date: Tue, 31 Jan 2023 11:34:10 GMT Message-Id: <202301311134.30VBYABw098148@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: =?utf-8?Q?Fernando=20Apestegu=C3=ADa?= Subject: git: 407dbb9254 - main - [phb] Document USES=ruby List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: fernape X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 407dbb9254e7b6b379b8257f34f7732ed1afc71f Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by fernape: URL: https://cgit.FreeBSD.org/doc/commit/?id=407dbb9254e7b6b379b8257f34f7732ed1afc71f commit 407dbb9254e7b6b379b8257f34f7732ed1afc71f Author: Fernando Apesteguía AuthorDate: 2023-01-19 16:12:05 +0000 Commit: Fernando Apesteguía CommitDate: 2023-01-31 11:29:09 +0000 [phb] Document USES=ruby Following changes in the ports framework in: https://cgit.freebsd.org/ports/commit/?id=18c6e18276691edf5274406bf82a3b06792ff9ae Reviewed by: bofh@ Differential Revision: https://reviews.freebsd.org/D38121 --- .../en/books/porters-handbook/special/_index.adoc | 63 ---------------------- .../en/books/porters-handbook/uses/_index.adoc | 47 ++++++++++++++++ 2 files changed, 47 insertions(+), 63 deletions(-) diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc index cdd57b2b3b..d31179deca 100644 --- a/documentation/content/en/books/porters-handbook/special/_index.adoc +++ b/documentation/content/en/books/porters-handbook/special/_index.adoc @@ -3667,69 +3667,6 @@ It is possible to specify the desired version of `tcl` by appending `:_xx_`, for See the crossref:uses[uses-tcl,`USES=tcl`] and crossref:uses[uses-tk,`USES=tk`] of crossref:uses[uses,Using `USES` Macros] for a full description of those variables. A complete list of those variables is available in [.filename]#/usr/ports/Mk/Uses/tcl.mk#. -[[using-ruby]] -== Using Ruby - -[[using-ruby-variables]] -.Useful Variables for Ports That Use Ruby -[cols="1,1", frame="none", options="header"] -|=== -| Variable -| Description - -|`USE_RUBY` -|Adds build and run dependencies on Ruby. - -|`USE_RUBY_EXTCONF` -|The port uses [.filename]#extconf.rb# to configure. - -|`USE_RUBY_SETUP` -|The port uses [.filename]#setup.rb# to configure. - -|`RUBY_SETUP` -|Override the name of the setup script from [.filename]#setup.rb#. Another common value is [.filename]#install.rb#. -|=== - -This table shows the selected variables available to port authors via the ports infrastructure. -These variables are used to install files into their proper locations. -Use them in [.filename]#pkg-plist# as much as possible. -Do not redefine these variables in the port. - -[[using-ruby-variables-ro]] -.Selected Read-Only Variables for Ports That Use Ruby -[cols="1,1,1", frame="none", options="header"] -|=== -| Variable -| Description -| Example value - -|`RUBY_PKGNAMEPREFIX` -|Used as a `PKGNAMEPREFIX` to distinguish packages for different Ruby versions. -|`ruby19-` - -|`RUBY_VERSION` -|Full version of Ruby in the form of `x.y.z[.p]`. -|`1.9.3.484` - -|`RUBY_SITELIBDIR` -|Architecture independent libraries installation path. -|`/usr/local/lib/ruby/site_ruby/1.9` - -|`RUBY_SITEARCHLIBDIR` -|Architecture dependent libraries installation path. -|`/usr/local/lib/ruby/site_ruby/1.9/amd64-freebsd10` - -|`RUBY_MODDOCDIR` -|Module documentation installation path. -|`/usr/local/share/doc/ruby19/patsy` - -|`RUBY_MODEXAMPLESDIR` -|Module examples installation path. -|`/usr/local/share/examples/ruby19/patsy` -|=== - -A complete list of available variables can be found in [.filename]#/usr/ports/Mk/bsd.ruby.mk#. - [[using-sdl]] == Using SDL diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc index 75597e1561..817ed80eb3 100644 --- a/documentation/content/en/books/porters-handbook/uses/_index.adoc +++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc @@ -503,6 +503,8 @@ Possible arguments: (none), `noautoplist` Handle building with RubyGems. If `noautoplist` is used, the packing list is not generated automatically. +This implies `USES=ruby`. + [[uses-gettext]] == `gettext` @@ -1711,6 +1713,51 @@ Possible arguments: (none), `port` Uses readline as a library dependency, and sets `CPPFLAGS` and `LDFLAGS` as necessary. If the `port` argument is used or if readline is not present in the base system, add a dependency on package:devel/readline[] + +[[uses-ruby]] +== `ruby` + +Possible arguments: (none), `build`, `extconf`, `run`, `setup` + +Provide support for Ruby related ports. +`(none)` without arguments adds runtime dependency on package:lang/ruby[]. +`build` adds a dependency on package:lang/ruby[] at build time. +`extconf` states that the port uses extconf.rb to configure. +`run` adds a dependency on package:lang/ruby[] at run time. This is also the default. +`setup` states that the port uses setup.rb to configure and build. + +The user may have the following variables defined: + +`RUBY_VER`:: +Alternative short version of ruby in the form of `x.y'. + +`RUBY_DEFAULT_VER`:: +Set to (e.g.) `2.7` to use `ruby27` as the default version. + +`RUBY_ARCH`:: +Set the architecture name (e.g. i386-freebsd7). + +The following variables are exported to be used by the port: + +`RUBY`:: +Set to full path of ruby. +If set, the values of the following variables are automatically obtained from +the ruby executable: `RUBY_ARCH`, `RUBY_ARCHLIBDIR`, `RUBY_LIBDIR`, +`RUBY_SITEARCHLIBDIR`, `RUBY_SITELIBDIR`, `RUBY_VER` and `RUBY_VERSION` + +`RUBY_VER`:: +Set to the alternative short version of ruby in the form of `x.y'. + +`RUBY_EXTCONF`:: +Set to the alternative name of extconf.rb (default: extconf.rb). + +`RUBY_EXTCONF_SUBDIRS`:: +Set to list of subdirectories, if multiple modules are included. + +`RUBY_SETUP`:: +Set to the alternative name of setup.rb (default: setup.rb). + + [[uses-samba]] == `samba`