git: aca5eded4d - main - [phb]: Add note when deprecating ports.

The branch main has been updated by fernape:

URL: https://cgit.FreeBSD.org/doc/commit/?id=aca5eded4d6a3491bb99d85966d3487e81d6a1a6

commit aca5eded4d6a3491bb99d85966d3487e81d6a1a6
Author:     Fernando Apesteguía <[email protected]>
AuthorDate: 2023-04-25 16:24:09 +0000
Commit:     Fernando Apesteguía <[email protected]>
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.