From nobody Thu Apr 27 15:54:41 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 4Q6gKZ2WmSz47KvW for ; Thu, 27 Apr 2023 15:54:42 +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 4Q6gKZ0fD0z4NW9; Thu, 27 Apr 2023 15:54:42 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1682610882; 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=rgpe1Cq1NTyJIJ5Vpw2Mx51gL7R7C/tLpfXEVZ5N10U=; b=H97c5dHWDFWcIDf/w3JRQRNgdOqYh9gI8ah76XHEezxwNXBzuVVwcmhFB4qrzt7NR5uaKM 6qPlrQaccyHbJoo+jM9zHZcF/kWuxWO1i6a0wx7yBUittiU9770hkIiAH2YH/0EEz+v9/e i0sW+PkLEYkB4LSqmb9ogvtfcGOji5wVq2T4htHxtD9b3Yp4lfcVsLtHSEPHYhukjgul+f +0LP5UZO+MkO3h8PjU6hUihCjg/hhnII98u95wGZ0XZ6KGtosAeTI5BAOAjop6w0wI33x1 c70m//MSmL78jAcfXa4YEw/S+1oEUG4S6rN+Ql0FTdsouPw0hCIx8YMQLOUjjQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1682610882; 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=rgpe1Cq1NTyJIJ5Vpw2Mx51gL7R7C/tLpfXEVZ5N10U=; b=RgL1pTjfqX1/MBo2XZv+KDJwRp8J2lZssxcuUp5e9vmejp9CQtHsAC5OuSyUqeuJ+Ql5/w kseBQPcTs8sne/uiXzSiFyjpe+gwQFYpg0VH8kE/txqO7tPyWgzhMh02kS2FN0dYX4VyTd 8LYKyrz+TJ812+4pKXykr4CDyMZLdQ/Lp5p9sJgD1EAdTANpY9Q0S+7jnyQCRAhO9V57Fx l2qCcNtzW8sLqh51CX2ilkP7+xUxBmQphOedjB6y6NtPREtyPTene6IiW3kx+88FlcJwqm 8kD0/xd7nBfjjgiJNqp78Y00C3PqT+tDXxRw9sPDnFxeqUrdn0qB1qpisGFiZA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1682610882; a=rsa-sha256; cv=none; b=nR8sjczlUf6uTC3V63hax+eonYwIgEiZ2w8LawVEeQNNEZr4mCAkFpj3F0tKGARgE1hiYZ C08y06dGKswQBDQ6PfBn6mWn4FHATSFZ5ffXfa+nv89tkOB2LxQUqBKPwMRX+QXRTch4iH zxMMTwrQoom10DM9/AsFl7gpGLnyEOEuCV8a/k7TEhITBKZolIDmoilMyhE1t2/AoRWu9m ZfAVTLDVFrRs3h2Ifc1xwUO7rFwnBM55JzoAq1RQv2xdRH51POPzjOSG8v8b9hklN7sWfd QdNgXrlRa2BECLVPxQiqlMJwuAH9QoIoZYBvn7uE9xzqec5KPFLVrePsqAv9UQ== 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 4Q6gKY6YgHzNxk; Thu, 27 Apr 2023 15:54:41 +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 33RFsfvg028335; Thu, 27 Apr 2023 15:54:41 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 33RFsfOp028334; Thu, 27 Apr 2023 15:54:41 GMT (envelope-from git) Date: Thu, 27 Apr 2023 15:54:41 GMT Message-Id: <202304271554.33RFsfOp028334@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: =?utf-8?Q?Fernando=20Apestegu=C3=ADa?= Subject: git: aca5eded4d - main - [phb]: Add note when deprecating ports. 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: aca5eded4d6a3491bb99d85966d3487e81d6a1a6 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by fernape: URL: https://cgit.FreeBSD.org/doc/commit/?id=aca5eded4d6a3491bb99d85966d3487e81d6a1a6 commit aca5eded4d6a3491bb99d85966d3487e81d6a1a6 Author: Fernando Apesteguía AuthorDate: 2023-04-25 16:24:09 +0000 Commit: Fernando Apesteguía CommitDate: 2023-04-27 12:48:15 +0000 [phb]: Add note when deprecating ports. Mention alternative ports in the commit msg. Too often people complain about not knowing alternatives for deprecated ports. Reviewed by: bofh@, pauamma_gundo.com Differential Revision: https://reviews.freebsd.org/D39804 --- .../content/en/books/porters-handbook/porting-dads/_index.adoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/documentation/content/en/books/porters-handbook/porting-dads/_index.adoc b/documentation/content/en/books/porters-handbook/porting-dads/_index.adoc index 7977293b4a..a02b45962b 100644 --- a/documentation/content/en/books/porters-handbook/porting-dads/_index.adoc +++ b/documentation/content/en/books/porters-handbook/porting-dads/_index.adoc @@ -448,6 +448,13 @@ Both will be shown to the user. It is possible to set `DEPRECATED` without an `EXPIRATION_DATE` (for instance, recommending a newer version of the port), but the converse does not make any sense. +[NOTE] +==== +When marking a port as `DEPRECATED`, if there are any alternative ports that can +be used as a replacement for the one being deprecated, it is convenient to +mention them in the commit message. +==== + There is no set policy on how much notice to give. Current practice seems to be one month for security-related issues and two months for build issues. This also gives any interested committers a little time to fix the problems.