ports/86281: Additional commentary for describes target in bsd.port.mk

[Colin Percival]

>Number:         86281
>Category:       ports
>Synopsis:       Additional commentary for describes target in bsd.port.mk
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-ports-bugs
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Sat Sep 17 23:10:03 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator:     Colin Percival
>Release:        FreeBSD 5.4-SECURITY i386
>Organization:
>Environment:
System: FreeBSD hexahedron.daemonology.net 5.4-SECURITY FreeBSD 5.4-SECURITY #0: Wed Jul 20 08:57:11 UTC 2005 root at builder.daemonology.net:/usr/obj/usr/src/sys/GENERIC i386

>Description:

Portsnap uses the data format of "make describes" in an externally-visible
manner.  If this format ever changes, portsnap will need to adjust.

>How-To-Repeat:
>Fix:

Document in bsd.port.mk that portmgr should contact the portsnap 
maintainer before changing the format output by "make describe".

--- bsd.port.mk.diff begins here ---
Index: ports/Mk/bsd.port.mk
===================================================================
RCS file: /home/pcvs/ports/Mk/bsd.port.mk,v
retrieving revision 1.517
diff -u -p -r1.517 bsd.port.mk
--- ports/Mk/bsd.port.mk	15 Sep 2005 12:24:33 -0000	1.517
+++ ports/Mk/bsd.port.mk	17 Sep 2005 23:01:17 -0000
@@ -4676,6 +4676,9 @@ package-recursive: package
 # distribution-name|port-path|installation-prefix|comment| \
 #  description-file|maintainer|categories|extract-depends| \
 #  patch-depends|fetch-depends|build-depends|run-depends|www site
+#
+# If this ever changes, portmgr should contact the portsnap maintainer
+# first to avoid gratuitous breakage.
 
 .if !target(describe)
 describe:
--- bsd.port.mk.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted: