From nobody Sun Feb 23 17:35:02 2025 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 4Z19x30t4Wz5p7ct for ; Sun, 23 Feb 2025 17:35:03 +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 "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Z19x30504z3vD2; Sun, 23 Feb 2025 17:35:03 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1740332103; 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=ihszmROwEV0l/N05tclIG11gLJcabQlRTm0blr4P8KE=; b=e3ZezRRG5qk5akkt8Bqz8KkAlb7kAoD3GBKYQT88X89+gAFCOnnrexdV7WKQS/cBXBsvst yo9+GQCMSjxpqJNS+hp5d3xvzK5tzcRhLL32sxssllebxUHmUiVwAYnMdu9h+xkA0ObDIm x3zvb55GGhHVG5ShWLRIlF04vcp143+rclqvqXVgyUDEVkQHbE9lZ4kUq1+8VrpbZA4Sm8 Ac1R/STqU75K7p0HY4x2T45yyKPDcg+8vDb7tdeQqjOpdE3X+w5qBE1gV0MVNfwBCwbU7u sQVQbBsvyC/Yv1H0lpyJQLvJVu8zDalamTKvqB6sr4Bos9pT+EkHjLT+GR9oJw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1740332103; a=rsa-sha256; cv=none; b=yn/fMu2oyecbLRqYJ7DDvODU54HsbmEvWgFeIkSlla60oTkrh5m0yy8ee+sfMMQbmPESBg xOv0AR1C7mV6YVi1jBnnNmuEUKOOfOybjJLRJUQ548Yhs3NpwqA9/EEsYVLERxMNU7zQzq rOif/QxEtYd4xjX3KYNAPhyM2yuS3uoFefAQSv5NZ3kwfRkYHhUJSfHFdQEhNMCjGIiU/c R8GOMl52dd9eqziJuYS36mpoJk0LAHDJxgesRZ9jWMvYjxC5Ks/sqmt60NOxxibqBnJE+Z 72ns2Y1HiXOhS474c1k20KSvzmkwyFlaCcyoxXS8rSXfOK2ZXbviscnUZHCOHQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1740332103; 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=ihszmROwEV0l/N05tclIG11gLJcabQlRTm0blr4P8KE=; b=xoYPu6JJJ/RA3Gx3SknS5ICS0W+XZ8ehbRjeBunZHJtNiu2lcXi7Ms5iIpJgn5a+GdjJc4 62gCh9pU1nUUIc6RMs/ZDb5B7deJdftg/dwWoLrPu4Zc/iUym3Kocvq0vNtft5TBraGc7A UpQ50IenSmeU0UXfE/Zgv2LyBEbN2+E0WazvvMTdYDzzYCaHlA3VQ6cKwCivUjlU36z13/ M4vmELSgD2iD22Kbvzrc7dOuGswxbZDgVlQbvU2bPhfbqQVgfzVmZuTJydUseQSuqcf3iv 1DTpDptMpwyHp5XOMJY+fVCUzr9SxjuxJYWEd3TcaFjCPAEHTNxxYV2Q/iraow== 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 4Z19x26pMlz13xF; Sun, 23 Feb 2025 17:35:02 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 51NHZ2Zk018191; Sun, 23 Feb 2025 17:35:02 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 51NHZ2wt018188; Sun, 23 Feb 2025 17:35:02 GMT (envelope-from git) Date: Sun, 23 Feb 2025 17:35:02 GMT Message-Id: <202502231735.51NHZ2wt018188@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Fernando =?utf-8?Q?Apestegu=C3=ADa?= Subject: git: 1ba292a796 - main - [phb][Uses]: Add missing Uses=emacs 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: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-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: 1ba292a79606194abee212dddc03afc018de5883 Auto-Submitted: auto-generated The branch main has been updated by fernape: URL: https://cgit.FreeBSD.org/doc/commit/?id=1ba292a79606194abee212dddc03afc018de5883 commit 1ba292a79606194abee212dddc03afc018de5883 Author: Fernando Apesteguía AuthorDate: 2025-02-23 17:30:28 +0000 Commit: Fernando Apesteguía CommitDate: 2025-02-23 17:34:19 +0000 [phb][Uses]: Add missing Uses=emacs Reviewers: jrm@ Differential Revision: https://reviews.freebsd.org/D48989 --- .../en/books/porters-handbook/uses/_index.adoc | 64 +++++++++++++++++++++- 1 file changed, 62 insertions(+), 2 deletions(-) diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc index 5360653b1a..759deefc87 100644 --- a/documentation/content/en/books/porters-handbook/uses/_index.adoc +++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc @@ -588,7 +588,6 @@ When the `stage` argument is supplied, binaries under `STAGEDIR` are operated on ==== [.programlisting] .... -USES= elfctl ELF_FEATURES= featurelist:path/to/file1 \ featurelist:path/to/file2 .... @@ -597,7 +596,68 @@ ELF_FEATURES= featurelist:path/to/file1 \ The format of `featurelist` is described in man:elfctl[1]. -[[uses-erlang]] +[[uses-emacs]] +== `emacs` + +Possible arguments: (none) (default), `build`, `run`, `noflavors` + +Provides support for ports requiring Emacs. +The `build` argument creates a build dependency on Emacs. +The `run` argument creates a run dependency on Emacs. +If both the `build` and `run` arguments are absent, create build and run +dependencies on Emacs. +The `noflavors` argument prevents flavors, and is implied if there is no run dependency on Emacs. + +The default Emacs flavor for ports with `USES=emacs` can be defined in [.filename]#make.conf#. +For example, for the `nox` flavor, use `DEFAULT_VERSIONS+= emacs=nox`. +The valid flavors are: `full`, `canna`, `nox`, `wayland`, `devel_full`, `devel_nox`. + +Variables, which can be set by ports: + +`EMACS_FLAVORS_EXCLUDE`:: +Do NOT build these Emacs flavors. +If `EMACS_FLAVORS_EXCLUDE` is not defined and: + +* there is a run dependency on Emacs +* the noflavors argument is not specified + ++ +then all valid Emacs flavors are assumed. + +`EMACS_NO_DEPENDS`:: +Do NOT add build or run dependencies on Emacs. +This will prevent flavors, and no byte code files will be generated as part of +the package. + +Variables, which can be read by ports: + +`EMACS_CMD`:: +Emacs command with full path (e.g. [.filename]#/usr/local/bin/emacs-30.1#) + +`EMACS_FLAVOR`:: +Used for dependencies (e.g. `BUILD_DEPENDS= dash.el${EMACS_PKGNAMESUFFIX}>0:devel/dash@${EMACS_FLAVOR}`) + +`EMACS_LIBDIR`:: +Emacs Library directory without `${PREFIX}` (e.g. [.filename]#share/emacs#) + +`EMACS_LIBDIR_WITH_VER`:: +Library directory without `${PREFIX}` including version (e.g. [.filename]#share/emacs/30.1#) + +`EMACS_MAJOR_VER`:: +Emacs major version (e.g. 30) + +`EMACS_PKGNAMESUFFIX`:: +`PKGNAMESUFFIX` to distinguish Emacs flavors + +`EMACS_SITE_LISPDIR`:: +Emacs site-lisp directory without `${PREFIX}` (e.g. [.filename]#share/emacs/site-lisp#) + +`EMACS_VER`:: +Emacs version (e.g. 30.1) + +`EMACS_VERSION_SITE_LISPDIR`:: +Include version (e.g. [.filename]#share/emacs/30.1/site-lisp#) + == `erlang` Possible arguments: (none), `enc`, `rebar`, `rebar3`